blob: 31830c6739e8bf3e58e5eff29f6108876ad266df [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"
24#include "llvm/Pass.h"
Chris Lattner79066fa2007-01-30 23:46:24 +000025#include "llvm/Analysis/ConstantFolding.h"
Chris Lattner30ba5692004-10-11 05:54:41 +000026#include "llvm/Target/TargetData.h"
Duncan Sands548448a2008-02-18 17:32:13 +000027#include "llvm/Support/CallSite.h"
Reid Spencer9133fe22007-02-05 23:32:05 +000028#include "llvm/Support/Compiler.h"
Chris Lattner79066fa2007-01-30 23:46:24 +000029#include "llvm/Support/Debug.h"
Chris Lattner941db492008-01-14 02:09:12 +000030#include "llvm/Support/GetElementPtrTypeIterator.h"
Chris Lattner998182b2008-04-26 07:40:11 +000031#include "llvm/Support/MathExtras.h"
Chris Lattner5a6bb6a2008-12-16 07:34:30 +000032#include "llvm/ADT/DenseMap.h"
Chris Lattner81686182007-09-13 16:30:19 +000033#include "llvm/ADT/SmallPtrSet.h"
Chris Lattner55eb1c42007-01-31 04:40:53 +000034#include "llvm/ADT/SmallVector.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000035#include "llvm/ADT/Statistic.h"
Chris Lattner670c8892004-10-08 17:32:09 +000036#include "llvm/ADT/StringExtras.h"
Chris Lattnere47ba742004-10-06 20:57:02 +000037#include <algorithm>
Chris Lattner079236d2004-02-25 21:34:36 +000038using namespace llvm;
39
Chris Lattner86453c52006-12-19 22:09:18 +000040STATISTIC(NumMarked , "Number of globals marked constant");
41STATISTIC(NumSRA , "Number of aggregate globals broken into scalars");
42STATISTIC(NumHeapSRA , "Number of heap objects SRA'd");
43STATISTIC(NumSubstitute,"Number of globals with initializers stored into them");
44STATISTIC(NumDeleted , "Number of globals deleted");
45STATISTIC(NumFnDeleted , "Number of functions deleted");
46STATISTIC(NumGlobUses , "Number of global uses devirtualized");
47STATISTIC(NumLocalized , "Number of globals localized");
48STATISTIC(NumShrunkToBool , "Number of global vars shrunk to booleans");
49STATISTIC(NumFastCallFns , "Number of functions converted to fastcc");
50STATISTIC(NumCtorsEvaluated, "Number of static ctors evaluated");
Duncan Sands3d5378f2008-02-16 20:56:04 +000051STATISTIC(NumNestRemoved , "Number of nest attributes removed");
Chris Lattner079236d2004-02-25 21:34:36 +000052
Chris Lattner86453c52006-12-19 22:09:18 +000053namespace {
Reid Spencer9133fe22007-02-05 23:32:05 +000054 struct VISIBILITY_HIDDEN GlobalOpt : public ModulePass {
Chris Lattner30ba5692004-10-11 05:54:41 +000055 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
56 AU.addRequired<TargetData>();
57 }
Nick Lewyckyecd94c82007-05-06 13:37:16 +000058 static char ID; // Pass identification, replacement for typeid
Dan Gohmanae73dc12008-09-04 17:05:41 +000059 GlobalOpt() : ModulePass(&ID) {}
Misha Brukmanfd939082005-04-21 23:48:37 +000060
Chris Lattnerb12914b2004-09-20 04:48:05 +000061 bool runOnModule(Module &M);
Chris Lattner30ba5692004-10-11 05:54:41 +000062
63 private:
Chris Lattnerb1ab4582005-09-26 01:43:45 +000064 GlobalVariable *FindGlobalCtors(Module &M);
65 bool OptimizeFunctions(Module &M);
66 bool OptimizeGlobalVars(Module &M);
Anton Korobeynikove4c6b612008-09-09 19:04:59 +000067 bool ResolveAliases(Module &M);
Chris Lattnerb1ab4582005-09-26 01:43:45 +000068 bool OptimizeGlobalCtorsList(GlobalVariable *&GCL);
Chris Lattner7f8897f2006-08-27 22:42:52 +000069 bool ProcessInternalGlobal(GlobalVariable *GV,Module::global_iterator &GVI);
Chris Lattner079236d2004-02-25 21:34:36 +000070 };
Chris Lattner079236d2004-02-25 21:34:36 +000071}
72
Dan Gohman844731a2008-05-13 00:00:25 +000073char GlobalOpt::ID = 0;
74static RegisterPass<GlobalOpt> X("globalopt", "Global Variable Optimizer");
75
Chris Lattner7a90b682004-10-07 04:16:33 +000076ModulePass *llvm::createGlobalOptimizerPass() { return new GlobalOpt(); }
Chris Lattner079236d2004-02-25 21:34:36 +000077
Dan Gohman844731a2008-05-13 00:00:25 +000078namespace {
79
Chris Lattner7a90b682004-10-07 04:16:33 +000080/// GlobalStatus - As we analyze each global, keep track of some information
81/// about it. If we find out that the address of the global is taken, none of
Chris Lattnercf4d2a52004-10-07 21:30:30 +000082/// this info will be accurate.
Reid Spencer9133fe22007-02-05 23:32:05 +000083struct VISIBILITY_HIDDEN GlobalStatus {
Chris Lattnercf4d2a52004-10-07 21:30:30 +000084 /// isLoaded - True if the global is ever loaded. If the global isn't ever
85 /// loaded it can be deleted.
Chris Lattner7a90b682004-10-07 04:16:33 +000086 bool isLoaded;
Chris Lattnercf4d2a52004-10-07 21:30:30 +000087
88 /// StoredType - Keep track of what stores to the global look like.
89 ///
Chris Lattner7a90b682004-10-07 04:16:33 +000090 enum StoredType {
Chris Lattnercf4d2a52004-10-07 21:30:30 +000091 /// NotStored - There is no store to this global. It can thus be marked
92 /// constant.
93 NotStored,
94
95 /// isInitializerStored - This global is stored to, but the only thing
96 /// stored is the constant it was initialized with. This is only tracked
97 /// for scalar globals.
98 isInitializerStored,
99
100 /// isStoredOnce - This global is stored to, but only its initializer and
101 /// one other value is ever stored to it. If this global isStoredOnce, we
102 /// track the value stored to it in StoredOnceValue below. This is only
103 /// tracked for scalar globals.
104 isStoredOnce,
105
106 /// isStored - This global is stored to by multiple values or something else
107 /// that we cannot track.
108 isStored
Chris Lattner7a90b682004-10-07 04:16:33 +0000109 } StoredType;
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000110
111 /// StoredOnceValue - If only one value (besides the initializer constant) is
112 /// ever stored to this global, keep track of what value it is.
113 Value *StoredOnceValue;
114
Chris Lattner25de4e52006-11-01 18:03:33 +0000115 /// AccessingFunction/HasMultipleAccessingFunctions - These start out
116 /// null/false. When the first accessing function is noticed, it is recorded.
117 /// When a second different accessing function is noticed,
118 /// HasMultipleAccessingFunctions is set to true.
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +0000119 Function *AccessingFunction;
120 bool HasMultipleAccessingFunctions;
121
Chris Lattner25de4e52006-11-01 18:03:33 +0000122 /// HasNonInstructionUser - Set to true if this global has a user that is not
123 /// an instruction (e.g. a constant expr or GV initializer).
Chris Lattner553ca522005-06-15 21:11:48 +0000124 bool HasNonInstructionUser;
125
Chris Lattner25de4e52006-11-01 18:03:33 +0000126 /// HasPHIUser - Set to true if this global has a user that is a PHI node.
127 bool HasPHIUser;
128
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000129 GlobalStatus() : isLoaded(false), StoredType(NotStored), StoredOnceValue(0),
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +0000130 AccessingFunction(0), HasMultipleAccessingFunctions(false),
Chris Lattner6a93fc02008-01-14 01:32:52 +0000131 HasNonInstructionUser(false), HasPHIUser(false) {}
Chris Lattner7a90b682004-10-07 04:16:33 +0000132};
Chris Lattnere47ba742004-10-06 20:57:02 +0000133
Dan Gohman844731a2008-05-13 00:00:25 +0000134}
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000135
136/// ConstantIsDead - Return true if the specified constant is (transitively)
137/// dead. The constant may be used by other constants (e.g. constant arrays and
138/// constant exprs) as long as they are dead, but it cannot be used by anything
139/// else.
140static bool ConstantIsDead(Constant *C) {
141 if (isa<GlobalValue>(C)) return false;
142
143 for (Value::use_iterator UI = C->use_begin(), E = C->use_end(); UI != E; ++UI)
144 if (Constant *CU = dyn_cast<Constant>(*UI)) {
145 if (!ConstantIsDead(CU)) return false;
146 } else
147 return false;
148 return true;
149}
150
151
Chris Lattner7a90b682004-10-07 04:16:33 +0000152/// AnalyzeGlobal - Look at all uses of the global and fill in the GlobalStatus
153/// structure. If the global has its address taken, return true to indicate we
154/// can't do anything with it.
Chris Lattner079236d2004-02-25 21:34:36 +0000155///
Chris Lattner7a90b682004-10-07 04:16:33 +0000156static bool AnalyzeGlobal(Value *V, GlobalStatus &GS,
Chris Lattner5a6bb6a2008-12-16 07:34:30 +0000157 SmallPtrSet<PHINode*, 16> &PHIUsers) {
Chris Lattner079236d2004-02-25 21:34:36 +0000158 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
Chris Lattner96940cb2004-07-18 19:56:20 +0000159 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(*UI)) {
Chris Lattner553ca522005-06-15 21:11:48 +0000160 GS.HasNonInstructionUser = true;
161
Chris Lattner7a90b682004-10-07 04:16:33 +0000162 if (AnalyzeGlobal(CE, GS, PHIUsers)) return true;
Chris Lattner670c8892004-10-08 17:32:09 +0000163
Chris Lattner079236d2004-02-25 21:34:36 +0000164 } else if (Instruction *I = dyn_cast<Instruction>(*UI)) {
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +0000165 if (!GS.HasMultipleAccessingFunctions) {
166 Function *F = I->getParent()->getParent();
167 if (GS.AccessingFunction == 0)
168 GS.AccessingFunction = F;
169 else if (GS.AccessingFunction != F)
170 GS.HasMultipleAccessingFunctions = true;
171 }
Chris Lattnerc69d3c92008-01-29 19:01:37 +0000172 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
Chris Lattner7a90b682004-10-07 04:16:33 +0000173 GS.isLoaded = true;
Chris Lattnerc69d3c92008-01-29 19:01:37 +0000174 if (LI->isVolatile()) return true; // Don't hack on volatile loads.
Chris Lattner7a90b682004-10-07 04:16:33 +0000175 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
Chris Lattner36025492004-10-07 06:01:25 +0000176 // Don't allow a store OF the address, only stores TO the address.
177 if (SI->getOperand(0) == V) return true;
178
Chris Lattnerc69d3c92008-01-29 19:01:37 +0000179 if (SI->isVolatile()) return true; // Don't hack on volatile stores.
180
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000181 // If this is a direct store to the global (i.e., the global is a scalar
182 // value, not an aggregate), keep more specific information about
183 // stores.
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000184 if (GS.StoredType != GlobalStatus::isStored) {
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000185 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(SI->getOperand(1))){
Chris Lattnerbd38edf2004-11-14 20:50:30 +0000186 Value *StoredVal = SI->getOperand(0);
187 if (StoredVal == GV->getInitializer()) {
188 if (GS.StoredType < GlobalStatus::isInitializerStored)
189 GS.StoredType = GlobalStatus::isInitializerStored;
190 } else if (isa<LoadInst>(StoredVal) &&
191 cast<LoadInst>(StoredVal)->getOperand(0) == GV) {
192 // G = G
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000193 if (GS.StoredType < GlobalStatus::isInitializerStored)
194 GS.StoredType = GlobalStatus::isInitializerStored;
195 } else if (GS.StoredType < GlobalStatus::isStoredOnce) {
196 GS.StoredType = GlobalStatus::isStoredOnce;
Chris Lattnerbd38edf2004-11-14 20:50:30 +0000197 GS.StoredOnceValue = StoredVal;
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000198 } else if (GS.StoredType == GlobalStatus::isStoredOnce &&
Chris Lattnerbd38edf2004-11-14 20:50:30 +0000199 GS.StoredOnceValue == StoredVal) {
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000200 // noop.
201 } else {
202 GS.StoredType = GlobalStatus::isStored;
203 }
204 } else {
Chris Lattner7a90b682004-10-07 04:16:33 +0000205 GS.StoredType = GlobalStatus::isStored;
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000206 }
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000207 }
Chris Lattner35c81b02005-02-27 18:58:52 +0000208 } else if (isa<GetElementPtrInst>(I)) {
Chris Lattner7a90b682004-10-07 04:16:33 +0000209 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
Chris Lattner35c81b02005-02-27 18:58:52 +0000210 } else if (isa<SelectInst>(I)) {
Chris Lattner7a90b682004-10-07 04:16:33 +0000211 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
Chris Lattner7a90b682004-10-07 04:16:33 +0000212 } else if (PHINode *PN = dyn_cast<PHINode>(I)) {
213 // PHI nodes we can check just like select or GEP instructions, but we
214 // have to be careful about infinite recursion.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +0000215 if (PHIUsers.insert(PN)) // Not already visited.
Chris Lattner7a90b682004-10-07 04:16:33 +0000216 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
Chris Lattner25de4e52006-11-01 18:03:33 +0000217 GS.HasPHIUser = true;
Reid Spencere4d87aa2006-12-23 06:05:41 +0000218 } else if (isa<CmpInst>(I)) {
Chris Lattner35c81b02005-02-27 18:58:52 +0000219 } else if (isa<MemCpyInst>(I) || isa<MemMoveInst>(I)) {
220 if (I->getOperand(1) == V)
221 GS.StoredType = GlobalStatus::isStored;
222 if (I->getOperand(2) == V)
223 GS.isLoaded = true;
Chris Lattner35c81b02005-02-27 18:58:52 +0000224 } else if (isa<MemSetInst>(I)) {
225 assert(I->getOperand(1) == V && "Memset only takes one pointer!");
226 GS.StoredType = GlobalStatus::isStored;
Chris Lattner7a90b682004-10-07 04:16:33 +0000227 } else {
228 return true; // Any other non-load instruction might take address!
Chris Lattner9ce30002004-07-20 03:58:07 +0000229 }
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000230 } else if (Constant *C = dyn_cast<Constant>(*UI)) {
Chris Lattner553ca522005-06-15 21:11:48 +0000231 GS.HasNonInstructionUser = true;
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000232 // We might have a dead and dangling constant hanging off of here.
233 if (!ConstantIsDead(C))
234 return true;
Chris Lattner079236d2004-02-25 21:34:36 +0000235 } else {
Chris Lattner553ca522005-06-15 21:11:48 +0000236 GS.HasNonInstructionUser = true;
237 // Otherwise must be some other user.
Chris Lattner079236d2004-02-25 21:34:36 +0000238 return true;
239 }
240
241 return false;
242}
243
Chris Lattner670c8892004-10-08 17:32:09 +0000244static Constant *getAggregateConstantElement(Constant *Agg, Constant *Idx) {
245 ConstantInt *CI = dyn_cast<ConstantInt>(Idx);
246 if (!CI) return 0;
Reid Spencerb83eb642006-10-20 07:07:24 +0000247 unsigned IdxV = CI->getZExtValue();
Chris Lattner7a90b682004-10-07 04:16:33 +0000248
Chris Lattner670c8892004-10-08 17:32:09 +0000249 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Agg)) {
250 if (IdxV < CS->getNumOperands()) return CS->getOperand(IdxV);
251 } else if (ConstantArray *CA = dyn_cast<ConstantArray>(Agg)) {
252 if (IdxV < CA->getNumOperands()) return CA->getOperand(IdxV);
Reid Spencer9d6565a2007-02-15 02:26:10 +0000253 } else if (ConstantVector *CP = dyn_cast<ConstantVector>(Agg)) {
Chris Lattner670c8892004-10-08 17:32:09 +0000254 if (IdxV < CP->getNumOperands()) return CP->getOperand(IdxV);
Chris Lattner7a7ed022004-10-16 18:09:00 +0000255 } else if (isa<ConstantAggregateZero>(Agg)) {
Chris Lattner670c8892004-10-08 17:32:09 +0000256 if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
257 if (IdxV < STy->getNumElements())
258 return Constant::getNullValue(STy->getElementType(IdxV));
259 } else if (const SequentialType *STy =
260 dyn_cast<SequentialType>(Agg->getType())) {
261 return Constant::getNullValue(STy->getElementType());
262 }
Chris Lattner7a7ed022004-10-16 18:09:00 +0000263 } else if (isa<UndefValue>(Agg)) {
264 if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
265 if (IdxV < STy->getNumElements())
266 return UndefValue::get(STy->getElementType(IdxV));
267 } else if (const SequentialType *STy =
268 dyn_cast<SequentialType>(Agg->getType())) {
269 return UndefValue::get(STy->getElementType());
270 }
Chris Lattner670c8892004-10-08 17:32:09 +0000271 }
272 return 0;
273}
Chris Lattner7a90b682004-10-07 04:16:33 +0000274
Chris Lattner7a90b682004-10-07 04:16:33 +0000275
Chris Lattnere47ba742004-10-06 20:57:02 +0000276/// CleanupConstantGlobalUsers - We just marked GV constant. Loop over all
277/// users of the global, cleaning up the obvious ones. This is largely just a
Chris Lattner031955d2004-10-10 16:43:46 +0000278/// quick scan over the use list to clean up the easy and obvious cruft. This
279/// returns true if it made a change.
280static bool CleanupConstantGlobalUsers(Value *V, Constant *Init) {
281 bool Changed = false;
Chris Lattner7a90b682004-10-07 04:16:33 +0000282 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;) {
283 User *U = *UI++;
Misha Brukmanfd939082005-04-21 23:48:37 +0000284
Chris Lattner7a90b682004-10-07 04:16:33 +0000285 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattner35c81b02005-02-27 18:58:52 +0000286 if (Init) {
287 // Replace the load with the initializer.
288 LI->replaceAllUsesWith(Init);
289 LI->eraseFromParent();
290 Changed = true;
291 }
Chris Lattner7a90b682004-10-07 04:16:33 +0000292 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattnere47ba742004-10-06 20:57:02 +0000293 // Store must be unreachable or storing Init into the global.
Chris Lattner7a7ed022004-10-16 18:09:00 +0000294 SI->eraseFromParent();
Chris Lattner031955d2004-10-10 16:43:46 +0000295 Changed = true;
Chris Lattner7a90b682004-10-07 04:16:33 +0000296 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
297 if (CE->getOpcode() == Instruction::GetElementPtr) {
Chris Lattneraae4a1c2005-09-26 07:34:35 +0000298 Constant *SubInit = 0;
299 if (Init)
300 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
Chris Lattner35c81b02005-02-27 18:58:52 +0000301 Changed |= CleanupConstantGlobalUsers(CE, SubInit);
Reid Spencer3da59db2006-11-27 01:05:10 +0000302 } else if (CE->getOpcode() == Instruction::BitCast &&
Chris Lattner35c81b02005-02-27 18:58:52 +0000303 isa<PointerType>(CE->getType())) {
304 // Pointer cast, delete any stores and memsets to the global.
305 Changed |= CleanupConstantGlobalUsers(CE, 0);
306 }
307
308 if (CE->use_empty()) {
309 CE->destroyConstant();
310 Changed = true;
Chris Lattner7a90b682004-10-07 04:16:33 +0000311 }
312 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner7b52fe72007-11-09 17:33:02 +0000313 // Do not transform "gepinst (gep constexpr (GV))" here, because forming
314 // "gepconstexpr (gep constexpr (GV))" will cause the two gep's to fold
315 // and will invalidate our notion of what Init is.
Chris Lattner19450242007-11-13 21:46:23 +0000316 Constant *SubInit = 0;
Chris Lattner7b52fe72007-11-09 17:33:02 +0000317 if (!isa<ConstantExpr>(GEP->getOperand(0))) {
318 ConstantExpr *CE =
319 dyn_cast_or_null<ConstantExpr>(ConstantFoldInstruction(GEP));
320 if (Init && CE && CE->getOpcode() == Instruction::GetElementPtr)
Chris Lattner19450242007-11-13 21:46:23 +0000321 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
Chris Lattner7b52fe72007-11-09 17:33:02 +0000322 }
Chris Lattner19450242007-11-13 21:46:23 +0000323 Changed |= CleanupConstantGlobalUsers(GEP, SubInit);
Chris Lattnerc4d81b02004-10-10 16:47:33 +0000324
Chris Lattner031955d2004-10-10 16:43:46 +0000325 if (GEP->use_empty()) {
Chris Lattner7a7ed022004-10-16 18:09:00 +0000326 GEP->eraseFromParent();
Chris Lattner031955d2004-10-10 16:43:46 +0000327 Changed = true;
328 }
Chris Lattner35c81b02005-02-27 18:58:52 +0000329 } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(U)) { // memset/cpy/mv
330 if (MI->getRawDest() == V) {
331 MI->eraseFromParent();
332 Changed = true;
333 }
334
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000335 } else if (Constant *C = dyn_cast<Constant>(U)) {
336 // If we have a chain of dead constantexprs or other things dangling from
337 // us, and if they are all dead, nuke them without remorse.
338 if (ConstantIsDead(C)) {
339 C->destroyConstant();
Chris Lattner35c81b02005-02-27 18:58:52 +0000340 // This could have invalidated UI, start over from scratch.
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000341 CleanupConstantGlobalUsers(V, Init);
Chris Lattner031955d2004-10-10 16:43:46 +0000342 return true;
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000343 }
Chris Lattnere47ba742004-10-06 20:57:02 +0000344 }
345 }
Chris Lattner031955d2004-10-10 16:43:46 +0000346 return Changed;
Chris Lattnere47ba742004-10-06 20:57:02 +0000347}
348
Chris Lattner941db492008-01-14 02:09:12 +0000349/// isSafeSROAElementUse - Return true if the specified instruction is a safe
350/// user of a derived expression from a global that we want to SROA.
351static bool isSafeSROAElementUse(Value *V) {
352 // We might have a dead and dangling constant hanging off of here.
353 if (Constant *C = dyn_cast<Constant>(V))
354 return ConstantIsDead(C);
Chris Lattner727c2102008-01-14 01:31:05 +0000355
Chris Lattner941db492008-01-14 02:09:12 +0000356 Instruction *I = dyn_cast<Instruction>(V);
357 if (!I) return false;
358
359 // Loads are ok.
360 if (isa<LoadInst>(I)) return true;
361
362 // Stores *to* the pointer are ok.
363 if (StoreInst *SI = dyn_cast<StoreInst>(I))
364 return SI->getOperand(0) != V;
365
366 // Otherwise, it must be a GEP.
367 GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I);
368 if (GEPI == 0) return false;
369
370 if (GEPI->getNumOperands() < 3 || !isa<Constant>(GEPI->getOperand(1)) ||
371 !cast<Constant>(GEPI->getOperand(1))->isNullValue())
372 return false;
373
374 for (Value::use_iterator I = GEPI->use_begin(), E = GEPI->use_end();
375 I != E; ++I)
376 if (!isSafeSROAElementUse(*I))
377 return false;
Chris Lattner727c2102008-01-14 01:31:05 +0000378 return true;
379}
380
Chris Lattner941db492008-01-14 02:09:12 +0000381
382/// IsUserOfGlobalSafeForSRA - U is a direct user of the specified global value.
383/// Look at it and its uses and decide whether it is safe to SROA this global.
384///
385static bool IsUserOfGlobalSafeForSRA(User *U, GlobalValue *GV) {
386 // The user of the global must be a GEP Inst or a ConstantExpr GEP.
387 if (!isa<GetElementPtrInst>(U) &&
388 (!isa<ConstantExpr>(U) ||
389 cast<ConstantExpr>(U)->getOpcode() != Instruction::GetElementPtr))
390 return false;
391
392 // Check to see if this ConstantExpr GEP is SRA'able. In particular, we
393 // don't like < 3 operand CE's, and we don't like non-constant integer
394 // indices. This enforces that all uses are 'gep GV, 0, C, ...' for some
395 // value of C.
396 if (U->getNumOperands() < 3 || !isa<Constant>(U->getOperand(1)) ||
397 !cast<Constant>(U->getOperand(1))->isNullValue() ||
398 !isa<ConstantInt>(U->getOperand(2)))
399 return false;
400
401 gep_type_iterator GEPI = gep_type_begin(U), E = gep_type_end(U);
402 ++GEPI; // Skip over the pointer index.
403
404 // If this is a use of an array allocation, do a bit more checking for sanity.
405 if (const ArrayType *AT = dyn_cast<ArrayType>(*GEPI)) {
406 uint64_t NumElements = AT->getNumElements();
407 ConstantInt *Idx = cast<ConstantInt>(U->getOperand(2));
408
409 // Check to make sure that index falls within the array. If not,
410 // something funny is going on, so we won't do the optimization.
411 //
412 if (Idx->getZExtValue() >= NumElements)
413 return false;
414
415 // We cannot scalar repl this level of the array unless any array
416 // sub-indices are in-range constants. In particular, consider:
417 // A[0][i]. We cannot know that the user isn't doing invalid things like
418 // allowing i to index an out-of-range subscript that accesses A[1].
419 //
420 // Scalar replacing *just* the outer index of the array is probably not
421 // going to be a win anyway, so just give up.
422 for (++GEPI; // Skip array index.
423 GEPI != E && (isa<ArrayType>(*GEPI) || isa<VectorType>(*GEPI));
424 ++GEPI) {
425 uint64_t NumElements;
426 if (const ArrayType *SubArrayTy = dyn_cast<ArrayType>(*GEPI))
427 NumElements = SubArrayTy->getNumElements();
428 else
429 NumElements = cast<VectorType>(*GEPI)->getNumElements();
430
431 ConstantInt *IdxVal = dyn_cast<ConstantInt>(GEPI.getOperand());
432 if (!IdxVal || IdxVal->getZExtValue() >= NumElements)
433 return false;
434 }
435 }
436
437 for (Value::use_iterator I = U->use_begin(), E = U->use_end(); I != E; ++I)
438 if (!isSafeSROAElementUse(*I))
439 return false;
440 return true;
441}
442
443/// GlobalUsersSafeToSRA - Look at all uses of the global and decide whether it
444/// is safe for us to perform this transformation.
445///
446static bool GlobalUsersSafeToSRA(GlobalValue *GV) {
447 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end();
448 UI != E; ++UI) {
449 if (!IsUserOfGlobalSafeForSRA(*UI, GV))
450 return false;
451 }
452 return true;
453}
454
455
Chris Lattner670c8892004-10-08 17:32:09 +0000456/// SRAGlobal - Perform scalar replacement of aggregates on the specified global
457/// variable. This opens the door for other optimizations by exposing the
458/// behavior of the program in a more fine-grained way. We have determined that
459/// this transformation is safe already. We return the first global variable we
460/// insert so that the caller can reprocess it.
Chris Lattner998182b2008-04-26 07:40:11 +0000461static GlobalVariable *SRAGlobal(GlobalVariable *GV, const TargetData &TD) {
Chris Lattner727c2102008-01-14 01:31:05 +0000462 // Make sure this global only has simple uses that we can SRA.
Chris Lattner941db492008-01-14 02:09:12 +0000463 if (!GlobalUsersSafeToSRA(GV))
Chris Lattner727c2102008-01-14 01:31:05 +0000464 return 0;
465
Chris Lattner670c8892004-10-08 17:32:09 +0000466 assert(GV->hasInternalLinkage() && !GV->isConstant());
467 Constant *Init = GV->getInitializer();
468 const Type *Ty = Init->getType();
Misha Brukmanfd939082005-04-21 23:48:37 +0000469
Chris Lattner670c8892004-10-08 17:32:09 +0000470 std::vector<GlobalVariable*> NewGlobals;
471 Module::GlobalListType &Globals = GV->getParent()->getGlobalList();
472
Chris Lattner998182b2008-04-26 07:40:11 +0000473 // Get the alignment of the global, either explicit or target-specific.
474 unsigned StartAlignment = GV->getAlignment();
475 if (StartAlignment == 0)
476 StartAlignment = TD.getABITypeAlignment(GV->getType());
477
Chris Lattner670c8892004-10-08 17:32:09 +0000478 if (const StructType *STy = dyn_cast<StructType>(Ty)) {
479 NewGlobals.reserve(STy->getNumElements());
Chris Lattner998182b2008-04-26 07:40:11 +0000480 const StructLayout &Layout = *TD.getStructLayout(STy);
Chris Lattner670c8892004-10-08 17:32:09 +0000481 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
482 Constant *In = getAggregateConstantElement(Init,
Reid Spencerc5b206b2006-12-31 05:48:39 +0000483 ConstantInt::get(Type::Int32Ty, i));
Chris Lattner670c8892004-10-08 17:32:09 +0000484 assert(In && "Couldn't get element of initializer?");
485 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(i), false,
486 GlobalVariable::InternalLinkage,
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +0000487 In, GV->getName()+"."+utostr(i),
488 (Module *)NULL,
Matthijs Kooijmanbc1f9892008-07-17 11:59:53 +0000489 GV->isThreadLocal(),
490 GV->getType()->getAddressSpace());
Chris Lattner670c8892004-10-08 17:32:09 +0000491 Globals.insert(GV, NGV);
492 NewGlobals.push_back(NGV);
Chris Lattner998182b2008-04-26 07:40:11 +0000493
494 // Calculate the known alignment of the field. If the original aggregate
495 // had 256 byte alignment for example, something might depend on that:
496 // propagate info to each field.
497 uint64_t FieldOffset = Layout.getElementOffset(i);
498 unsigned NewAlign = (unsigned)MinAlign(StartAlignment, FieldOffset);
499 if (NewAlign > TD.getABITypeAlignment(STy->getElementType(i)))
500 NGV->setAlignment(NewAlign);
Chris Lattner670c8892004-10-08 17:32:09 +0000501 }
502 } else if (const SequentialType *STy = dyn_cast<SequentialType>(Ty)) {
503 unsigned NumElements = 0;
504 if (const ArrayType *ATy = dyn_cast<ArrayType>(STy))
505 NumElements = ATy->getNumElements();
Chris Lattner670c8892004-10-08 17:32:09 +0000506 else
Chris Lattner998182b2008-04-26 07:40:11 +0000507 NumElements = cast<VectorType>(STy)->getNumElements();
Chris Lattner670c8892004-10-08 17:32:09 +0000508
Chris Lattner1f21ef12005-02-23 16:53:04 +0000509 if (NumElements > 16 && GV->hasNUsesOrMore(16))
Chris Lattnerd514d822005-02-01 01:23:31 +0000510 return 0; // It's not worth it.
Chris Lattner670c8892004-10-08 17:32:09 +0000511 NewGlobals.reserve(NumElements);
Chris Lattner998182b2008-04-26 07:40:11 +0000512
513 uint64_t EltSize = TD.getABITypeSize(STy->getElementType());
514 unsigned EltAlign = TD.getABITypeAlignment(STy->getElementType());
Chris Lattner670c8892004-10-08 17:32:09 +0000515 for (unsigned i = 0, e = NumElements; i != e; ++i) {
516 Constant *In = getAggregateConstantElement(Init,
Reid Spencerc5b206b2006-12-31 05:48:39 +0000517 ConstantInt::get(Type::Int32Ty, i));
Chris Lattner670c8892004-10-08 17:32:09 +0000518 assert(In && "Couldn't get element of initializer?");
519
520 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(), false,
521 GlobalVariable::InternalLinkage,
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +0000522 In, GV->getName()+"."+utostr(i),
523 (Module *)NULL,
Matthijs Kooijmanbc1f9892008-07-17 11:59:53 +0000524 GV->isThreadLocal(),
525 GV->getType()->getAddressSpace());
Chris Lattner670c8892004-10-08 17:32:09 +0000526 Globals.insert(GV, NGV);
527 NewGlobals.push_back(NGV);
Chris Lattner998182b2008-04-26 07:40:11 +0000528
529 // Calculate the known alignment of the field. If the original aggregate
530 // had 256 byte alignment for example, something might depend on that:
531 // propagate info to each field.
532 unsigned NewAlign = (unsigned)MinAlign(StartAlignment, EltSize*i);
533 if (NewAlign > EltAlign)
534 NGV->setAlignment(NewAlign);
Chris Lattner670c8892004-10-08 17:32:09 +0000535 }
536 }
537
538 if (NewGlobals.empty())
539 return 0;
540
Bill Wendling0a81aac2006-11-26 10:02:32 +0000541 DOUT << "PERFORMING GLOBAL SRA ON: " << *GV;
Chris Lattner30ba5692004-10-11 05:54:41 +0000542
Reid Spencerc5b206b2006-12-31 05:48:39 +0000543 Constant *NullInt = Constant::getNullValue(Type::Int32Ty);
Chris Lattner670c8892004-10-08 17:32:09 +0000544
545 // Loop over all of the uses of the global, replacing the constantexpr geps,
546 // with smaller constantexpr geps or direct references.
547 while (!GV->use_empty()) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000548 User *GEP = GV->use_back();
549 assert(((isa<ConstantExpr>(GEP) &&
550 cast<ConstantExpr>(GEP)->getOpcode()==Instruction::GetElementPtr)||
551 isa<GetElementPtrInst>(GEP)) && "NonGEP CE's are not SRAable!");
Misha Brukmanfd939082005-04-21 23:48:37 +0000552
Chris Lattner670c8892004-10-08 17:32:09 +0000553 // Ignore the 1th operand, which has to be zero or else the program is quite
554 // broken (undefined). Get the 2nd operand, which is the structure or array
555 // index.
Reid Spencerb83eb642006-10-20 07:07:24 +0000556 unsigned Val = cast<ConstantInt>(GEP->getOperand(2))->getZExtValue();
Chris Lattner670c8892004-10-08 17:32:09 +0000557 if (Val >= NewGlobals.size()) Val = 0; // Out of bound array access.
558
Chris Lattner30ba5692004-10-11 05:54:41 +0000559 Value *NewPtr = NewGlobals[Val];
Chris Lattner670c8892004-10-08 17:32:09 +0000560
561 // Form a shorter GEP if needed.
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000562 if (GEP->getNumOperands() > 3) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000563 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEP)) {
Chris Lattner55eb1c42007-01-31 04:40:53 +0000564 SmallVector<Constant*, 8> Idxs;
Chris Lattner30ba5692004-10-11 05:54:41 +0000565 Idxs.push_back(NullInt);
566 for (unsigned i = 3, e = CE->getNumOperands(); i != e; ++i)
567 Idxs.push_back(CE->getOperand(i));
Chris Lattner55eb1c42007-01-31 04:40:53 +0000568 NewPtr = ConstantExpr::getGetElementPtr(cast<Constant>(NewPtr),
569 &Idxs[0], Idxs.size());
Chris Lattner30ba5692004-10-11 05:54:41 +0000570 } else {
571 GetElementPtrInst *GEPI = cast<GetElementPtrInst>(GEP);
Chris Lattner699d1442007-01-31 19:59:55 +0000572 SmallVector<Value*, 8> Idxs;
Chris Lattner30ba5692004-10-11 05:54:41 +0000573 Idxs.push_back(NullInt);
574 for (unsigned i = 3, e = GEPI->getNumOperands(); i != e; ++i)
575 Idxs.push_back(GEPI->getOperand(i));
Gabor Greif051a9502008-04-06 20:25:17 +0000576 NewPtr = GetElementPtrInst::Create(NewPtr, Idxs.begin(), Idxs.end(),
577 GEPI->getName()+"."+utostr(Val), GEPI);
Chris Lattner30ba5692004-10-11 05:54:41 +0000578 }
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000579 }
Chris Lattner30ba5692004-10-11 05:54:41 +0000580 GEP->replaceAllUsesWith(NewPtr);
581
582 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(GEP))
Chris Lattner7a7ed022004-10-16 18:09:00 +0000583 GEPI->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000584 else
585 cast<ConstantExpr>(GEP)->destroyConstant();
Chris Lattner670c8892004-10-08 17:32:09 +0000586 }
587
Chris Lattnere40e2d12004-10-08 20:25:55 +0000588 // Delete the old global, now that it is dead.
589 Globals.erase(GV);
Chris Lattner670c8892004-10-08 17:32:09 +0000590 ++NumSRA;
Chris Lattner30ba5692004-10-11 05:54:41 +0000591
592 // Loop over the new globals array deleting any globals that are obviously
593 // dead. This can arise due to scalarization of a structure or an array that
594 // has elements that are dead.
595 unsigned FirstGlobal = 0;
596 for (unsigned i = 0, e = NewGlobals.size(); i != e; ++i)
597 if (NewGlobals[i]->use_empty()) {
598 Globals.erase(NewGlobals[i]);
599 if (FirstGlobal == i) ++FirstGlobal;
600 }
601
602 return FirstGlobal != NewGlobals.size() ? NewGlobals[FirstGlobal] : 0;
Chris Lattner670c8892004-10-08 17:32:09 +0000603}
604
Chris Lattner9b34a612004-10-09 21:48:45 +0000605/// AllUsesOfValueWillTrapIfNull - Return true if all users of the specified
Chris Lattner81686182007-09-13 16:30:19 +0000606/// value will trap if the value is dynamically null. PHIs keeps track of any
607/// phi nodes we've seen to avoid reprocessing them.
608static bool AllUsesOfValueWillTrapIfNull(Value *V,
609 SmallPtrSet<PHINode*, 8> &PHIs) {
Chris Lattner9b34a612004-10-09 21:48:45 +0000610 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
611 if (isa<LoadInst>(*UI)) {
612 // Will trap.
613 } else if (StoreInst *SI = dyn_cast<StoreInst>(*UI)) {
614 if (SI->getOperand(0) == V) {
Bill Wendlinge8156192006-12-07 01:30:32 +0000615 //cerr << "NONTRAPPING USE: " << **UI;
Chris Lattner9b34a612004-10-09 21:48:45 +0000616 return false; // Storing the value.
617 }
618 } else if (CallInst *CI = dyn_cast<CallInst>(*UI)) {
619 if (CI->getOperand(0) != V) {
Bill Wendlinge8156192006-12-07 01:30:32 +0000620 //cerr << "NONTRAPPING USE: " << **UI;
Chris Lattner9b34a612004-10-09 21:48:45 +0000621 return false; // Not calling the ptr
622 }
623 } else if (InvokeInst *II = dyn_cast<InvokeInst>(*UI)) {
624 if (II->getOperand(0) != V) {
Bill Wendlinge8156192006-12-07 01:30:32 +0000625 //cerr << "NONTRAPPING USE: " << **UI;
Chris Lattner9b34a612004-10-09 21:48:45 +0000626 return false; // Not calling the ptr
627 }
Chris Lattner81686182007-09-13 16:30:19 +0000628 } else if (BitCastInst *CI = dyn_cast<BitCastInst>(*UI)) {
629 if (!AllUsesOfValueWillTrapIfNull(CI, PHIs)) return false;
Chris Lattner9b34a612004-10-09 21:48:45 +0000630 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(*UI)) {
Chris Lattner81686182007-09-13 16:30:19 +0000631 if (!AllUsesOfValueWillTrapIfNull(GEPI, PHIs)) return false;
632 } else if (PHINode *PN = dyn_cast<PHINode>(*UI)) {
633 // If we've already seen this phi node, ignore it, it has already been
634 // checked.
635 if (PHIs.insert(PN))
636 return AllUsesOfValueWillTrapIfNull(PN, PHIs);
Reid Spencere4d87aa2006-12-23 06:05:41 +0000637 } else if (isa<ICmpInst>(*UI) &&
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000638 isa<ConstantPointerNull>(UI->getOperand(1))) {
639 // Ignore setcc X, null
Chris Lattner9b34a612004-10-09 21:48:45 +0000640 } else {
Bill Wendlinge8156192006-12-07 01:30:32 +0000641 //cerr << "NONTRAPPING USE: " << **UI;
Chris Lattner9b34a612004-10-09 21:48:45 +0000642 return false;
643 }
644 return true;
645}
646
647/// AllUsesOfLoadedValueWillTrapIfNull - Return true if all uses of any loads
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000648/// from GV will trap if the loaded value is null. Note that this also permits
649/// comparisons of the loaded value against null, as a special case.
Chris Lattner9b34a612004-10-09 21:48:45 +0000650static bool AllUsesOfLoadedValueWillTrapIfNull(GlobalVariable *GV) {
651 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI!=E; ++UI)
652 if (LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
Chris Lattner81686182007-09-13 16:30:19 +0000653 SmallPtrSet<PHINode*, 8> PHIs;
654 if (!AllUsesOfValueWillTrapIfNull(LI, PHIs))
Chris Lattner9b34a612004-10-09 21:48:45 +0000655 return false;
656 } else if (isa<StoreInst>(*UI)) {
657 // Ignore stores to the global.
658 } else {
659 // We don't know or understand this user, bail out.
Bill Wendlinge8156192006-12-07 01:30:32 +0000660 //cerr << "UNKNOWN USER OF GLOBAL!: " << **UI;
Chris Lattner9b34a612004-10-09 21:48:45 +0000661 return false;
662 }
663
664 return true;
665}
666
Chris Lattner708148e2004-10-10 23:14:11 +0000667static bool OptimizeAwayTrappingUsesOfValue(Value *V, Constant *NewV) {
668 bool Changed = false;
669 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ) {
670 Instruction *I = cast<Instruction>(*UI++);
671 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
672 LI->setOperand(0, NewV);
673 Changed = true;
674 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
675 if (SI->getOperand(1) == V) {
676 SI->setOperand(1, NewV);
677 Changed = true;
678 }
679 } else if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
680 if (I->getOperand(0) == V) {
681 // Calling through the pointer! Turn into a direct call, but be careful
682 // that the pointer is not also being passed as an argument.
683 I->setOperand(0, NewV);
684 Changed = true;
685 bool PassedAsArg = false;
686 for (unsigned i = 1, e = I->getNumOperands(); i != e; ++i)
687 if (I->getOperand(i) == V) {
688 PassedAsArg = true;
689 I->setOperand(i, NewV);
690 }
691
692 if (PassedAsArg) {
693 // Being passed as an argument also. Be careful to not invalidate UI!
694 UI = V->use_begin();
695 }
696 }
697 } else if (CastInst *CI = dyn_cast<CastInst>(I)) {
698 Changed |= OptimizeAwayTrappingUsesOfValue(CI,
Chris Lattner6e8fbad2006-11-30 17:32:29 +0000699 ConstantExpr::getCast(CI->getOpcode(),
700 NewV, CI->getType()));
Chris Lattner708148e2004-10-10 23:14:11 +0000701 if (CI->use_empty()) {
702 Changed = true;
Chris Lattner7a7ed022004-10-16 18:09:00 +0000703 CI->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +0000704 }
705 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
706 // Should handle GEP here.
Chris Lattner55eb1c42007-01-31 04:40:53 +0000707 SmallVector<Constant*, 8> Idxs;
708 Idxs.reserve(GEPI->getNumOperands()-1);
Gabor Greif5e463212008-05-29 01:59:18 +0000709 for (User::op_iterator i = GEPI->op_begin() + 1, e = GEPI->op_end();
710 i != e; ++i)
711 if (Constant *C = dyn_cast<Constant>(*i))
Chris Lattner55eb1c42007-01-31 04:40:53 +0000712 Idxs.push_back(C);
Chris Lattner708148e2004-10-10 23:14:11 +0000713 else
714 break;
Chris Lattner55eb1c42007-01-31 04:40:53 +0000715 if (Idxs.size() == GEPI->getNumOperands()-1)
Chris Lattner708148e2004-10-10 23:14:11 +0000716 Changed |= OptimizeAwayTrappingUsesOfValue(GEPI,
Chris Lattner55eb1c42007-01-31 04:40:53 +0000717 ConstantExpr::getGetElementPtr(NewV, &Idxs[0],
718 Idxs.size()));
Chris Lattner708148e2004-10-10 23:14:11 +0000719 if (GEPI->use_empty()) {
720 Changed = true;
Chris Lattner7a7ed022004-10-16 18:09:00 +0000721 GEPI->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +0000722 }
723 }
724 }
725
726 return Changed;
727}
728
729
730/// OptimizeAwayTrappingUsesOfLoads - The specified global has only one non-null
731/// value stored into it. If there are uses of the loaded value that would trap
732/// if the loaded value is dynamically null, then we know that they cannot be
733/// reachable with a null optimize away the load.
734static bool OptimizeAwayTrappingUsesOfLoads(GlobalVariable *GV, Constant *LV) {
735 std::vector<LoadInst*> Loads;
736 bool Changed = false;
737
738 // Replace all uses of loads with uses of uses of the stored value.
739 for (Value::use_iterator GUI = GV->use_begin(), E = GV->use_end();
740 GUI != E; ++GUI)
741 if (LoadInst *LI = dyn_cast<LoadInst>(*GUI)) {
742 Loads.push_back(LI);
743 Changed |= OptimizeAwayTrappingUsesOfValue(LI, LV);
744 } else {
Chris Lattnerce3e2bf2007-05-15 06:42:04 +0000745 // If we get here we could have stores, selects, or phi nodes whose values
Chris Lattner79cfddf2007-05-13 21:28:07 +0000746 // are loaded.
Chris Lattnerce3e2bf2007-05-15 06:42:04 +0000747 assert((isa<StoreInst>(*GUI) || isa<PHINode>(*GUI) ||
Chris Lattner9027b3c2008-01-04 05:04:53 +0000748 isa<SelectInst>(*GUI) || isa<ConstantExpr>(*GUI)) &&
Chris Lattner79cfddf2007-05-13 21:28:07 +0000749 "Only expect load and stores!");
Chris Lattner708148e2004-10-10 23:14:11 +0000750 }
751
752 if (Changed) {
Bill Wendling0a81aac2006-11-26 10:02:32 +0000753 DOUT << "OPTIMIZED LOADS FROM STORED ONCE POINTER: " << *GV;
Chris Lattner708148e2004-10-10 23:14:11 +0000754 ++NumGlobUses;
755 }
756
757 // Delete all of the loads we can, keeping track of whether we nuked them all!
758 bool AllLoadsGone = true;
759 while (!Loads.empty()) {
760 LoadInst *L = Loads.back();
761 if (L->use_empty()) {
Chris Lattner7a7ed022004-10-16 18:09:00 +0000762 L->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +0000763 Changed = true;
764 } else {
765 AllLoadsGone = false;
766 }
767 Loads.pop_back();
768 }
769
770 // If we nuked all of the loads, then none of the stores are needed either,
771 // nor is the global.
772 if (AllLoadsGone) {
Bill Wendling0a81aac2006-11-26 10:02:32 +0000773 DOUT << " *** GLOBAL NOW DEAD!\n";
Chris Lattner708148e2004-10-10 23:14:11 +0000774 CleanupConstantGlobalUsers(GV, 0);
775 if (GV->use_empty()) {
Chris Lattner7a7ed022004-10-16 18:09:00 +0000776 GV->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +0000777 ++NumDeleted;
778 }
779 Changed = true;
780 }
781 return Changed;
782}
783
Chris Lattner30ba5692004-10-11 05:54:41 +0000784/// ConstantPropUsersOf - Walk the use list of V, constant folding all of the
785/// instructions that are foldable.
786static void ConstantPropUsersOf(Value *V) {
787 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; )
788 if (Instruction *I = dyn_cast<Instruction>(*UI++))
789 if (Constant *NewC = ConstantFoldInstruction(I)) {
790 I->replaceAllUsesWith(NewC);
791
Chris Lattnerd514d822005-02-01 01:23:31 +0000792 // Advance UI to the next non-I use to avoid invalidating it!
793 // Instructions could multiply use V.
794 while (UI != E && *UI == I)
Chris Lattner30ba5692004-10-11 05:54:41 +0000795 ++UI;
Chris Lattnerd514d822005-02-01 01:23:31 +0000796 I->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000797 }
798}
799
800/// OptimizeGlobalAddressOfMalloc - This function takes the specified global
801/// variable, and transforms the program as if it always contained the result of
802/// the specified malloc. Because it is always the result of the specified
803/// malloc, there is no reason to actually DO the malloc. Instead, turn the
Chris Lattner6e8fbad2006-11-30 17:32:29 +0000804/// malloc into a global, and any loads of GV as uses of the new global.
Chris Lattner30ba5692004-10-11 05:54:41 +0000805static GlobalVariable *OptimizeGlobalAddressOfMalloc(GlobalVariable *GV,
806 MallocInst *MI) {
Bill Wendling0a81aac2006-11-26 10:02:32 +0000807 DOUT << "PROMOTING MALLOC GLOBAL: " << *GV << " MALLOC = " << *MI;
Chris Lattner30ba5692004-10-11 05:54:41 +0000808 ConstantInt *NElements = cast<ConstantInt>(MI->getArraySize());
809
Reid Spencerb83eb642006-10-20 07:07:24 +0000810 if (NElements->getZExtValue() != 1) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000811 // If we have an array allocation, transform it to a single element
812 // allocation to make the code below simpler.
813 Type *NewTy = ArrayType::get(MI->getAllocatedType(),
Reid Spencerb83eb642006-10-20 07:07:24 +0000814 NElements->getZExtValue());
Chris Lattner30ba5692004-10-11 05:54:41 +0000815 MallocInst *NewMI =
Reid Spencerc5b206b2006-12-31 05:48:39 +0000816 new MallocInst(NewTy, Constant::getNullValue(Type::Int32Ty),
Nate Begeman14b05292005-11-05 09:21:28 +0000817 MI->getAlignment(), MI->getName(), MI);
Chris Lattner699d1442007-01-31 19:59:55 +0000818 Value* Indices[2];
819 Indices[0] = Indices[1] = Constant::getNullValue(Type::Int32Ty);
Gabor Greif051a9502008-04-06 20:25:17 +0000820 Value *NewGEP = GetElementPtrInst::Create(NewMI, Indices, Indices + 2,
821 NewMI->getName()+".el0", MI);
Chris Lattner30ba5692004-10-11 05:54:41 +0000822 MI->replaceAllUsesWith(NewGEP);
Chris Lattner7a7ed022004-10-16 18:09:00 +0000823 MI->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000824 MI = NewMI;
825 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000826
Chris Lattner7a7ed022004-10-16 18:09:00 +0000827 // Create the new global variable. The contents of the malloc'd memory is
828 // undefined, so initialize with an undef value.
829 Constant *Init = UndefValue::get(MI->getAllocatedType());
Chris Lattner30ba5692004-10-11 05:54:41 +0000830 GlobalVariable *NewGV = new GlobalVariable(MI->getAllocatedType(), false,
831 GlobalValue::InternalLinkage, Init,
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +0000832 GV->getName()+".body",
833 (Module *)NULL,
834 GV->isThreadLocal());
Chris Lattner998182b2008-04-26 07:40:11 +0000835 // FIXME: This new global should have the alignment returned by malloc. Code
836 // could depend on malloc returning large alignment (on the mac, 16 bytes) but
837 // this would only guarantee some lower alignment.
Chris Lattner30ba5692004-10-11 05:54:41 +0000838 GV->getParent()->getGlobalList().insert(GV, NewGV);
Misha Brukmanfd939082005-04-21 23:48:37 +0000839
Chris Lattner30ba5692004-10-11 05:54:41 +0000840 // Anything that used the malloc now uses the global directly.
841 MI->replaceAllUsesWith(NewGV);
Chris Lattner30ba5692004-10-11 05:54:41 +0000842
843 Constant *RepValue = NewGV;
844 if (NewGV->getType() != GV->getType()->getElementType())
Reid Spencerd977d862006-12-12 23:36:14 +0000845 RepValue = ConstantExpr::getBitCast(RepValue,
846 GV->getType()->getElementType());
Chris Lattner30ba5692004-10-11 05:54:41 +0000847
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000848 // If there is a comparison against null, we will insert a global bool to
849 // keep track of whether the global was initialized yet or not.
Misha Brukmanfd939082005-04-21 23:48:37 +0000850 GlobalVariable *InitBool =
Reid Spencer4fe16d62007-01-11 18:21:29 +0000851 new GlobalVariable(Type::Int1Ty, false, GlobalValue::InternalLinkage,
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +0000852 ConstantInt::getFalse(), GV->getName()+".init",
853 (Module *)NULL, GV->isThreadLocal());
Chris Lattnerbc965b92004-12-02 06:25:58 +0000854 bool InitBoolUsed = false;
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000855
Chris Lattner30ba5692004-10-11 05:54:41 +0000856 // Loop over all uses of GV, processing them in turn.
Chris Lattnerbc965b92004-12-02 06:25:58 +0000857 std::vector<StoreInst*> Stores;
Chris Lattner30ba5692004-10-11 05:54:41 +0000858 while (!GV->use_empty())
859 if (LoadInst *LI = dyn_cast<LoadInst>(GV->use_back())) {
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000860 while (!LI->use_empty()) {
Chris Lattnerd514d822005-02-01 01:23:31 +0000861 Use &LoadUse = LI->use_begin().getUse();
Reid Spencere4d87aa2006-12-23 06:05:41 +0000862 if (!isa<ICmpInst>(LoadUse.getUser()))
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000863 LoadUse = RepValue;
864 else {
Reid Spencere4d87aa2006-12-23 06:05:41 +0000865 ICmpInst *CI = cast<ICmpInst>(LoadUse.getUser());
866 // Replace the cmp X, 0 with a use of the bool value.
867 Value *LV = new LoadInst(InitBool, InitBool->getName()+".val", CI);
Chris Lattnerbc965b92004-12-02 06:25:58 +0000868 InitBoolUsed = true;
Reid Spencere4d87aa2006-12-23 06:05:41 +0000869 switch (CI->getPredicate()) {
870 default: assert(0 && "Unknown ICmp Predicate!");
871 case ICmpInst::ICMP_ULT:
872 case ICmpInst::ICMP_SLT:
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +0000873 LV = ConstantInt::getFalse(); // X < null -> always false
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000874 break;
Reid Spencere4d87aa2006-12-23 06:05:41 +0000875 case ICmpInst::ICMP_ULE:
876 case ICmpInst::ICMP_SLE:
877 case ICmpInst::ICMP_EQ:
Gabor Greif7cbd8a32008-05-16 19:29:10 +0000878 LV = BinaryOperator::CreateNot(LV, "notinit", CI);
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000879 break;
Reid Spencere4d87aa2006-12-23 06:05:41 +0000880 case ICmpInst::ICMP_NE:
881 case ICmpInst::ICMP_UGE:
882 case ICmpInst::ICMP_SGE:
883 case ICmpInst::ICMP_UGT:
884 case ICmpInst::ICMP_SGT:
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000885 break; // no change.
886 }
Reid Spencere4d87aa2006-12-23 06:05:41 +0000887 CI->replaceAllUsesWith(LV);
888 CI->eraseFromParent();
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000889 }
890 }
Chris Lattner7a7ed022004-10-16 18:09:00 +0000891 LI->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000892 } else {
893 StoreInst *SI = cast<StoreInst>(GV->use_back());
Chris Lattnerbc965b92004-12-02 06:25:58 +0000894 // The global is initialized when the store to it occurs.
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +0000895 new StoreInst(ConstantInt::getTrue(), InitBool, SI);
Chris Lattner7a7ed022004-10-16 18:09:00 +0000896 SI->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000897 }
898
Chris Lattnerbc965b92004-12-02 06:25:58 +0000899 // If the initialization boolean was used, insert it, otherwise delete it.
900 if (!InitBoolUsed) {
901 while (!InitBool->use_empty()) // Delete initializations
902 cast<Instruction>(InitBool->use_back())->eraseFromParent();
903 delete InitBool;
904 } else
905 GV->getParent()->getGlobalList().insert(GV, InitBool);
906
907
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000908 // Now the GV is dead, nuke it and the malloc.
Chris Lattner7a7ed022004-10-16 18:09:00 +0000909 GV->eraseFromParent();
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000910 MI->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000911
912 // To further other optimizations, loop over all users of NewGV and try to
913 // constant prop them. This will promote GEP instructions with constant
914 // indices into GEP constant-exprs, which will allow global-opt to hack on it.
915 ConstantPropUsersOf(NewGV);
916 if (RepValue != NewGV)
917 ConstantPropUsersOf(RepValue);
918
919 return NewGV;
920}
Chris Lattner708148e2004-10-10 23:14:11 +0000921
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000922/// ValueIsOnlyUsedLocallyOrStoredToOneGlobal - Scan the use-list of V checking
923/// to make sure that there are no complex uses of V. We permit simple things
924/// like dereferencing the pointer, but not storing through the address, unless
925/// it is to the specified global.
926static bool ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Instruction *V,
Chris Lattnerc451f9c2007-09-13 16:37:20 +0000927 GlobalVariable *GV,
928 SmallPtrSet<PHINode*, 8> &PHIs) {
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000929 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
930 Instruction *Inst = dyn_cast<Instruction>(*UI);
931 if (Inst == 0) return false;
932
933 if (isa<LoadInst>(Inst) || isa<CmpInst>(Inst)) {
934 continue; // Fine, ignore.
935 }
936
937 if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000938 if (SI->getOperand(0) == V && SI->getOperand(1) != GV)
939 return false; // Storing the pointer itself... bad.
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000940 continue; // Otherwise, storing through it, or storing into GV... fine.
941 }
942
943 if (isa<GetElementPtrInst>(Inst)) {
944 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Inst, GV, PHIs))
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000945 return false;
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000946 continue;
947 }
948
949 if (PHINode *PN = dyn_cast<PHINode>(Inst)) {
Chris Lattnerc451f9c2007-09-13 16:37:20 +0000950 // PHIs are ok if all uses are ok. Don't infinitely recurse through PHI
951 // cycles.
952 if (PHIs.insert(PN))
Chris Lattner5e6e4942007-09-14 03:41:21 +0000953 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(PN, GV, PHIs))
954 return false;
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000955 continue;
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000956 }
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000957
958 if (BitCastInst *BCI = dyn_cast<BitCastInst>(Inst)) {
959 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(BCI, GV, PHIs))
960 return false;
961 continue;
962 }
963
964 return false;
965 }
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000966 return true;
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000967}
968
Chris Lattner86395032006-09-30 23:32:09 +0000969/// ReplaceUsesOfMallocWithGlobal - The Alloc pointer is stored into GV
970/// somewhere. Transform all uses of the allocation into loads from the
971/// global and uses of the resultant pointer. Further, delete the store into
972/// GV. This assumes that these value pass the
973/// 'ValueIsOnlyUsedLocallyOrStoredToOneGlobal' predicate.
974static void ReplaceUsesOfMallocWithGlobal(Instruction *Alloc,
975 GlobalVariable *GV) {
976 while (!Alloc->use_empty()) {
Chris Lattnera637a8b2007-09-13 18:00:31 +0000977 Instruction *U = cast<Instruction>(*Alloc->use_begin());
978 Instruction *InsertPt = U;
Chris Lattner86395032006-09-30 23:32:09 +0000979 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
980 // If this is the store of the allocation into the global, remove it.
981 if (SI->getOperand(1) == GV) {
982 SI->eraseFromParent();
983 continue;
984 }
Chris Lattnera637a8b2007-09-13 18:00:31 +0000985 } else if (PHINode *PN = dyn_cast<PHINode>(U)) {
986 // Insert the load in the corresponding predecessor, not right before the
987 // PHI.
988 unsigned PredNo = Alloc->use_begin().getOperandNo()/2;
989 InsertPt = PN->getIncomingBlock(PredNo)->getTerminator();
Chris Lattner101f44e2008-12-15 21:44:34 +0000990 } else if (isa<BitCastInst>(U)) {
991 // Must be bitcast between the malloc and store to initialize the global.
992 ReplaceUsesOfMallocWithGlobal(U, GV);
993 U->eraseFromParent();
994 continue;
995 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
996 // If this is a "GEP bitcast" and the user is a store to the global, then
997 // just process it as a bitcast.
998 if (GEPI->hasAllZeroIndices() && GEPI->hasOneUse())
999 if (StoreInst *SI = dyn_cast<StoreInst>(GEPI->use_back()))
1000 if (SI->getOperand(1) == GV) {
1001 // Must be bitcast GEP between the malloc and store to initialize
1002 // the global.
1003 ReplaceUsesOfMallocWithGlobal(GEPI, GV);
1004 GEPI->eraseFromParent();
1005 continue;
1006 }
Chris Lattner86395032006-09-30 23:32:09 +00001007 }
Chris Lattner101f44e2008-12-15 21:44:34 +00001008
Chris Lattner86395032006-09-30 23:32:09 +00001009 // Insert a load from the global, and use it instead of the malloc.
Chris Lattnera637a8b2007-09-13 18:00:31 +00001010 Value *NL = new LoadInst(GV, GV->getName()+".val", InsertPt);
Chris Lattner86395032006-09-30 23:32:09 +00001011 U->replaceUsesOfWith(Alloc, NL);
1012 }
1013}
1014
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001015/// LoadUsesSimpleEnoughForHeapSRA - Verify that all uses of V (a load, or a phi
1016/// of a load) are simple enough to perform heap SRA on. This permits GEP's
1017/// that index through the array and struct field, icmps of null, and PHIs.
1018static bool LoadUsesSimpleEnoughForHeapSRA(Value *V, MallocInst *MI,
1019 SmallPtrSet<PHINode*, 32> &AnalyzedLoadUsingPHIs) {
1020 // We permit two users of the load: setcc comparing against the null
1021 // pointer, and a getelementptr of a specific form.
1022 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
1023 Instruction *User = cast<Instruction>(*UI);
1024
1025 // Comparison against null is ok.
1026 if (ICmpInst *ICI = dyn_cast<ICmpInst>(User)) {
1027 if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
1028 return false;
1029 continue;
1030 }
1031
1032 // getelementptr is also ok, but only a simple form.
1033 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
1034 // Must index into the array and into the struct.
1035 if (GEPI->getNumOperands() < 3)
1036 return false;
1037
1038 // Otherwise the GEP is ok.
1039 continue;
1040 }
1041
1042 if (PHINode *PN = dyn_cast<PHINode>(User)) {
1043 // If we have already recursively analyzed this PHI, then it is safe.
1044 if (AnalyzedLoadUsingPHIs.insert(PN))
1045 continue;
1046
1047 // We have a phi of a load from the global. We can only handle this
1048 // if the other PHI'd values are actually the same. In this case,
1049 // the rewriter will just drop the phi entirely.
1050 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1051 Value *IV = PN->getIncomingValue(i);
1052 if (IV == V) continue; // Trivial the same.
Chris Lattner86395032006-09-30 23:32:09 +00001053
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001054 // If the phi'd value is from the malloc that initializes the value,
1055 // we can xform it.
1056 if (IV == MI) continue;
Chris Lattner86395032006-09-30 23:32:09 +00001057
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001058 // Otherwise, we don't know what it is.
Chris Lattner309f20f2007-09-13 21:31:36 +00001059 return false;
Chris Lattner86395032006-09-30 23:32:09 +00001060 }
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001061
1062 if (!LoadUsesSimpleEnoughForHeapSRA(PN, MI, AnalyzedLoadUsingPHIs))
1063 return false;
1064
1065 continue;
Chris Lattner86395032006-09-30 23:32:09 +00001066 }
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001067
1068 // Otherwise we don't know what this is, not ok.
1069 return false;
1070 }
1071
1072 return true;
1073}
1074
1075
1076/// AllGlobalLoadUsesSimpleEnoughForHeapSRA - If all users of values loaded from
1077/// GV are simple enough to perform HeapSRA, return true.
1078static bool AllGlobalLoadUsesSimpleEnoughForHeapSRA(GlobalVariable *GV,
1079 MallocInst *MI) {
1080 SmallPtrSet<PHINode*, 32> AnalyzedLoadUsingPHIs;
1081 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI != E;
1082 ++UI)
1083 if (LoadInst *LI = dyn_cast<LoadInst>(*UI))
1084 if (!LoadUsesSimpleEnoughForHeapSRA(LI, MI, AnalyzedLoadUsingPHIs))
1085 return false;
Chris Lattner86395032006-09-30 23:32:09 +00001086 return true;
1087}
1088
Chris Lattnera637a8b2007-09-13 18:00:31 +00001089/// GetHeapSROALoad - Return the load for the specified field of the HeapSROA'd
1090/// value, lazily creating it on demand.
Chris Lattner309f20f2007-09-13 21:31:36 +00001091static Value *GetHeapSROALoad(Instruction *Load, unsigned FieldNo,
Chris Lattnera637a8b2007-09-13 18:00:31 +00001092 const std::vector<GlobalVariable*> &FieldGlobals,
1093 std::vector<Value *> &InsertedLoadsForPtr) {
1094 if (InsertedLoadsForPtr.size() <= FieldNo)
1095 InsertedLoadsForPtr.resize(FieldNo+1);
1096 if (InsertedLoadsForPtr[FieldNo] == 0)
1097 InsertedLoadsForPtr[FieldNo] = new LoadInst(FieldGlobals[FieldNo],
1098 Load->getName()+".f" +
1099 utostr(FieldNo), Load);
1100 return InsertedLoadsForPtr[FieldNo];
1101}
1102
Chris Lattner330245e2007-09-13 17:29:05 +00001103/// RewriteHeapSROALoadUser - Given a load instruction and a value derived from
1104/// the load, rewrite the derived value to use the HeapSRoA'd load.
1105static void RewriteHeapSROALoadUser(LoadInst *Load, Instruction *LoadUser,
1106 const std::vector<GlobalVariable*> &FieldGlobals,
1107 std::vector<Value *> &InsertedLoadsForPtr) {
1108 // If this is a comparison against null, handle it.
1109 if (ICmpInst *SCI = dyn_cast<ICmpInst>(LoadUser)) {
1110 assert(isa<ConstantPointerNull>(SCI->getOperand(1)));
1111 // If we have a setcc of the loaded pointer, we can use a setcc of any
1112 // field.
1113 Value *NPtr;
1114 if (InsertedLoadsForPtr.empty()) {
Chris Lattnera637a8b2007-09-13 18:00:31 +00001115 NPtr = GetHeapSROALoad(Load, 0, FieldGlobals, InsertedLoadsForPtr);
Chris Lattner330245e2007-09-13 17:29:05 +00001116 } else {
1117 NPtr = InsertedLoadsForPtr.back();
1118 }
1119
1120 Value *New = new ICmpInst(SCI->getPredicate(), NPtr,
1121 Constant::getNullValue(NPtr->getType()),
1122 SCI->getName(), SCI);
1123 SCI->replaceAllUsesWith(New);
1124 SCI->eraseFromParent();
1125 return;
1126 }
1127
Chris Lattnera637a8b2007-09-13 18:00:31 +00001128 // Handle 'getelementptr Ptr, Idx, uint FieldNo ...'
1129 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(LoadUser)) {
1130 assert(GEPI->getNumOperands() >= 3 && isa<ConstantInt>(GEPI->getOperand(2))
1131 && "Unexpected GEPI!");
Chris Lattner330245e2007-09-13 17:29:05 +00001132
Chris Lattnera637a8b2007-09-13 18:00:31 +00001133 // Load the pointer for this field.
1134 unsigned FieldNo = cast<ConstantInt>(GEPI->getOperand(2))->getZExtValue();
1135 Value *NewPtr = GetHeapSROALoad(Load, FieldNo,
1136 FieldGlobals, InsertedLoadsForPtr);
1137
1138 // Create the new GEP idx vector.
1139 SmallVector<Value*, 8> GEPIdx;
1140 GEPIdx.push_back(GEPI->getOperand(1));
1141 GEPIdx.append(GEPI->op_begin()+3, GEPI->op_end());
1142
Gabor Greifb1dbcd82008-05-15 10:04:30 +00001143 Value *NGEPI = GetElementPtrInst::Create(NewPtr,
1144 GEPIdx.begin(), GEPIdx.end(),
Gabor Greif051a9502008-04-06 20:25:17 +00001145 GEPI->getName(), GEPI);
Chris Lattnera637a8b2007-09-13 18:00:31 +00001146 GEPI->replaceAllUsesWith(NGEPI);
1147 GEPI->eraseFromParent();
1148 return;
1149 }
Chris Lattner330245e2007-09-13 17:29:05 +00001150
Chris Lattner309f20f2007-09-13 21:31:36 +00001151 // Handle PHI nodes. PHI nodes must be merging in the same values, plus
1152 // potentially the original malloc. Insert phi nodes for each field, then
1153 // process uses of the PHI.
Chris Lattnera637a8b2007-09-13 18:00:31 +00001154 PHINode *PN = cast<PHINode>(LoadUser);
Chris Lattner309f20f2007-09-13 21:31:36 +00001155 std::vector<Value *> PHIsForField;
1156 PHIsForField.resize(FieldGlobals.size());
1157 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1158 Value *LoadV = GetHeapSROALoad(Load, i, FieldGlobals, InsertedLoadsForPtr);
1159
Gabor Greif051a9502008-04-06 20:25:17 +00001160 PHINode *FieldPN = PHINode::Create(LoadV->getType(),
1161 PN->getName()+"."+utostr(i), PN);
Chris Lattner309f20f2007-09-13 21:31:36 +00001162 // Fill in the predecessor values.
1163 for (unsigned pred = 0, e = PN->getNumIncomingValues(); pred != e; ++pred) {
1164 // Each predecessor either uses the load or the original malloc.
1165 Value *InVal = PN->getIncomingValue(pred);
1166 BasicBlock *BB = PN->getIncomingBlock(pred);
1167 Value *NewVal;
1168 if (isa<MallocInst>(InVal)) {
1169 // Insert a reload from the global in the predecessor.
1170 NewVal = GetHeapSROALoad(BB->getTerminator(), i, FieldGlobals,
1171 PHIsForField);
1172 } else {
1173 NewVal = InsertedLoadsForPtr[i];
1174 }
1175 FieldPN->addIncoming(NewVal, BB);
1176 }
1177 PHIsForField[i] = FieldPN;
1178 }
1179
1180 // Since PHIsForField specifies a phi for every input value, the lazy inserter
1181 // will never insert a load.
Chris Lattnera637a8b2007-09-13 18:00:31 +00001182 while (!PN->use_empty())
Chris Lattner309f20f2007-09-13 21:31:36 +00001183 RewriteHeapSROALoadUser(Load, PN->use_back(), FieldGlobals, PHIsForField);
Chris Lattnera637a8b2007-09-13 18:00:31 +00001184 PN->eraseFromParent();
Chris Lattner330245e2007-09-13 17:29:05 +00001185}
1186
Chris Lattner86395032006-09-30 23:32:09 +00001187/// RewriteUsesOfLoadForHeapSRoA - We are performing Heap SRoA on a global. Ptr
1188/// is a value loaded from the global. Eliminate all uses of Ptr, making them
1189/// use FieldGlobals instead. All uses of loaded values satisfy
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001190/// AllGlobalLoadUsesSimpleEnoughForHeapSRA.
Chris Lattner330245e2007-09-13 17:29:05 +00001191static void RewriteUsesOfLoadForHeapSRoA(LoadInst *Load,
Chris Lattner86395032006-09-30 23:32:09 +00001192 const std::vector<GlobalVariable*> &FieldGlobals) {
1193 std::vector<Value *> InsertedLoadsForPtr;
1194 //InsertedLoadsForPtr.resize(FieldGlobals.size());
Chris Lattner330245e2007-09-13 17:29:05 +00001195 while (!Load->use_empty())
1196 RewriteHeapSROALoadUser(Load, Load->use_back(),
1197 FieldGlobals, InsertedLoadsForPtr);
Chris Lattner86395032006-09-30 23:32:09 +00001198}
1199
1200/// PerformHeapAllocSRoA - MI is an allocation of an array of structures. Break
1201/// it up into multiple allocations of arrays of the fields.
1202static GlobalVariable *PerformHeapAllocSRoA(GlobalVariable *GV, MallocInst *MI){
Bill Wendling0a81aac2006-11-26 10:02:32 +00001203 DOUT << "SROA HEAP ALLOC: " << *GV << " MALLOC = " << *MI;
Chris Lattner86395032006-09-30 23:32:09 +00001204 const StructType *STy = cast<StructType>(MI->getAllocatedType());
1205
1206 // There is guaranteed to be at least one use of the malloc (storing
1207 // it into GV). If there are other uses, change them to be uses of
1208 // the global to simplify later code. This also deletes the store
1209 // into GV.
1210 ReplaceUsesOfMallocWithGlobal(MI, GV);
1211
1212 // Okay, at this point, there are no users of the malloc. Insert N
1213 // new mallocs at the same place as MI, and N globals.
1214 std::vector<GlobalVariable*> FieldGlobals;
1215 std::vector<MallocInst*> FieldMallocs;
1216
1217 for (unsigned FieldNo = 0, e = STy->getNumElements(); FieldNo != e;++FieldNo){
1218 const Type *FieldTy = STy->getElementType(FieldNo);
Christopher Lamb43ad6b32007-12-17 01:12:55 +00001219 const Type *PFieldTy = PointerType::getUnqual(FieldTy);
Chris Lattner86395032006-09-30 23:32:09 +00001220
1221 GlobalVariable *NGV =
1222 new GlobalVariable(PFieldTy, false, GlobalValue::InternalLinkage,
1223 Constant::getNullValue(PFieldTy),
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00001224 GV->getName() + ".f" + utostr(FieldNo), GV,
1225 GV->isThreadLocal());
Chris Lattner86395032006-09-30 23:32:09 +00001226 FieldGlobals.push_back(NGV);
1227
1228 MallocInst *NMI = new MallocInst(FieldTy, MI->getArraySize(),
1229 MI->getName() + ".f" + utostr(FieldNo),MI);
1230 FieldMallocs.push_back(NMI);
1231 new StoreInst(NMI, NGV, MI);
1232 }
1233
1234 // The tricky aspect of this transformation is handling the case when malloc
1235 // fails. In the original code, malloc failing would set the result pointer
1236 // of malloc to null. In this case, some mallocs could succeed and others
1237 // could fail. As such, we emit code that looks like this:
1238 // F0 = malloc(field0)
1239 // F1 = malloc(field1)
1240 // F2 = malloc(field2)
1241 // if (F0 == 0 || F1 == 0 || F2 == 0) {
1242 // if (F0) { free(F0); F0 = 0; }
1243 // if (F1) { free(F1); F1 = 0; }
1244 // if (F2) { free(F2); F2 = 0; }
1245 // }
1246 Value *RunningOr = 0;
1247 for (unsigned i = 0, e = FieldMallocs.size(); i != e; ++i) {
Reid Spencere4d87aa2006-12-23 06:05:41 +00001248 Value *Cond = new ICmpInst(ICmpInst::ICMP_EQ, FieldMallocs[i],
Chris Lattner86395032006-09-30 23:32:09 +00001249 Constant::getNullValue(FieldMallocs[i]->getType()),
1250 "isnull", MI);
1251 if (!RunningOr)
1252 RunningOr = Cond; // First seteq
1253 else
Gabor Greif7cbd8a32008-05-16 19:29:10 +00001254 RunningOr = BinaryOperator::CreateOr(RunningOr, Cond, "tmp", MI);
Chris Lattner86395032006-09-30 23:32:09 +00001255 }
1256
1257 // Split the basic block at the old malloc.
1258 BasicBlock *OrigBB = MI->getParent();
1259 BasicBlock *ContBB = OrigBB->splitBasicBlock(MI, "malloc_cont");
1260
1261 // Create the block to check the first condition. Put all these blocks at the
1262 // end of the function as they are unlikely to be executed.
Gabor Greif051a9502008-04-06 20:25:17 +00001263 BasicBlock *NullPtrBlock = BasicBlock::Create("malloc_ret_null",
1264 OrigBB->getParent());
Chris Lattner86395032006-09-30 23:32:09 +00001265
1266 // Remove the uncond branch from OrigBB to ContBB, turning it into a cond
1267 // branch on RunningOr.
1268 OrigBB->getTerminator()->eraseFromParent();
Gabor Greif051a9502008-04-06 20:25:17 +00001269 BranchInst::Create(NullPtrBlock, ContBB, RunningOr, OrigBB);
Chris Lattner86395032006-09-30 23:32:09 +00001270
1271 // Within the NullPtrBlock, we need to emit a comparison and branch for each
1272 // pointer, because some may be null while others are not.
1273 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1274 Value *GVVal = new LoadInst(FieldGlobals[i], "tmp", NullPtrBlock);
Reid Spencere4d87aa2006-12-23 06:05:41 +00001275 Value *Cmp = new ICmpInst(ICmpInst::ICMP_NE, GVVal,
1276 Constant::getNullValue(GVVal->getType()),
1277 "tmp", NullPtrBlock);
Gabor Greif051a9502008-04-06 20:25:17 +00001278 BasicBlock *FreeBlock = BasicBlock::Create("free_it", OrigBB->getParent());
1279 BasicBlock *NextBlock = BasicBlock::Create("next", OrigBB->getParent());
1280 BranchInst::Create(FreeBlock, NextBlock, Cmp, NullPtrBlock);
Chris Lattner86395032006-09-30 23:32:09 +00001281
1282 // Fill in FreeBlock.
1283 new FreeInst(GVVal, FreeBlock);
1284 new StoreInst(Constant::getNullValue(GVVal->getType()), FieldGlobals[i],
1285 FreeBlock);
Gabor Greif051a9502008-04-06 20:25:17 +00001286 BranchInst::Create(NextBlock, FreeBlock);
Chris Lattner86395032006-09-30 23:32:09 +00001287
1288 NullPtrBlock = NextBlock;
1289 }
1290
Gabor Greif051a9502008-04-06 20:25:17 +00001291 BranchInst::Create(ContBB, NullPtrBlock);
Chris Lattner86395032006-09-30 23:32:09 +00001292
1293 // MI is no longer needed, remove it.
1294 MI->eraseFromParent();
1295
1296
1297 // Okay, the malloc site is completely handled. All of the uses of GV are now
1298 // loads, and all uses of those loads are simple. Rewrite them to use loads
1299 // of the per-field globals instead.
1300 while (!GV->use_empty()) {
Chris Lattner39ff1e22007-01-09 23:29:37 +00001301 if (LoadInst *LI = dyn_cast<LoadInst>(GV->use_back())) {
1302 RewriteUsesOfLoadForHeapSRoA(LI, FieldGlobals);
1303 LI->eraseFromParent();
1304 } else {
1305 // Must be a store of null.
1306 StoreInst *SI = cast<StoreInst>(GV->use_back());
1307 assert(isa<Constant>(SI->getOperand(0)) &&
1308 cast<Constant>(SI->getOperand(0))->isNullValue() &&
1309 "Unexpected heap-sra user!");
1310
1311 // Insert a store of null into each global.
1312 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1313 Constant *Null =
1314 Constant::getNullValue(FieldGlobals[i]->getType()->getElementType());
1315 new StoreInst(Null, FieldGlobals[i], SI);
1316 }
1317 // Erase the original store.
1318 SI->eraseFromParent();
1319 }
Chris Lattner86395032006-09-30 23:32:09 +00001320 }
1321
1322 // The old global is now dead, remove it.
1323 GV->eraseFromParent();
1324
1325 ++NumHeapSRA;
1326 return FieldGlobals[0];
1327}
1328
Chris Lattnere61d0a62008-12-15 21:02:25 +00001329/// TryToOptimizeStoreOfMallocToGlobal - This function is called when we see a
1330/// pointer global variable with a single value stored it that is a malloc or
1331/// cast of malloc.
1332static bool TryToOptimizeStoreOfMallocToGlobal(GlobalVariable *GV,
1333 MallocInst *MI,
1334 Module::global_iterator &GVI,
1335 TargetData &TD) {
1336 // If this is a malloc of an abstract type, don't touch it.
1337 if (!MI->getAllocatedType()->isSized())
1338 return false;
1339
1340 // We can't optimize this global unless all uses of it are *known* to be
1341 // of the malloc value, not of the null initializer value (consider a use
1342 // that compares the global's value against zero to see if the malloc has
1343 // been reached). To do this, we check to see if all uses of the global
1344 // would trap if the global were null: this proves that they must all
1345 // happen after the malloc.
1346 if (!AllUsesOfLoadedValueWillTrapIfNull(GV))
1347 return false;
1348
1349 // We can't optimize this if the malloc itself is used in a complex way,
1350 // for example, being stored into multiple globals. This allows the
1351 // malloc to be stored into the specified global, loaded setcc'd, and
1352 // GEP'd. These are all things we could transform to using the global
1353 // for.
1354 {
1355 SmallPtrSet<PHINode*, 8> PHIs;
1356 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(MI, GV, PHIs))
1357 return false;
1358 }
1359
1360
1361 // If we have a global that is only initialized with a fixed size malloc,
1362 // transform the program to use global memory instead of malloc'd memory.
1363 // This eliminates dynamic allocation, avoids an indirection accessing the
1364 // data, and exposes the resultant global to further GlobalOpt.
1365 if (ConstantInt *NElements = dyn_cast<ConstantInt>(MI->getArraySize())) {
1366 // Restrict this transformation to only working on small allocations
1367 // (2048 bytes currently), as we don't want to introduce a 16M global or
1368 // something.
1369 if (NElements->getZExtValue()*
1370 TD.getABITypeSize(MI->getAllocatedType()) < 2048) {
1371 GVI = OptimizeGlobalAddressOfMalloc(GV, MI);
1372 return true;
1373 }
1374 }
1375
1376 // If the allocation is an array of structures, consider transforming this
1377 // into multiple malloc'd arrays, one for each field. This is basically
1378 // SRoA for malloc'd memory.
Chris Lattner101f44e2008-12-15 21:44:34 +00001379 const Type *AllocTy = MI->getAllocatedType();
1380
1381 // If this is an allocation of a fixed size array of structs, analyze as a
1382 // variable size array. malloc [100 x struct],1 -> malloc struct, 100
1383 if (!MI->isArrayAllocation())
1384 if (const ArrayType *AT = dyn_cast<ArrayType>(AllocTy))
1385 AllocTy = AT->getElementType();
1386
1387 if (const StructType *AllocSTy = dyn_cast<StructType>(AllocTy)) {
Chris Lattnere61d0a62008-12-15 21:02:25 +00001388 // This the structure has an unreasonable number of fields, leave it
1389 // alone.
Chris Lattner101f44e2008-12-15 21:44:34 +00001390 if (AllocSTy->getNumElements() <= 16 && AllocSTy->getNumElements() != 0 &&
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001391 AllGlobalLoadUsesSimpleEnoughForHeapSRA(GV, MI)) {
Chris Lattner101f44e2008-12-15 21:44:34 +00001392
1393 // If this is a fixed size array, transform the Malloc to be an alloc of
1394 // structs. malloc [100 x struct],1 -> malloc struct, 100
1395 if (const ArrayType *AT = dyn_cast<ArrayType>(MI->getAllocatedType())) {
1396 MallocInst *NewMI =
1397 new MallocInst(AllocSTy,
1398 ConstantInt::get(Type::Int32Ty, AT->getNumElements()),
1399 "", MI);
1400 NewMI->takeName(MI);
1401 Value *Cast = new BitCastInst(NewMI, MI->getType(), "tmp", MI);
1402 MI->replaceAllUsesWith(Cast);
1403 MI->eraseFromParent();
1404 MI = NewMI;
1405 }
1406
Chris Lattnere61d0a62008-12-15 21:02:25 +00001407 GVI = PerformHeapAllocSRoA(GV, MI);
1408 return true;
1409 }
1410 }
1411
1412 return false;
1413}
Chris Lattner86395032006-09-30 23:32:09 +00001414
Chris Lattner9b34a612004-10-09 21:48:45 +00001415// OptimizeOnceStoredGlobal - Try to optimize globals based on the knowledge
1416// that only one value (besides its initializer) is ever stored to the global.
Chris Lattner30ba5692004-10-11 05:54:41 +00001417static bool OptimizeOnceStoredGlobal(GlobalVariable *GV, Value *StoredOnceVal,
Chris Lattner7f8897f2006-08-27 22:42:52 +00001418 Module::global_iterator &GVI,
1419 TargetData &TD) {
Chris Lattner344b41c2008-12-15 21:20:32 +00001420 // Ignore no-op GEPs and bitcasts.
1421 StoredOnceVal = StoredOnceVal->stripPointerCasts();
Chris Lattner9b34a612004-10-09 21:48:45 +00001422
Chris Lattner708148e2004-10-10 23:14:11 +00001423 // If we are dealing with a pointer global that is initialized to null and
1424 // only has one (non-null) value stored into it, then we can optimize any
1425 // users of the loaded value (often calls and loads) that would trap if the
1426 // value was null.
Chris Lattner9b34a612004-10-09 21:48:45 +00001427 if (isa<PointerType>(GV->getInitializer()->getType()) &&
1428 GV->getInitializer()->isNullValue()) {
Chris Lattner708148e2004-10-10 23:14:11 +00001429 if (Constant *SOVC = dyn_cast<Constant>(StoredOnceVal)) {
1430 if (GV->getInitializer()->getType() != SOVC->getType())
Reid Spencerd977d862006-12-12 23:36:14 +00001431 SOVC = ConstantExpr::getBitCast(SOVC, GV->getInitializer()->getType());
Misha Brukmanfd939082005-04-21 23:48:37 +00001432
Chris Lattner708148e2004-10-10 23:14:11 +00001433 // Optimize away any trapping uses of the loaded value.
1434 if (OptimizeAwayTrappingUsesOfLoads(GV, SOVC))
Chris Lattner8be80122004-10-10 17:07:12 +00001435 return true;
Chris Lattner30ba5692004-10-11 05:54:41 +00001436 } else if (MallocInst *MI = dyn_cast<MallocInst>(StoredOnceVal)) {
Chris Lattnere61d0a62008-12-15 21:02:25 +00001437 if (TryToOptimizeStoreOfMallocToGlobal(GV, MI, GVI, TD))
1438 return true;
Chris Lattner708148e2004-10-10 23:14:11 +00001439 }
Chris Lattner9b34a612004-10-09 21:48:45 +00001440 }
Chris Lattner30ba5692004-10-11 05:54:41 +00001441
Chris Lattner9b34a612004-10-09 21:48:45 +00001442 return false;
1443}
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001444
Chris Lattner58e44f42008-01-14 01:17:44 +00001445/// TryToShrinkGlobalToBoolean - At this point, we have learned that the only
1446/// two values ever stored into GV are its initializer and OtherVal. See if we
1447/// can shrink the global into a boolean and select between the two values
1448/// whenever it is used. This exposes the values to other scalar optimizations.
1449static bool TryToShrinkGlobalToBoolean(GlobalVariable *GV, Constant *OtherVal) {
1450 const Type *GVElType = GV->getType()->getElementType();
1451
1452 // If GVElType is already i1, it is already shrunk. If the type of the GV is
1453 // an FP value or vector, don't do this optimization because a select between
1454 // them is very expensive and unlikely to lead to later simplification.
1455 if (GVElType == Type::Int1Ty || GVElType->isFloatingPoint() ||
1456 isa<VectorType>(GVElType))
1457 return false;
1458
1459 // Walk the use list of the global seeing if all the uses are load or store.
1460 // If there is anything else, bail out.
1461 for (Value::use_iterator I = GV->use_begin(), E = GV->use_end(); I != E; ++I)
1462 if (!isa<LoadInst>(I) && !isa<StoreInst>(I))
1463 return false;
1464
1465 DOUT << " *** SHRINKING TO BOOL: " << *GV;
1466
Chris Lattner96a86b22004-12-12 05:53:50 +00001467 // Create the new global, initializing it to false.
Reid Spencer4fe16d62007-01-11 18:21:29 +00001468 GlobalVariable *NewGV = new GlobalVariable(Type::Int1Ty, false,
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00001469 GlobalValue::InternalLinkage, ConstantInt::getFalse(),
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00001470 GV->getName()+".b",
1471 (Module *)NULL,
1472 GV->isThreadLocal());
Chris Lattner96a86b22004-12-12 05:53:50 +00001473 GV->getParent()->getGlobalList().insert(GV, NewGV);
1474
1475 Constant *InitVal = GV->getInitializer();
Reid Spencer4fe16d62007-01-11 18:21:29 +00001476 assert(InitVal->getType() != Type::Int1Ty && "No reason to shrink to bool!");
Chris Lattner96a86b22004-12-12 05:53:50 +00001477
1478 // If initialized to zero and storing one into the global, we can use a cast
1479 // instead of a select to synthesize the desired value.
1480 bool IsOneZero = false;
1481 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal))
Reid Spencercae57542007-03-02 00:28:52 +00001482 IsOneZero = InitVal->isNullValue() && CI->isOne();
Chris Lattner96a86b22004-12-12 05:53:50 +00001483
1484 while (!GV->use_empty()) {
1485 Instruction *UI = cast<Instruction>(GV->use_back());
1486 if (StoreInst *SI = dyn_cast<StoreInst>(UI)) {
1487 // Change the store into a boolean store.
1488 bool StoringOther = SI->getOperand(0) == OtherVal;
1489 // Only do this if we weren't storing a loaded value.
Chris Lattner38c25562004-12-12 19:34:41 +00001490 Value *StoreVal;
Chris Lattner96a86b22004-12-12 05:53:50 +00001491 if (StoringOther || SI->getOperand(0) == InitVal)
Reid Spencer579dca12007-01-12 04:24:46 +00001492 StoreVal = ConstantInt::get(Type::Int1Ty, StoringOther);
Chris Lattner38c25562004-12-12 19:34:41 +00001493 else {
1494 // Otherwise, we are storing a previously loaded copy. To do this,
1495 // change the copy from copying the original value to just copying the
1496 // bool.
1497 Instruction *StoredVal = cast<Instruction>(SI->getOperand(0));
1498
1499 // If we're already replaced the input, StoredVal will be a cast or
1500 // select instruction. If not, it will be a load of the original
1501 // global.
1502 if (LoadInst *LI = dyn_cast<LoadInst>(StoredVal)) {
1503 assert(LI->getOperand(0) == GV && "Not a copy!");
1504 // Insert a new load, to preserve the saved value.
1505 StoreVal = new LoadInst(NewGV, LI->getName()+".b", LI);
1506 } else {
1507 assert((isa<CastInst>(StoredVal) || isa<SelectInst>(StoredVal)) &&
1508 "This is not a form that we understand!");
1509 StoreVal = StoredVal->getOperand(0);
1510 assert(isa<LoadInst>(StoreVal) && "Not a load of NewGV!");
1511 }
1512 }
1513 new StoreInst(StoreVal, NewGV, SI);
Chris Lattner58e44f42008-01-14 01:17:44 +00001514 } else {
Chris Lattner96a86b22004-12-12 05:53:50 +00001515 // Change the load into a load of bool then a select.
1516 LoadInst *LI = cast<LoadInst>(UI);
Chris Lattner046800a2007-02-11 01:08:35 +00001517 LoadInst *NLI = new LoadInst(NewGV, LI->getName()+".b", LI);
Chris Lattner96a86b22004-12-12 05:53:50 +00001518 Value *NSI;
1519 if (IsOneZero)
Chris Lattner046800a2007-02-11 01:08:35 +00001520 NSI = new ZExtInst(NLI, LI->getType(), "", LI);
Misha Brukmanfd939082005-04-21 23:48:37 +00001521 else
Gabor Greif051a9502008-04-06 20:25:17 +00001522 NSI = SelectInst::Create(NLI, OtherVal, InitVal, "", LI);
Chris Lattner046800a2007-02-11 01:08:35 +00001523 NSI->takeName(LI);
Chris Lattner96a86b22004-12-12 05:53:50 +00001524 LI->replaceAllUsesWith(NSI);
1525 }
1526 UI->eraseFromParent();
1527 }
1528
1529 GV->eraseFromParent();
Chris Lattner58e44f42008-01-14 01:17:44 +00001530 return true;
Chris Lattner96a86b22004-12-12 05:53:50 +00001531}
1532
1533
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001534/// ProcessInternalGlobal - Analyze the specified global variable and optimize
1535/// it if possible. If we make a change, return true.
Chris Lattner30ba5692004-10-11 05:54:41 +00001536bool GlobalOpt::ProcessInternalGlobal(GlobalVariable *GV,
Chris Lattnere4d5c442005-03-15 04:54:21 +00001537 Module::global_iterator &GVI) {
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00001538 SmallPtrSet<PHINode*, 16> PHIUsers;
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001539 GlobalStatus GS;
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001540 GV->removeDeadConstantUsers();
1541
1542 if (GV->use_empty()) {
Bill Wendling0a81aac2006-11-26 10:02:32 +00001543 DOUT << "GLOBAL DEAD: " << *GV;
Chris Lattner7a7ed022004-10-16 18:09:00 +00001544 GV->eraseFromParent();
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001545 ++NumDeleted;
1546 return true;
1547 }
1548
1549 if (!AnalyzeGlobal(GV, GS, PHIUsers)) {
Chris Lattnercff16732006-09-30 19:40:30 +00001550#if 0
Bill Wendlinge8156192006-12-07 01:30:32 +00001551 cerr << "Global: " << *GV;
1552 cerr << " isLoaded = " << GS.isLoaded << "\n";
1553 cerr << " StoredType = ";
Chris Lattnercff16732006-09-30 19:40:30 +00001554 switch (GS.StoredType) {
Bill Wendlinge8156192006-12-07 01:30:32 +00001555 case GlobalStatus::NotStored: cerr << "NEVER STORED\n"; break;
1556 case GlobalStatus::isInitializerStored: cerr << "INIT STORED\n"; break;
1557 case GlobalStatus::isStoredOnce: cerr << "STORED ONCE\n"; break;
1558 case GlobalStatus::isStored: cerr << "stored\n"; break;
Chris Lattnercff16732006-09-30 19:40:30 +00001559 }
1560 if (GS.StoredType == GlobalStatus::isStoredOnce && GS.StoredOnceValue)
Bill Wendlinge8156192006-12-07 01:30:32 +00001561 cerr << " StoredOnceValue = " << *GS.StoredOnceValue << "\n";
Chris Lattnercff16732006-09-30 19:40:30 +00001562 if (GS.AccessingFunction && !GS.HasMultipleAccessingFunctions)
Bill Wendlinge8156192006-12-07 01:30:32 +00001563 cerr << " AccessingFunction = " << GS.AccessingFunction->getName()
Chris Lattnercff16732006-09-30 19:40:30 +00001564 << "\n";
Bill Wendlinge8156192006-12-07 01:30:32 +00001565 cerr << " HasMultipleAccessingFunctions = "
Chris Lattnercff16732006-09-30 19:40:30 +00001566 << GS.HasMultipleAccessingFunctions << "\n";
Bill Wendlinge8156192006-12-07 01:30:32 +00001567 cerr << " HasNonInstructionUser = " << GS.HasNonInstructionUser<<"\n";
Bill Wendlinge8156192006-12-07 01:30:32 +00001568 cerr << "\n";
Chris Lattnercff16732006-09-30 19:40:30 +00001569#endif
1570
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +00001571 // If this is a first class global and has only one accessing function
1572 // and this function is main (which we know is not recursive we can make
1573 // this global a local variable) we replace the global with a local alloca
1574 // in this function.
1575 //
Dan Gohman399101a2008-05-23 00:17:26 +00001576 // NOTE: It doesn't make sense to promote non single-value types since we
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +00001577 // are just replacing static memory to stack memory.
1578 if (!GS.HasMultipleAccessingFunctions &&
Chris Lattner553ca522005-06-15 21:11:48 +00001579 GS.AccessingFunction && !GS.HasNonInstructionUser &&
Dan Gohman399101a2008-05-23 00:17:26 +00001580 GV->getType()->getElementType()->isSingleValueType() &&
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +00001581 GS.AccessingFunction->getName() == "main" &&
1582 GS.AccessingFunction->hasExternalLinkage()) {
Bill Wendling0a81aac2006-11-26 10:02:32 +00001583 DOUT << "LOCALIZING GLOBAL: " << *GV;
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +00001584 Instruction* FirstI = GS.AccessingFunction->getEntryBlock().begin();
1585 const Type* ElemTy = GV->getType()->getElementType();
Nate Begeman14b05292005-11-05 09:21:28 +00001586 // FIXME: Pass Global's alignment when globals have alignment
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +00001587 AllocaInst* Alloca = new AllocaInst(ElemTy, NULL, GV->getName(), FirstI);
1588 if (!isa<UndefValue>(GV->getInitializer()))
1589 new StoreInst(GV->getInitializer(), Alloca, FirstI);
Misha Brukmanfd939082005-04-21 23:48:37 +00001590
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +00001591 GV->replaceAllUsesWith(Alloca);
1592 GV->eraseFromParent();
1593 ++NumLocalized;
1594 return true;
1595 }
Chris Lattnercff16732006-09-30 19:40:30 +00001596
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001597 // If the global is never loaded (but may be stored to), it is dead.
1598 // Delete it now.
1599 if (!GS.isLoaded) {
Bill Wendling0a81aac2006-11-26 10:02:32 +00001600 DOUT << "GLOBAL NEVER LOADED: " << *GV;
Chris Lattner930f4752004-10-09 03:32:52 +00001601
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001602 // Delete any stores we can find to the global. We may not be able to
1603 // make it completely dead though.
Chris Lattner031955d2004-10-10 16:43:46 +00001604 bool Changed = CleanupConstantGlobalUsers(GV, GV->getInitializer());
Chris Lattner930f4752004-10-09 03:32:52 +00001605
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001606 // If the global is dead now, delete it.
1607 if (GV->use_empty()) {
Chris Lattner7a7ed022004-10-16 18:09:00 +00001608 GV->eraseFromParent();
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001609 ++NumDeleted;
Chris Lattner930f4752004-10-09 03:32:52 +00001610 Changed = true;
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001611 }
Chris Lattner930f4752004-10-09 03:32:52 +00001612 return Changed;
Misha Brukmanfd939082005-04-21 23:48:37 +00001613
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001614 } else if (GS.StoredType <= GlobalStatus::isInitializerStored) {
Bill Wendling0a81aac2006-11-26 10:02:32 +00001615 DOUT << "MARKING CONSTANT: " << *GV;
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001616 GV->setConstant(true);
Misha Brukmanfd939082005-04-21 23:48:37 +00001617
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001618 // Clean up any obviously simplifiable users now.
1619 CleanupConstantGlobalUsers(GV, GV->getInitializer());
Misha Brukmanfd939082005-04-21 23:48:37 +00001620
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001621 // If the global is dead now, just nuke it.
1622 if (GV->use_empty()) {
Bill Wendling0a81aac2006-11-26 10:02:32 +00001623 DOUT << " *** Marking constant allowed us to simplify "
1624 << "all users and delete global!\n";
Chris Lattner7a7ed022004-10-16 18:09:00 +00001625 GV->eraseFromParent();
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001626 ++NumDeleted;
1627 }
Misha Brukmanfd939082005-04-21 23:48:37 +00001628
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001629 ++NumMarked;
1630 return true;
Dan Gohman399101a2008-05-23 00:17:26 +00001631 } else if (!GV->getInitializer()->getType()->isSingleValueType()) {
Chris Lattner998182b2008-04-26 07:40:11 +00001632 if (GlobalVariable *FirstNewGV = SRAGlobal(GV,
1633 getAnalysis<TargetData>())) {
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001634 GVI = FirstNewGV; // Don't skip the newly produced globals!
1635 return true;
1636 }
Chris Lattner9b34a612004-10-09 21:48:45 +00001637 } else if (GS.StoredType == GlobalStatus::isStoredOnce) {
Chris Lattner96a86b22004-12-12 05:53:50 +00001638 // If the initial value for the global was an undef value, and if only
1639 // one other value was stored into it, we can just change the
1640 // initializer to be an undef value, then delete all stores to the
1641 // global. This allows us to mark it constant.
1642 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1643 if (isa<UndefValue>(GV->getInitializer())) {
1644 // Change the initial value here.
1645 GV->setInitializer(SOVConstant);
Misha Brukmanfd939082005-04-21 23:48:37 +00001646
Chris Lattner96a86b22004-12-12 05:53:50 +00001647 // Clean up any obviously simplifiable users now.
1648 CleanupConstantGlobalUsers(GV, GV->getInitializer());
Misha Brukmanfd939082005-04-21 23:48:37 +00001649
Chris Lattner96a86b22004-12-12 05:53:50 +00001650 if (GV->use_empty()) {
Bill Wendling0a81aac2006-11-26 10:02:32 +00001651 DOUT << " *** Substituting initializer allowed us to "
1652 << "simplify all users and delete global!\n";
Chris Lattner96a86b22004-12-12 05:53:50 +00001653 GV->eraseFromParent();
1654 ++NumDeleted;
1655 } else {
1656 GVI = GV;
1657 }
1658 ++NumSubstitute;
1659 return true;
Chris Lattner7a7ed022004-10-16 18:09:00 +00001660 }
Chris Lattner7a7ed022004-10-16 18:09:00 +00001661
Chris Lattner9b34a612004-10-09 21:48:45 +00001662 // Try to optimize globals based on the knowledge that only one value
1663 // (besides its initializer) is ever stored to the global.
Chris Lattner30ba5692004-10-11 05:54:41 +00001664 if (OptimizeOnceStoredGlobal(GV, GS.StoredOnceValue, GVI,
1665 getAnalysis<TargetData>()))
Chris Lattner9b34a612004-10-09 21:48:45 +00001666 return true;
Chris Lattner96a86b22004-12-12 05:53:50 +00001667
1668 // Otherwise, if the global was not a boolean, we can shrink it to be a
1669 // boolean.
1670 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
Chris Lattner58e44f42008-01-14 01:17:44 +00001671 if (TryToShrinkGlobalToBoolean(GV, SOVConstant)) {
Chris Lattner96a86b22004-12-12 05:53:50 +00001672 ++NumShrunkToBool;
1673 return true;
1674 }
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001675 }
1676 }
1677 return false;
1678}
1679
Chris Lattnerfb217ad2005-05-08 22:18:06 +00001680/// OnlyCalledDirectly - Return true if the specified function is only called
1681/// directly. In other words, its address is never taken.
1682static bool OnlyCalledDirectly(Function *F) {
1683 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
1684 Instruction *User = dyn_cast<Instruction>(*UI);
1685 if (!User) return false;
1686 if (!isa<CallInst>(User) && !isa<InvokeInst>(User)) return false;
1687
1688 // See if the function address is passed as an argument.
Gabor Greif5e463212008-05-29 01:59:18 +00001689 for (User::op_iterator i = User->op_begin() + 1, e = User->op_end();
Bill Wendlingf9e67ac2008-08-12 23:15:44 +00001690 i != e; ++i)
Gabor Greif5e463212008-05-29 01:59:18 +00001691 if (*i == F) return false;
Chris Lattnerfb217ad2005-05-08 22:18:06 +00001692 }
1693 return true;
1694}
1695
1696/// ChangeCalleesToFastCall - Walk all of the direct calls of the specified
1697/// function, changing them to FastCC.
1698static void ChangeCalleesToFastCall(Function *F) {
1699 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
Duncan Sands548448a2008-02-18 17:32:13 +00001700 CallSite User(cast<Instruction>(*UI));
1701 User.setCallingConv(CallingConv::Fast);
Chris Lattnerfb217ad2005-05-08 22:18:06 +00001702 }
1703}
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001704
Devang Patel05988662008-09-25 21:00:45 +00001705static AttrListPtr StripNest(const AttrListPtr &Attrs) {
Chris Lattner58d74912008-03-12 17:45:29 +00001706 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Devang Patel05988662008-09-25 21:00:45 +00001707 if ((Attrs.getSlot(i).Attrs & Attribute::Nest) == 0)
Duncan Sands548448a2008-02-18 17:32:13 +00001708 continue;
1709
Duncan Sands548448a2008-02-18 17:32:13 +00001710 // There can be only one.
Devang Patel05988662008-09-25 21:00:45 +00001711 return Attrs.removeAttr(Attrs.getSlot(i).Index, Attribute::Nest);
Duncan Sands3d5378f2008-02-16 20:56:04 +00001712 }
1713
1714 return Attrs;
1715}
1716
1717static void RemoveNestAttribute(Function *F) {
Devang Patel05988662008-09-25 21:00:45 +00001718 F->setAttributes(StripNest(F->getAttributes()));
Duncan Sands3d5378f2008-02-16 20:56:04 +00001719 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
Duncan Sands548448a2008-02-18 17:32:13 +00001720 CallSite User(cast<Instruction>(*UI));
Devang Patel05988662008-09-25 21:00:45 +00001721 User.setAttributes(StripNest(User.getAttributes()));
Duncan Sands3d5378f2008-02-16 20:56:04 +00001722 }
1723}
1724
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001725bool GlobalOpt::OptimizeFunctions(Module &M) {
1726 bool Changed = false;
1727 // Optimize functions.
1728 for (Module::iterator FI = M.begin(), E = M.end(); FI != E; ) {
1729 Function *F = FI++;
1730 F->removeDeadConstantUsers();
1731 if (F->use_empty() && (F->hasInternalLinkage() ||
1732 F->hasLinkOnceLinkage())) {
1733 M.getFunctionList().erase(F);
1734 Changed = true;
1735 ++NumFnDeleted;
Duncan Sands3d5378f2008-02-16 20:56:04 +00001736 } else if (F->hasInternalLinkage()) {
1737 if (F->getCallingConv() == CallingConv::C && !F->isVarArg() &&
1738 OnlyCalledDirectly(F)) {
1739 // If this function has C calling conventions, is not a varargs
1740 // function, and is only called directly, promote it to use the Fast
1741 // calling convention.
1742 F->setCallingConv(CallingConv::Fast);
1743 ChangeCalleesToFastCall(F);
1744 ++NumFastCallFns;
1745 Changed = true;
1746 }
1747
Devang Patel05988662008-09-25 21:00:45 +00001748 if (F->getAttributes().hasAttrSomewhere(Attribute::Nest) &&
Duncan Sands3d5378f2008-02-16 20:56:04 +00001749 OnlyCalledDirectly(F)) {
1750 // The function is not used by a trampoline intrinsic, so it is safe
1751 // to remove the 'nest' attribute.
1752 RemoveNestAttribute(F);
1753 ++NumNestRemoved;
1754 Changed = true;
1755 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001756 }
1757 }
1758 return Changed;
1759}
1760
1761bool GlobalOpt::OptimizeGlobalVars(Module &M) {
1762 bool Changed = false;
1763 for (Module::global_iterator GVI = M.global_begin(), E = M.global_end();
1764 GVI != E; ) {
1765 GlobalVariable *GV = GVI++;
1766 if (!GV->isConstant() && GV->hasInternalLinkage() &&
1767 GV->hasInitializer())
1768 Changed |= ProcessInternalGlobal(GV, GVI);
1769 }
1770 return Changed;
1771}
1772
1773/// FindGlobalCtors - Find the llvm.globalctors list, verifying that all
1774/// initializers have an init priority of 65535.
1775GlobalVariable *GlobalOpt::FindGlobalCtors(Module &M) {
Alkis Evlogimenose9c6d362005-10-25 11:18:06 +00001776 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
1777 I != E; ++I)
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001778 if (I->getName() == "llvm.global_ctors") {
1779 // Found it, verify it's an array of { int, void()* }.
1780 const ArrayType *ATy =dyn_cast<ArrayType>(I->getType()->getElementType());
1781 if (!ATy) return 0;
1782 const StructType *STy = dyn_cast<StructType>(ATy->getElementType());
1783 if (!STy || STy->getNumElements() != 2 ||
Reid Spencerc5b206b2006-12-31 05:48:39 +00001784 STy->getElementType(0) != Type::Int32Ty) return 0;
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001785 const PointerType *PFTy = dyn_cast<PointerType>(STy->getElementType(1));
1786 if (!PFTy) return 0;
1787 const FunctionType *FTy = dyn_cast<FunctionType>(PFTy->getElementType());
1788 if (!FTy || FTy->getReturnType() != Type::VoidTy || FTy->isVarArg() ||
1789 FTy->getNumParams() != 0)
1790 return 0;
1791
1792 // Verify that the initializer is simple enough for us to handle.
1793 if (!I->hasInitializer()) return 0;
1794 ConstantArray *CA = dyn_cast<ConstantArray>(I->getInitializer());
1795 if (!CA) return 0;
Gabor Greif5e463212008-05-29 01:59:18 +00001796 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i)
1797 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(*i)) {
Chris Lattner7d8e58f2005-09-26 02:19:27 +00001798 if (isa<ConstantPointerNull>(CS->getOperand(1)))
1799 continue;
1800
1801 // Must have a function or null ptr.
1802 if (!isa<Function>(CS->getOperand(1)))
1803 return 0;
1804
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001805 // Init priority must be standard.
1806 ConstantInt *CI = dyn_cast<ConstantInt>(CS->getOperand(0));
Reid Spencerb83eb642006-10-20 07:07:24 +00001807 if (!CI || CI->getZExtValue() != 65535)
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001808 return 0;
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001809 } else {
1810 return 0;
1811 }
1812
1813 return I;
1814 }
1815 return 0;
1816}
1817
Chris Lattnerdb973e62005-09-26 02:31:18 +00001818/// ParseGlobalCtors - Given a llvm.global_ctors list that we can understand,
1819/// return a list of the functions and null terminator as a vector.
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001820static std::vector<Function*> ParseGlobalCtors(GlobalVariable *GV) {
1821 ConstantArray *CA = cast<ConstantArray>(GV->getInitializer());
1822 std::vector<Function*> Result;
1823 Result.reserve(CA->getNumOperands());
Gabor Greif5e463212008-05-29 01:59:18 +00001824 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i) {
1825 ConstantStruct *CS = cast<ConstantStruct>(*i);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001826 Result.push_back(dyn_cast<Function>(CS->getOperand(1)));
1827 }
1828 return Result;
1829}
1830
Chris Lattnerdb973e62005-09-26 02:31:18 +00001831/// InstallGlobalCtors - Given a specified llvm.global_ctors list, install the
1832/// specified array, returning the new global to use.
1833static GlobalVariable *InstallGlobalCtors(GlobalVariable *GCL,
1834 const std::vector<Function*> &Ctors) {
1835 // If we made a change, reassemble the initializer list.
1836 std::vector<Constant*> CSVals;
Reid Spencerc5b206b2006-12-31 05:48:39 +00001837 CSVals.push_back(ConstantInt::get(Type::Int32Ty, 65535));
Chris Lattnerdb973e62005-09-26 02:31:18 +00001838 CSVals.push_back(0);
1839
1840 // Create the new init list.
1841 std::vector<Constant*> CAList;
1842 for (unsigned i = 0, e = Ctors.size(); i != e; ++i) {
Chris Lattner79c11012005-09-26 04:44:35 +00001843 if (Ctors[i]) {
Chris Lattnerdb973e62005-09-26 02:31:18 +00001844 CSVals[1] = Ctors[i];
Chris Lattner79c11012005-09-26 04:44:35 +00001845 } else {
Chris Lattnerdb973e62005-09-26 02:31:18 +00001846 const Type *FTy = FunctionType::get(Type::VoidTy,
1847 std::vector<const Type*>(), false);
Christopher Lamb43ad6b32007-12-17 01:12:55 +00001848 const PointerType *PFTy = PointerType::getUnqual(FTy);
Chris Lattnerdb973e62005-09-26 02:31:18 +00001849 CSVals[1] = Constant::getNullValue(PFTy);
Reid Spencerc5b206b2006-12-31 05:48:39 +00001850 CSVals[0] = ConstantInt::get(Type::Int32Ty, 2147483647);
Chris Lattnerdb973e62005-09-26 02:31:18 +00001851 }
1852 CAList.push_back(ConstantStruct::get(CSVals));
1853 }
1854
1855 // Create the array initializer.
1856 const Type *StructTy =
1857 cast<ArrayType>(GCL->getType()->getElementType())->getElementType();
1858 Constant *CA = ConstantArray::get(ArrayType::get(StructTy, CAList.size()),
1859 CAList);
1860
1861 // If we didn't change the number of elements, don't create a new GV.
1862 if (CA->getType() == GCL->getInitializer()->getType()) {
1863 GCL->setInitializer(CA);
1864 return GCL;
1865 }
1866
1867 // Create the new global and insert it next to the existing list.
1868 GlobalVariable *NGV = new GlobalVariable(CA->getType(), GCL->isConstant(),
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00001869 GCL->getLinkage(), CA, "",
1870 (Module *)NULL,
1871 GCL->isThreadLocal());
Chris Lattnerdb973e62005-09-26 02:31:18 +00001872 GCL->getParent()->getGlobalList().insert(GCL, NGV);
Chris Lattner046800a2007-02-11 01:08:35 +00001873 NGV->takeName(GCL);
Chris Lattnerdb973e62005-09-26 02:31:18 +00001874
1875 // Nuke the old list, replacing any uses with the new one.
1876 if (!GCL->use_empty()) {
1877 Constant *V = NGV;
1878 if (V->getType() != GCL->getType())
Reid Spencerd977d862006-12-12 23:36:14 +00001879 V = ConstantExpr::getBitCast(V, GCL->getType());
Chris Lattnerdb973e62005-09-26 02:31:18 +00001880 GCL->replaceAllUsesWith(V);
1881 }
1882 GCL->eraseFromParent();
1883
1884 if (Ctors.size())
1885 return NGV;
1886 else
1887 return 0;
1888}
Chris Lattner79c11012005-09-26 04:44:35 +00001889
1890
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00001891static Constant *getVal(DenseMap<Value*, Constant*> &ComputedValues,
Chris Lattner79c11012005-09-26 04:44:35 +00001892 Value *V) {
1893 if (Constant *CV = dyn_cast<Constant>(V)) return CV;
1894 Constant *R = ComputedValues[V];
1895 assert(R && "Reference to an uncomputed value!");
1896 return R;
1897}
1898
1899/// isSimpleEnoughPointerToCommit - Return true if this constant is simple
1900/// enough for us to understand. In particular, if it is a cast of something,
1901/// we punt. We basically just support direct accesses to globals and GEP's of
1902/// globals. This should be kept up to date with CommitValueTo.
1903static bool isSimpleEnoughPointerToCommit(Constant *C) {
Chris Lattner231308c2005-09-27 04:50:03 +00001904 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C)) {
1905 if (!GV->hasExternalLinkage() && !GV->hasInternalLinkage())
Anton Korobeynikovb74ed072006-09-14 18:23:27 +00001906 return false; // do not allow weak/linkonce/dllimport/dllexport linkage.
Reid Spencer5cbf9852007-01-30 20:08:39 +00001907 return !GV->isDeclaration(); // reject external globals.
Chris Lattner231308c2005-09-27 04:50:03 +00001908 }
Chris Lattner798b4d52005-09-26 06:52:44 +00001909 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
1910 // Handle a constantexpr gep.
1911 if (CE->getOpcode() == Instruction::GetElementPtr &&
1912 isa<GlobalVariable>(CE->getOperand(0))) {
1913 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Chris Lattner231308c2005-09-27 04:50:03 +00001914 if (!GV->hasExternalLinkage() && !GV->hasInternalLinkage())
Anton Korobeynikovb74ed072006-09-14 18:23:27 +00001915 return false; // do not allow weak/linkonce/dllimport/dllexport linkage.
Chris Lattner798b4d52005-09-26 06:52:44 +00001916 return GV->hasInitializer() &&
1917 ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
1918 }
Chris Lattner79c11012005-09-26 04:44:35 +00001919 return false;
1920}
1921
Chris Lattner798b4d52005-09-26 06:52:44 +00001922/// EvaluateStoreInto - Evaluate a piece of a constantexpr store into a global
1923/// initializer. This returns 'Init' modified to reflect 'Val' stored into it.
1924/// At this point, the GEP operands of Addr [0, OpNo) have been stepped into.
1925static Constant *EvaluateStoreInto(Constant *Init, Constant *Val,
1926 ConstantExpr *Addr, unsigned OpNo) {
1927 // Base case of the recursion.
1928 if (OpNo == Addr->getNumOperands()) {
1929 assert(Val->getType() == Init->getType() && "Type mismatch!");
1930 return Val;
1931 }
1932
1933 if (const StructType *STy = dyn_cast<StructType>(Init->getType())) {
1934 std::vector<Constant*> Elts;
1935
1936 // Break up the constant into its elements.
1937 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Init)) {
Gabor Greif5e463212008-05-29 01:59:18 +00001938 for (User::op_iterator i = CS->op_begin(), e = CS->op_end(); i != e; ++i)
1939 Elts.push_back(cast<Constant>(*i));
Chris Lattner798b4d52005-09-26 06:52:44 +00001940 } else if (isa<ConstantAggregateZero>(Init)) {
1941 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
1942 Elts.push_back(Constant::getNullValue(STy->getElementType(i)));
1943 } else if (isa<UndefValue>(Init)) {
1944 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
1945 Elts.push_back(UndefValue::get(STy->getElementType(i)));
1946 } else {
1947 assert(0 && "This code is out of sync with "
1948 " ConstantFoldLoadThroughGEPConstantExpr");
1949 }
1950
1951 // Replace the element that we are supposed to.
Reid Spencerb83eb642006-10-20 07:07:24 +00001952 ConstantInt *CU = cast<ConstantInt>(Addr->getOperand(OpNo));
1953 unsigned Idx = CU->getZExtValue();
1954 assert(Idx < STy->getNumElements() && "Struct index out of range!");
Chris Lattner798b4d52005-09-26 06:52:44 +00001955 Elts[Idx] = EvaluateStoreInto(Elts[Idx], Val, Addr, OpNo+1);
1956
1957 // Return the modified struct.
Chris Lattnerf0a9aab2007-06-04 22:23:42 +00001958 return ConstantStruct::get(&Elts[0], Elts.size(), STy->isPacked());
Chris Lattner798b4d52005-09-26 06:52:44 +00001959 } else {
1960 ConstantInt *CI = cast<ConstantInt>(Addr->getOperand(OpNo));
1961 const ArrayType *ATy = cast<ArrayType>(Init->getType());
1962
1963 // Break up the array into elements.
1964 std::vector<Constant*> Elts;
1965 if (ConstantArray *CA = dyn_cast<ConstantArray>(Init)) {
Gabor Greif5e463212008-05-29 01:59:18 +00001966 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i)
1967 Elts.push_back(cast<Constant>(*i));
Chris Lattner798b4d52005-09-26 06:52:44 +00001968 } else if (isa<ConstantAggregateZero>(Init)) {
1969 Constant *Elt = Constant::getNullValue(ATy->getElementType());
1970 Elts.assign(ATy->getNumElements(), Elt);
1971 } else if (isa<UndefValue>(Init)) {
1972 Constant *Elt = UndefValue::get(ATy->getElementType());
1973 Elts.assign(ATy->getNumElements(), Elt);
1974 } else {
1975 assert(0 && "This code is out of sync with "
1976 " ConstantFoldLoadThroughGEPConstantExpr");
1977 }
1978
Reid Spencerb83eb642006-10-20 07:07:24 +00001979 assert(CI->getZExtValue() < ATy->getNumElements());
1980 Elts[CI->getZExtValue()] =
1981 EvaluateStoreInto(Elts[CI->getZExtValue()], Val, Addr, OpNo+1);
Chris Lattner798b4d52005-09-26 06:52:44 +00001982 return ConstantArray::get(ATy, Elts);
1983 }
1984}
1985
Chris Lattner79c11012005-09-26 04:44:35 +00001986/// CommitValueTo - We have decided that Addr (which satisfies the predicate
1987/// isSimpleEnoughPointerToCommit) should get Val as its value. Make it happen.
1988static void CommitValueTo(Constant *Val, Constant *Addr) {
Chris Lattner798b4d52005-09-26 06:52:44 +00001989 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Addr)) {
1990 assert(GV->hasInitializer());
1991 GV->setInitializer(Val);
1992 return;
1993 }
1994
1995 ConstantExpr *CE = cast<ConstantExpr>(Addr);
1996 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
1997
1998 Constant *Init = GV->getInitializer();
1999 Init = EvaluateStoreInto(Init, Val, CE, 2);
2000 GV->setInitializer(Init);
Chris Lattner79c11012005-09-26 04:44:35 +00002001}
2002
Chris Lattner562a0552005-09-26 05:16:34 +00002003/// ComputeLoadResult - Return the value that would be computed by a load from
2004/// P after the stores reflected by 'memory' have been performed. If we can't
2005/// decide, return null.
Chris Lattner04de1cf2005-09-26 05:15:37 +00002006static Constant *ComputeLoadResult(Constant *P,
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002007 const DenseMap<Constant*, Constant*> &Memory) {
Chris Lattner04de1cf2005-09-26 05:15:37 +00002008 // If this memory location has been recently stored, use the stored value: it
2009 // is the most up-to-date.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002010 DenseMap<Constant*, Constant*>::const_iterator I = Memory.find(P);
Chris Lattner04de1cf2005-09-26 05:15:37 +00002011 if (I != Memory.end()) return I->second;
2012
2013 // Access it.
2014 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(P)) {
2015 if (GV->hasInitializer())
2016 return GV->getInitializer();
2017 return 0;
Chris Lattner04de1cf2005-09-26 05:15:37 +00002018 }
Chris Lattner798b4d52005-09-26 06:52:44 +00002019
2020 // Handle a constantexpr getelementptr.
2021 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(P))
2022 if (CE->getOpcode() == Instruction::GetElementPtr &&
2023 isa<GlobalVariable>(CE->getOperand(0))) {
2024 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
2025 if (GV->hasInitializer())
2026 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
2027 }
2028
2029 return 0; // don't know how to evaluate.
Chris Lattner04de1cf2005-09-26 05:15:37 +00002030}
2031
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002032/// EvaluateFunction - Evaluate a call to function F, returning true if
2033/// successful, false if we can't evaluate it. ActualArgs contains the formal
2034/// arguments for the function.
Chris Lattnercd271422005-09-27 04:45:34 +00002035static bool EvaluateFunction(Function *F, Constant *&RetVal,
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002036 const std::vector<Constant*> &ActualArgs,
2037 std::vector<Function*> &CallStack,
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002038 DenseMap<Constant*, Constant*> &MutatedMemory,
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002039 std::vector<GlobalVariable*> &AllocaTmps) {
Chris Lattnercd271422005-09-27 04:45:34 +00002040 // Check to see if this function is already executing (recursion). If so,
2041 // bail out. TODO: we might want to accept limited recursion.
2042 if (std::find(CallStack.begin(), CallStack.end(), F) != CallStack.end())
2043 return false;
2044
2045 CallStack.push_back(F);
2046
Chris Lattner79c11012005-09-26 04:44:35 +00002047 /// Values - As we compute SSA register values, we store their contents here.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002048 DenseMap<Value*, Constant*> Values;
Chris Lattnercd271422005-09-27 04:45:34 +00002049
2050 // Initialize arguments to the incoming values specified.
2051 unsigned ArgNo = 0;
2052 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end(); AI != E;
2053 ++AI, ++ArgNo)
2054 Values[AI] = ActualArgs[ArgNo];
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002055
Chris Lattnercdf98be2005-09-26 04:57:38 +00002056 /// ExecutedBlocks - We only handle non-looping, non-recursive code. As such,
2057 /// we can only evaluate any one basic block at most once. This set keeps
2058 /// track of what we have executed so we can detect recursive cases etc.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002059 SmallPtrSet<BasicBlock*, 32> ExecutedBlocks;
Chris Lattnera22fdb02005-09-26 17:07:09 +00002060
Chris Lattner79c11012005-09-26 04:44:35 +00002061 // CurInst - The current instruction we're evaluating.
2062 BasicBlock::iterator CurInst = F->begin()->begin();
2063
2064 // This is the main evaluation loop.
2065 while (1) {
2066 Constant *InstResult = 0;
2067
2068 if (StoreInst *SI = dyn_cast<StoreInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002069 if (SI->isVolatile()) return false; // no volatile accesses.
Chris Lattner79c11012005-09-26 04:44:35 +00002070 Constant *Ptr = getVal(Values, SI->getOperand(1));
2071 if (!isSimpleEnoughPointerToCommit(Ptr))
2072 // If this is too complex for us to commit, reject it.
Chris Lattnercd271422005-09-27 04:45:34 +00002073 return false;
Chris Lattner79c11012005-09-26 04:44:35 +00002074 Constant *Val = getVal(Values, SI->getOperand(0));
2075 MutatedMemory[Ptr] = Val;
2076 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(CurInst)) {
2077 InstResult = ConstantExpr::get(BO->getOpcode(),
2078 getVal(Values, BO->getOperand(0)),
2079 getVal(Values, BO->getOperand(1)));
Reid Spencere4d87aa2006-12-23 06:05:41 +00002080 } else if (CmpInst *CI = dyn_cast<CmpInst>(CurInst)) {
2081 InstResult = ConstantExpr::getCompare(CI->getPredicate(),
2082 getVal(Values, CI->getOperand(0)),
2083 getVal(Values, CI->getOperand(1)));
Chris Lattner79c11012005-09-26 04:44:35 +00002084 } else if (CastInst *CI = dyn_cast<CastInst>(CurInst)) {
Chris Lattner9a989f02006-11-30 17:26:08 +00002085 InstResult = ConstantExpr::getCast(CI->getOpcode(),
2086 getVal(Values, CI->getOperand(0)),
Chris Lattner79c11012005-09-26 04:44:35 +00002087 CI->getType());
2088 } else if (SelectInst *SI = dyn_cast<SelectInst>(CurInst)) {
2089 InstResult = ConstantExpr::getSelect(getVal(Values, SI->getOperand(0)),
2090 getVal(Values, SI->getOperand(1)),
2091 getVal(Values, SI->getOperand(2)));
Chris Lattner04de1cf2005-09-26 05:15:37 +00002092 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(CurInst)) {
2093 Constant *P = getVal(Values, GEP->getOperand(0));
Chris Lattner55eb1c42007-01-31 04:40:53 +00002094 SmallVector<Constant*, 8> GEPOps;
Gabor Greif5e463212008-05-29 01:59:18 +00002095 for (User::op_iterator i = GEP->op_begin() + 1, e = GEP->op_end();
2096 i != e; ++i)
2097 GEPOps.push_back(getVal(Values, *i));
Chris Lattner55eb1c42007-01-31 04:40:53 +00002098 InstResult = ConstantExpr::getGetElementPtr(P, &GEPOps[0], GEPOps.size());
Chris Lattner04de1cf2005-09-26 05:15:37 +00002099 } else if (LoadInst *LI = dyn_cast<LoadInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002100 if (LI->isVolatile()) return false; // no volatile accesses.
Chris Lattner04de1cf2005-09-26 05:15:37 +00002101 InstResult = ComputeLoadResult(getVal(Values, LI->getOperand(0)),
2102 MutatedMemory);
Chris Lattnercd271422005-09-27 04:45:34 +00002103 if (InstResult == 0) return false; // Could not evaluate load.
Chris Lattnera22fdb02005-09-26 17:07:09 +00002104 } else if (AllocaInst *AI = dyn_cast<AllocaInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002105 if (AI->isArrayAllocation()) return false; // Cannot handle array allocs.
Chris Lattnera22fdb02005-09-26 17:07:09 +00002106 const Type *Ty = AI->getType()->getElementType();
2107 AllocaTmps.push_back(new GlobalVariable(Ty, false,
2108 GlobalValue::InternalLinkage,
2109 UndefValue::get(Ty),
2110 AI->getName()));
Chris Lattnercd271422005-09-27 04:45:34 +00002111 InstResult = AllocaTmps.back();
2112 } else if (CallInst *CI = dyn_cast<CallInst>(CurInst)) {
Chris Lattner7cd580f2006-07-07 21:37:01 +00002113 // Cannot handle inline asm.
2114 if (isa<InlineAsm>(CI->getOperand(0))) return false;
2115
Chris Lattnercd271422005-09-27 04:45:34 +00002116 // Resolve function pointers.
2117 Function *Callee = dyn_cast<Function>(getVal(Values, CI->getOperand(0)));
2118 if (!Callee) return false; // Cannot resolve.
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002119
Chris Lattnercd271422005-09-27 04:45:34 +00002120 std::vector<Constant*> Formals;
Gabor Greif5e463212008-05-29 01:59:18 +00002121 for (User::op_iterator i = CI->op_begin() + 1, e = CI->op_end();
2122 i != e; ++i)
2123 Formals.push_back(getVal(Values, *i));
Chris Lattnercd271422005-09-27 04:45:34 +00002124
Reid Spencer5cbf9852007-01-30 20:08:39 +00002125 if (Callee->isDeclaration()) {
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002126 // If this is a function we can constant fold, do it.
Chris Lattner6c1f5652007-01-30 23:14:52 +00002127 if (Constant *C = ConstantFoldCall(Callee, &Formals[0],
2128 Formals.size())) {
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002129 InstResult = C;
2130 } else {
2131 return false;
2132 }
2133 } else {
2134 if (Callee->getFunctionType()->isVarArg())
2135 return false;
2136
2137 Constant *RetVal;
2138
2139 // Execute the call, if successful, use the return value.
2140 if (!EvaluateFunction(Callee, RetVal, Formals, CallStack,
2141 MutatedMemory, AllocaTmps))
2142 return false;
2143 InstResult = RetVal;
2144 }
Reid Spencer3ed469c2006-11-02 20:25:50 +00002145 } else if (isa<TerminatorInst>(CurInst)) {
Chris Lattnercdf98be2005-09-26 04:57:38 +00002146 BasicBlock *NewBB = 0;
2147 if (BranchInst *BI = dyn_cast<BranchInst>(CurInst)) {
2148 if (BI->isUnconditional()) {
2149 NewBB = BI->getSuccessor(0);
2150 } else {
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00002151 ConstantInt *Cond =
2152 dyn_cast<ConstantInt>(getVal(Values, BI->getCondition()));
Chris Lattner97d1fad2007-01-12 18:30:11 +00002153 if (!Cond) return false; // Cannot determine.
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00002154
Reid Spencer579dca12007-01-12 04:24:46 +00002155 NewBB = BI->getSuccessor(!Cond->getZExtValue());
Chris Lattnercdf98be2005-09-26 04:57:38 +00002156 }
2157 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(CurInst)) {
2158 ConstantInt *Val =
2159 dyn_cast<ConstantInt>(getVal(Values, SI->getCondition()));
Chris Lattnercd271422005-09-27 04:45:34 +00002160 if (!Val) return false; // Cannot determine.
Chris Lattnercdf98be2005-09-26 04:57:38 +00002161 NewBB = SI->getSuccessor(SI->findCaseValue(Val));
2162 } else if (ReturnInst *RI = dyn_cast<ReturnInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002163 if (RI->getNumOperands())
2164 RetVal = getVal(Values, RI->getOperand(0));
2165
2166 CallStack.pop_back(); // return from fn.
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002167 return true; // We succeeded at evaluating this ctor!
Chris Lattnercdf98be2005-09-26 04:57:38 +00002168 } else {
Chris Lattnercd271422005-09-27 04:45:34 +00002169 // invoke, unwind, unreachable.
2170 return false; // Cannot handle this terminator.
Chris Lattnercdf98be2005-09-26 04:57:38 +00002171 }
2172
2173 // Okay, we succeeded in evaluating this control flow. See if we have
Chris Lattnercd271422005-09-27 04:45:34 +00002174 // executed the new block before. If so, we have a looping function,
2175 // which we cannot evaluate in reasonable time.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002176 if (!ExecutedBlocks.insert(NewBB))
Chris Lattnercd271422005-09-27 04:45:34 +00002177 return false; // looped!
Chris Lattnercdf98be2005-09-26 04:57:38 +00002178
2179 // Okay, we have never been in this block before. Check to see if there
2180 // are any PHI nodes. If so, evaluate them with information about where
2181 // we came from.
2182 BasicBlock *OldBB = CurInst->getParent();
2183 CurInst = NewBB->begin();
2184 PHINode *PN;
2185 for (; (PN = dyn_cast<PHINode>(CurInst)); ++CurInst)
2186 Values[PN] = getVal(Values, PN->getIncomingValueForBlock(OldBB));
2187
2188 // Do NOT increment CurInst. We know that the terminator had no value.
2189 continue;
Chris Lattner79c11012005-09-26 04:44:35 +00002190 } else {
Chris Lattner79c11012005-09-26 04:44:35 +00002191 // Did not know how to evaluate this!
Chris Lattnercd271422005-09-27 04:45:34 +00002192 return false;
Chris Lattner79c11012005-09-26 04:44:35 +00002193 }
2194
2195 if (!CurInst->use_empty())
2196 Values[CurInst] = InstResult;
2197
2198 // Advance program counter.
2199 ++CurInst;
2200 }
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002201}
2202
2203/// EvaluateStaticConstructor - Evaluate static constructors in the function, if
2204/// we can. Return true if we can, false otherwise.
2205static bool EvaluateStaticConstructor(Function *F) {
2206 /// MutatedMemory - For each store we execute, we update this map. Loads
2207 /// check this to get the most up-to-date value. If evaluation is successful,
2208 /// this state is committed to the process.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002209 DenseMap<Constant*, Constant*> MutatedMemory;
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002210
2211 /// AllocaTmps - To 'execute' an alloca, we create a temporary global variable
2212 /// to represent its body. This vector is needed so we can delete the
2213 /// temporary globals when we are done.
2214 std::vector<GlobalVariable*> AllocaTmps;
2215
2216 /// CallStack - This is used to detect recursion. In pathological situations
2217 /// we could hit exponential behavior, but at least there is nothing
2218 /// unbounded.
2219 std::vector<Function*> CallStack;
2220
2221 // Call the function.
Chris Lattnercd271422005-09-27 04:45:34 +00002222 Constant *RetValDummy;
2223 bool EvalSuccess = EvaluateFunction(F, RetValDummy, std::vector<Constant*>(),
2224 CallStack, MutatedMemory, AllocaTmps);
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002225 if (EvalSuccess) {
Chris Lattnera22fdb02005-09-26 17:07:09 +00002226 // We succeeded at evaluation: commit the result.
Bill Wendling0a81aac2006-11-26 10:02:32 +00002227 DOUT << "FULLY EVALUATED GLOBAL CTOR FUNCTION '"
2228 << F->getName() << "' to " << MutatedMemory.size()
2229 << " stores.\n";
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002230 for (DenseMap<Constant*, Constant*>::iterator I = MutatedMemory.begin(),
Chris Lattnera22fdb02005-09-26 17:07:09 +00002231 E = MutatedMemory.end(); I != E; ++I)
2232 CommitValueTo(I->second, I->first);
2233 }
Chris Lattner79c11012005-09-26 04:44:35 +00002234
Chris Lattnera22fdb02005-09-26 17:07:09 +00002235 // At this point, we are done interpreting. If we created any 'alloca'
2236 // temporaries, release them now.
2237 while (!AllocaTmps.empty()) {
2238 GlobalVariable *Tmp = AllocaTmps.back();
2239 AllocaTmps.pop_back();
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002240
Chris Lattnera22fdb02005-09-26 17:07:09 +00002241 // If there are still users of the alloca, the program is doing something
2242 // silly, e.g. storing the address of the alloca somewhere and using it
2243 // later. Since this is undefined, we'll just make it be null.
2244 if (!Tmp->use_empty())
2245 Tmp->replaceAllUsesWith(Constant::getNullValue(Tmp->getType()));
2246 delete Tmp;
2247 }
Chris Lattneraae4a1c2005-09-26 07:34:35 +00002248
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002249 return EvalSuccess;
Chris Lattner79c11012005-09-26 04:44:35 +00002250}
2251
Chris Lattnerdb973e62005-09-26 02:31:18 +00002252
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002253
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002254/// OptimizeGlobalCtorsList - Simplify and evaluation global ctors if possible.
2255/// Return true if anything changed.
2256bool GlobalOpt::OptimizeGlobalCtorsList(GlobalVariable *&GCL) {
2257 std::vector<Function*> Ctors = ParseGlobalCtors(GCL);
2258 bool MadeChange = false;
2259 if (Ctors.empty()) return false;
2260
2261 // Loop over global ctors, optimizing them when we can.
2262 for (unsigned i = 0; i != Ctors.size(); ++i) {
2263 Function *F = Ctors[i];
2264 // Found a null terminator in the middle of the list, prune off the rest of
2265 // the list.
Chris Lattner7d8e58f2005-09-26 02:19:27 +00002266 if (F == 0) {
2267 if (i != Ctors.size()-1) {
2268 Ctors.resize(i+1);
2269 MadeChange = true;
2270 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002271 break;
2272 }
2273
Chris Lattner79c11012005-09-26 04:44:35 +00002274 // We cannot simplify external ctor functions.
2275 if (F->empty()) continue;
2276
2277 // If we can evaluate the ctor at compile time, do.
2278 if (EvaluateStaticConstructor(F)) {
2279 Ctors.erase(Ctors.begin()+i);
2280 MadeChange = true;
2281 --i;
2282 ++NumCtorsEvaluated;
2283 continue;
2284 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002285 }
2286
2287 if (!MadeChange) return false;
2288
Chris Lattnerdb973e62005-09-26 02:31:18 +00002289 GCL = InstallGlobalCtors(GCL, Ctors);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002290 return true;
2291}
2292
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002293bool GlobalOpt::ResolveAliases(Module &M) {
2294 bool Changed = false;
2295
2296 for (Module::alias_iterator I = M.alias_begin(),
2297 E = M.alias_end(); I != E; ++I) {
2298 if (I->use_empty())
2299 continue;
2300
Anton Korobeynikov19e861a2008-09-09 20:05:04 +00002301 if (const GlobalValue *GV = I->resolveAliasedGlobal())
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002302 if (GV != I) {
2303 I->replaceAllUsesWith(const_cast<GlobalValue*>(GV));
2304 Changed = true;
2305 }
2306 }
2307
2308 return Changed;
2309}
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002310
Chris Lattner7a90b682004-10-07 04:16:33 +00002311bool GlobalOpt::runOnModule(Module &M) {
Chris Lattner079236d2004-02-25 21:34:36 +00002312 bool Changed = false;
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002313
2314 // Try to find the llvm.globalctors list.
2315 GlobalVariable *GlobalCtors = FindGlobalCtors(M);
Chris Lattner7a90b682004-10-07 04:16:33 +00002316
Chris Lattner7a90b682004-10-07 04:16:33 +00002317 bool LocalChange = true;
2318 while (LocalChange) {
2319 LocalChange = false;
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002320
2321 // Delete functions that are trivially dead, ccc -> fastcc
2322 LocalChange |= OptimizeFunctions(M);
2323
2324 // Optimize global_ctors list.
2325 if (GlobalCtors)
2326 LocalChange |= OptimizeGlobalCtorsList(GlobalCtors);
2327
2328 // Optimize non-address-taken globals.
2329 LocalChange |= OptimizeGlobalVars(M);
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002330
2331 // Resolve aliases, when possible.
2332 LocalChange |= ResolveAliases(M);
2333 Changed |= LocalChange;
Chris Lattner7a90b682004-10-07 04:16:33 +00002334 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002335
2336 // TODO: Move all global ctors functions to the end of the module for code
2337 // layout.
2338
Chris Lattner079236d2004-02-25 21:34:36 +00002339 return Changed;
2340}