blob: 4deb3f4d6a717c1bb8dce54c463ba5103562db2b [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"
Owen Anderson14ce9ef2009-07-06 01:34:54 +000023#include "llvm/LLVMContext.h"
Chris Lattner079236d2004-02-25 21:34:36 +000024#include "llvm/Module.h"
25#include "llvm/Pass.h"
Chris Lattner79066fa2007-01-30 23:46:24 +000026#include "llvm/Analysis/ConstantFolding.h"
Chris Lattner30ba5692004-10-11 05:54:41 +000027#include "llvm/Target/TargetData.h"
Duncan Sands548448a2008-02-18 17:32:13 +000028#include "llvm/Support/CallSite.h"
Reid Spencer9133fe22007-02-05 23:32:05 +000029#include "llvm/Support/Compiler.h"
Chris Lattner79066fa2007-01-30 23:46:24 +000030#include "llvm/Support/Debug.h"
Torok Edwinc25e7582009-07-11 20:10:48 +000031#include "llvm/Support/ErrorHandling.h"
Chris Lattner941db492008-01-14 02:09:12 +000032#include "llvm/Support/GetElementPtrTypeIterator.h"
Chris Lattner998182b2008-04-26 07:40:11 +000033#include "llvm/Support/MathExtras.h"
Daniel Dunbarce63ffb2009-07-25 00:23:56 +000034#include "llvm/Support/raw_ostream.h"
Chris Lattner5a6bb6a2008-12-16 07:34:30 +000035#include "llvm/ADT/DenseMap.h"
Chris Lattner81686182007-09-13 16:30:19 +000036#include "llvm/ADT/SmallPtrSet.h"
Chris Lattner55eb1c42007-01-31 04:40:53 +000037#include "llvm/ADT/SmallVector.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000038#include "llvm/ADT/Statistic.h"
Chris Lattnerbce4afe2008-12-17 05:28:49 +000039#include "llvm/ADT/STLExtras.h"
Chris Lattnere47ba742004-10-06 20:57:02 +000040#include <algorithm>
Chris Lattner079236d2004-02-25 21:34:36 +000041using namespace llvm;
42
Chris Lattner86453c52006-12-19 22:09:18 +000043STATISTIC(NumMarked , "Number of globals marked constant");
44STATISTIC(NumSRA , "Number of aggregate globals broken into scalars");
45STATISTIC(NumHeapSRA , "Number of heap objects SRA'd");
46STATISTIC(NumSubstitute,"Number of globals with initializers stored into them");
47STATISTIC(NumDeleted , "Number of globals deleted");
48STATISTIC(NumFnDeleted , "Number of functions deleted");
49STATISTIC(NumGlobUses , "Number of global uses devirtualized");
50STATISTIC(NumLocalized , "Number of globals localized");
51STATISTIC(NumShrunkToBool , "Number of global vars shrunk to booleans");
52STATISTIC(NumFastCallFns , "Number of functions converted to fastcc");
53STATISTIC(NumCtorsEvaluated, "Number of static ctors evaluated");
Duncan Sands3d5378f2008-02-16 20:56:04 +000054STATISTIC(NumNestRemoved , "Number of nest attributes removed");
Duncan Sands4782b302009-02-15 09:56:08 +000055STATISTIC(NumAliasesResolved, "Number of global aliases resolved");
56STATISTIC(NumAliasesRemoved, "Number of global aliases eliminated");
Chris Lattner079236d2004-02-25 21:34:36 +000057
Chris Lattner86453c52006-12-19 22:09:18 +000058namespace {
Reid Spencer9133fe22007-02-05 23:32:05 +000059 struct VISIBILITY_HIDDEN GlobalOpt : public ModulePass {
Chris Lattner30ba5692004-10-11 05:54:41 +000060 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Chris Lattner30ba5692004-10-11 05:54:41 +000061 }
Nick Lewyckyecd94c82007-05-06 13:37:16 +000062 static char ID; // Pass identification, replacement for typeid
Dan Gohmanae73dc12008-09-04 17:05:41 +000063 GlobalOpt() : ModulePass(&ID) {}
Misha Brukmanfd939082005-04-21 23:48:37 +000064
Chris Lattnerb12914b2004-09-20 04:48:05 +000065 bool runOnModule(Module &M);
Chris Lattner30ba5692004-10-11 05:54:41 +000066
67 private:
Chris Lattnerb1ab4582005-09-26 01:43:45 +000068 GlobalVariable *FindGlobalCtors(Module &M);
69 bool OptimizeFunctions(Module &M);
70 bool OptimizeGlobalVars(Module &M);
Duncan Sandsfc5940d2009-03-06 10:21:56 +000071 bool OptimizeGlobalAliases(Module &M);
Chris Lattnerb1ab4582005-09-26 01:43:45 +000072 bool OptimizeGlobalCtorsList(GlobalVariable *&GCL);
Chris Lattner7f8897f2006-08-27 22:42:52 +000073 bool ProcessInternalGlobal(GlobalVariable *GV,Module::global_iterator &GVI);
Chris Lattner079236d2004-02-25 21:34:36 +000074 };
Chris Lattner079236d2004-02-25 21:34:36 +000075}
76
Dan Gohman844731a2008-05-13 00:00:25 +000077char GlobalOpt::ID = 0;
78static RegisterPass<GlobalOpt> X("globalopt", "Global Variable Optimizer");
79
Chris Lattner7a90b682004-10-07 04:16:33 +000080ModulePass *llvm::createGlobalOptimizerPass() { return new GlobalOpt(); }
Chris Lattner079236d2004-02-25 21:34:36 +000081
Dan Gohman844731a2008-05-13 00:00:25 +000082namespace {
83
Chris Lattner7a90b682004-10-07 04:16:33 +000084/// GlobalStatus - As we analyze each global, keep track of some information
85/// about it. If we find out that the address of the global is taken, none of
Chris Lattnercf4d2a52004-10-07 21:30:30 +000086/// this info will be accurate.
Reid Spencer9133fe22007-02-05 23:32:05 +000087struct VISIBILITY_HIDDEN GlobalStatus {
Chris Lattnercf4d2a52004-10-07 21:30:30 +000088 /// isLoaded - True if the global is ever loaded. If the global isn't ever
89 /// loaded it can be deleted.
Chris Lattner7a90b682004-10-07 04:16:33 +000090 bool isLoaded;
Chris Lattnercf4d2a52004-10-07 21:30:30 +000091
92 /// StoredType - Keep track of what stores to the global look like.
93 ///
Chris Lattner7a90b682004-10-07 04:16:33 +000094 enum StoredType {
Chris Lattnercf4d2a52004-10-07 21:30:30 +000095 /// NotStored - There is no store to this global. It can thus be marked
96 /// constant.
97 NotStored,
98
99 /// isInitializerStored - This global is stored to, but the only thing
100 /// stored is the constant it was initialized with. This is only tracked
101 /// for scalar globals.
102 isInitializerStored,
103
104 /// isStoredOnce - This global is stored to, but only its initializer and
105 /// one other value is ever stored to it. If this global isStoredOnce, we
106 /// track the value stored to it in StoredOnceValue below. This is only
107 /// tracked for scalar globals.
108 isStoredOnce,
109
110 /// isStored - This global is stored to by multiple values or something else
111 /// that we cannot track.
112 isStored
Chris Lattner7a90b682004-10-07 04:16:33 +0000113 } StoredType;
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000114
115 /// StoredOnceValue - If only one value (besides the initializer constant) is
116 /// ever stored to this global, keep track of what value it is.
117 Value *StoredOnceValue;
118
Chris Lattner25de4e52006-11-01 18:03:33 +0000119 /// AccessingFunction/HasMultipleAccessingFunctions - These start out
120 /// null/false. When the first accessing function is noticed, it is recorded.
121 /// When a second different accessing function is noticed,
122 /// HasMultipleAccessingFunctions is set to true.
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +0000123 Function *AccessingFunction;
124 bool HasMultipleAccessingFunctions;
125
Chris Lattner25de4e52006-11-01 18:03:33 +0000126 /// HasNonInstructionUser - Set to true if this global has a user that is not
127 /// an instruction (e.g. a constant expr or GV initializer).
Chris Lattner553ca522005-06-15 21:11:48 +0000128 bool HasNonInstructionUser;
129
Chris Lattner25de4e52006-11-01 18:03:33 +0000130 /// HasPHIUser - Set to true if this global has a user that is a PHI node.
131 bool HasPHIUser;
132
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000133 GlobalStatus() : isLoaded(false), StoredType(NotStored), StoredOnceValue(0),
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +0000134 AccessingFunction(0), HasMultipleAccessingFunctions(false),
Chris Lattner6a93fc02008-01-14 01:32:52 +0000135 HasNonInstructionUser(false), HasPHIUser(false) {}
Chris Lattner7a90b682004-10-07 04:16:33 +0000136};
Chris Lattnere47ba742004-10-06 20:57:02 +0000137
Dan Gohman844731a2008-05-13 00:00:25 +0000138}
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000139
Jay Foade3acf152009-06-09 21:37:11 +0000140// SafeToDestroyConstant - It is safe to destroy a constant iff it is only used
141// by constants itself. Note that constants cannot be cyclic, so this test is
142// pretty easy to implement recursively.
143//
144static bool SafeToDestroyConstant(Constant *C) {
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000145 if (isa<GlobalValue>(C)) return false;
146
Devang Patel743cdf82009-03-06 01:37:41 +0000147 for (Value::use_iterator UI = C->use_begin(), E = C->use_end(); UI != E; ++UI)
148 if (Constant *CU = dyn_cast<Constant>(*UI)) {
Jay Foade3acf152009-06-09 21:37:11 +0000149 if (!SafeToDestroyConstant(CU)) return false;
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000150 } else
151 return false;
152 return true;
153}
154
155
Chris Lattner7a90b682004-10-07 04:16:33 +0000156/// AnalyzeGlobal - Look at all uses of the global and fill in the GlobalStatus
157/// structure. If the global has its address taken, return true to indicate we
158/// can't do anything with it.
Chris Lattner079236d2004-02-25 21:34:36 +0000159///
Chris Lattner7a90b682004-10-07 04:16:33 +0000160static bool AnalyzeGlobal(Value *V, GlobalStatus &GS,
Chris Lattner5a6bb6a2008-12-16 07:34:30 +0000161 SmallPtrSet<PHINode*, 16> &PHIUsers) {
Chris Lattner079236d2004-02-25 21:34:36 +0000162 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
Chris Lattner96940cb2004-07-18 19:56:20 +0000163 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(*UI)) {
Chris Lattner553ca522005-06-15 21:11:48 +0000164 GS.HasNonInstructionUser = true;
165
Chris Lattner7a90b682004-10-07 04:16:33 +0000166 if (AnalyzeGlobal(CE, GS, PHIUsers)) return true;
Chris Lattner670c8892004-10-08 17:32:09 +0000167
Chris Lattner079236d2004-02-25 21:34:36 +0000168 } else if (Instruction *I = dyn_cast<Instruction>(*UI)) {
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +0000169 if (!GS.HasMultipleAccessingFunctions) {
170 Function *F = I->getParent()->getParent();
171 if (GS.AccessingFunction == 0)
172 GS.AccessingFunction = F;
173 else if (GS.AccessingFunction != F)
174 GS.HasMultipleAccessingFunctions = true;
175 }
Chris Lattnerc69d3c92008-01-29 19:01:37 +0000176 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
Chris Lattner7a90b682004-10-07 04:16:33 +0000177 GS.isLoaded = true;
Chris Lattnerc69d3c92008-01-29 19:01:37 +0000178 if (LI->isVolatile()) return true; // Don't hack on volatile loads.
Chris Lattner7a90b682004-10-07 04:16:33 +0000179 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
Chris Lattner36025492004-10-07 06:01:25 +0000180 // Don't allow a store OF the address, only stores TO the address.
181 if (SI->getOperand(0) == V) return true;
182
Chris Lattnerc69d3c92008-01-29 19:01:37 +0000183 if (SI->isVolatile()) return true; // Don't hack on volatile stores.
184
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000185 // If this is a direct store to the global (i.e., the global is a scalar
186 // value, not an aggregate), keep more specific information about
187 // stores.
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000188 if (GS.StoredType != GlobalStatus::isStored) {
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000189 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(SI->getOperand(1))){
Chris Lattnerbd38edf2004-11-14 20:50:30 +0000190 Value *StoredVal = SI->getOperand(0);
191 if (StoredVal == GV->getInitializer()) {
192 if (GS.StoredType < GlobalStatus::isInitializerStored)
193 GS.StoredType = GlobalStatus::isInitializerStored;
194 } else if (isa<LoadInst>(StoredVal) &&
195 cast<LoadInst>(StoredVal)->getOperand(0) == GV) {
196 // G = G
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000197 if (GS.StoredType < GlobalStatus::isInitializerStored)
198 GS.StoredType = GlobalStatus::isInitializerStored;
199 } else if (GS.StoredType < GlobalStatus::isStoredOnce) {
200 GS.StoredType = GlobalStatus::isStoredOnce;
Chris Lattnerbd38edf2004-11-14 20:50:30 +0000201 GS.StoredOnceValue = StoredVal;
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000202 } else if (GS.StoredType == GlobalStatus::isStoredOnce &&
Chris Lattnerbd38edf2004-11-14 20:50:30 +0000203 GS.StoredOnceValue == StoredVal) {
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000204 // noop.
205 } else {
206 GS.StoredType = GlobalStatus::isStored;
207 }
208 } else {
Chris Lattner7a90b682004-10-07 04:16:33 +0000209 GS.StoredType = GlobalStatus::isStored;
Chris Lattnercf4d2a52004-10-07 21:30:30 +0000210 }
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000211 }
Chris Lattner35c81b02005-02-27 18:58:52 +0000212 } else if (isa<GetElementPtrInst>(I)) {
Chris Lattner7a90b682004-10-07 04:16:33 +0000213 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
Chris Lattner35c81b02005-02-27 18:58:52 +0000214 } else if (isa<SelectInst>(I)) {
Chris Lattner7a90b682004-10-07 04:16:33 +0000215 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
Chris Lattner7a90b682004-10-07 04:16:33 +0000216 } else if (PHINode *PN = dyn_cast<PHINode>(I)) {
217 // PHI nodes we can check just like select or GEP instructions, but we
218 // have to be careful about infinite recursion.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +0000219 if (PHIUsers.insert(PN)) // Not already visited.
Chris Lattner7a90b682004-10-07 04:16:33 +0000220 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
Chris Lattner25de4e52006-11-01 18:03:33 +0000221 GS.HasPHIUser = true;
Reid Spencere4d87aa2006-12-23 06:05:41 +0000222 } else if (isa<CmpInst>(I)) {
Chris Lattner8e108442009-03-08 03:37:35 +0000223 } else if (isa<MemTransferInst>(I)) {
Chris Lattner35c81b02005-02-27 18:58:52 +0000224 if (I->getOperand(1) == V)
225 GS.StoredType = GlobalStatus::isStored;
226 if (I->getOperand(2) == V)
227 GS.isLoaded = true;
Chris Lattner35c81b02005-02-27 18:58:52 +0000228 } else if (isa<MemSetInst>(I)) {
229 assert(I->getOperand(1) == V && "Memset only takes one pointer!");
230 GS.StoredType = GlobalStatus::isStored;
Chris Lattner7a90b682004-10-07 04:16:33 +0000231 } else {
232 return true; // Any other non-load instruction might take address!
Chris Lattner9ce30002004-07-20 03:58:07 +0000233 }
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000234 } else if (Constant *C = dyn_cast<Constant>(*UI)) {
Chris Lattner553ca522005-06-15 21:11:48 +0000235 GS.HasNonInstructionUser = true;
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000236 // We might have a dead and dangling constant hanging off of here.
Jay Foade3acf152009-06-09 21:37:11 +0000237 if (!SafeToDestroyConstant(C))
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000238 return true;
Chris Lattner079236d2004-02-25 21:34:36 +0000239 } else {
Chris Lattner553ca522005-06-15 21:11:48 +0000240 GS.HasNonInstructionUser = true;
241 // Otherwise must be some other user.
Chris Lattner079236d2004-02-25 21:34:36 +0000242 return true;
243 }
244
245 return false;
246}
247
Owen Anderson14ce9ef2009-07-06 01:34:54 +0000248static Constant *getAggregateConstantElement(Constant *Agg, Constant *Idx,
Owen Andersone922c022009-07-22 00:24:57 +0000249 LLVMContext &Context) {
Chris Lattner670c8892004-10-08 17:32:09 +0000250 ConstantInt *CI = dyn_cast<ConstantInt>(Idx);
251 if (!CI) return 0;
Reid Spencerb83eb642006-10-20 07:07:24 +0000252 unsigned IdxV = CI->getZExtValue();
Chris Lattner7a90b682004-10-07 04:16:33 +0000253
Chris Lattner670c8892004-10-08 17:32:09 +0000254 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Agg)) {
255 if (IdxV < CS->getNumOperands()) return CS->getOperand(IdxV);
256 } else if (ConstantArray *CA = dyn_cast<ConstantArray>(Agg)) {
257 if (IdxV < CA->getNumOperands()) return CA->getOperand(IdxV);
Reid Spencer9d6565a2007-02-15 02:26:10 +0000258 } else if (ConstantVector *CP = dyn_cast<ConstantVector>(Agg)) {
Chris Lattner670c8892004-10-08 17:32:09 +0000259 if (IdxV < CP->getNumOperands()) return CP->getOperand(IdxV);
Chris Lattner7a7ed022004-10-16 18:09:00 +0000260 } else if (isa<ConstantAggregateZero>(Agg)) {
Chris Lattner670c8892004-10-08 17:32:09 +0000261 if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
262 if (IdxV < STy->getNumElements())
Owen Andersona7235ea2009-07-31 20:28:14 +0000263 return Constant::getNullValue(STy->getElementType(IdxV));
Chris Lattner670c8892004-10-08 17:32:09 +0000264 } else if (const SequentialType *STy =
265 dyn_cast<SequentialType>(Agg->getType())) {
Owen Andersona7235ea2009-07-31 20:28:14 +0000266 return Constant::getNullValue(STy->getElementType());
Chris Lattner670c8892004-10-08 17:32:09 +0000267 }
Chris Lattner7a7ed022004-10-16 18:09:00 +0000268 } else if (isa<UndefValue>(Agg)) {
269 if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
270 if (IdxV < STy->getNumElements())
Owen Anderson9e9a0d52009-07-30 23:03:37 +0000271 return UndefValue::get(STy->getElementType(IdxV));
Chris Lattner7a7ed022004-10-16 18:09:00 +0000272 } else if (const SequentialType *STy =
273 dyn_cast<SequentialType>(Agg->getType())) {
Owen Anderson9e9a0d52009-07-30 23:03:37 +0000274 return UndefValue::get(STy->getElementType());
Chris Lattner7a7ed022004-10-16 18:09:00 +0000275 }
Chris Lattner670c8892004-10-08 17:32:09 +0000276 }
277 return 0;
278}
Chris Lattner7a90b682004-10-07 04:16:33 +0000279
Chris Lattner7a90b682004-10-07 04:16:33 +0000280
Chris Lattnere47ba742004-10-06 20:57:02 +0000281/// CleanupConstantGlobalUsers - We just marked GV constant. Loop over all
282/// users of the global, cleaning up the obvious ones. This is largely just a
Chris Lattner031955d2004-10-10 16:43:46 +0000283/// quick scan over the use list to clean up the easy and obvious cruft. This
284/// returns true if it made a change.
Owen Anderson50895512009-07-06 18:42:36 +0000285static bool CleanupConstantGlobalUsers(Value *V, Constant *Init,
Owen Andersone922c022009-07-22 00:24:57 +0000286 LLVMContext &Context) {
Chris Lattner031955d2004-10-10 16:43:46 +0000287 bool Changed = false;
Chris Lattner7a90b682004-10-07 04:16:33 +0000288 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;) {
289 User *U = *UI++;
Misha Brukmanfd939082005-04-21 23:48:37 +0000290
Chris Lattner7a90b682004-10-07 04:16:33 +0000291 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattner35c81b02005-02-27 18:58:52 +0000292 if (Init) {
293 // Replace the load with the initializer.
294 LI->replaceAllUsesWith(Init);
295 LI->eraseFromParent();
296 Changed = true;
297 }
Chris Lattner7a90b682004-10-07 04:16:33 +0000298 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
Chris Lattnere47ba742004-10-06 20:57:02 +0000299 // Store must be unreachable or storing Init into the global.
Chris Lattner7a7ed022004-10-16 18:09:00 +0000300 SI->eraseFromParent();
Chris Lattner031955d2004-10-10 16:43:46 +0000301 Changed = true;
Chris Lattner7a90b682004-10-07 04:16:33 +0000302 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
303 if (CE->getOpcode() == Instruction::GetElementPtr) {
Chris Lattneraae4a1c2005-09-26 07:34:35 +0000304 Constant *SubInit = 0;
305 if (Init)
Owen Anderson50895512009-07-06 18:42:36 +0000306 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE, Context);
307 Changed |= CleanupConstantGlobalUsers(CE, SubInit, Context);
Reid Spencer3da59db2006-11-27 01:05:10 +0000308 } else if (CE->getOpcode() == Instruction::BitCast &&
Chris Lattner35c81b02005-02-27 18:58:52 +0000309 isa<PointerType>(CE->getType())) {
310 // Pointer cast, delete any stores and memsets to the global.
Owen Anderson50895512009-07-06 18:42:36 +0000311 Changed |= CleanupConstantGlobalUsers(CE, 0, Context);
Chris Lattner35c81b02005-02-27 18:58:52 +0000312 }
313
314 if (CE->use_empty()) {
315 CE->destroyConstant();
316 Changed = true;
Chris Lattner7a90b682004-10-07 04:16:33 +0000317 }
318 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner7b52fe72007-11-09 17:33:02 +0000319 // Do not transform "gepinst (gep constexpr (GV))" here, because forming
320 // "gepconstexpr (gep constexpr (GV))" will cause the two gep's to fold
321 // and will invalidate our notion of what Init is.
Chris Lattner19450242007-11-13 21:46:23 +0000322 Constant *SubInit = 0;
Chris Lattner7b52fe72007-11-09 17:33:02 +0000323 if (!isa<ConstantExpr>(GEP->getOperand(0))) {
324 ConstantExpr *CE =
Owen Anderson50895512009-07-06 18:42:36 +0000325 dyn_cast_or_null<ConstantExpr>(ConstantFoldInstruction(GEP, Context));
Chris Lattner7b52fe72007-11-09 17:33:02 +0000326 if (Init && CE && CE->getOpcode() == Instruction::GetElementPtr)
Owen Anderson50895512009-07-06 18:42:36 +0000327 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE, Context);
Chris Lattner7b52fe72007-11-09 17:33:02 +0000328 }
Owen Anderson50895512009-07-06 18:42:36 +0000329 Changed |= CleanupConstantGlobalUsers(GEP, SubInit, Context);
Chris Lattnerc4d81b02004-10-10 16:47:33 +0000330
Chris Lattner031955d2004-10-10 16:43:46 +0000331 if (GEP->use_empty()) {
Chris Lattner7a7ed022004-10-16 18:09:00 +0000332 GEP->eraseFromParent();
Chris Lattner031955d2004-10-10 16:43:46 +0000333 Changed = true;
334 }
Chris Lattner35c81b02005-02-27 18:58:52 +0000335 } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(U)) { // memset/cpy/mv
336 if (MI->getRawDest() == V) {
337 MI->eraseFromParent();
338 Changed = true;
339 }
340
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000341 } else if (Constant *C = dyn_cast<Constant>(U)) {
342 // If we have a chain of dead constantexprs or other things dangling from
343 // us, and if they are all dead, nuke them without remorse.
Jay Foade3acf152009-06-09 21:37:11 +0000344 if (SafeToDestroyConstant(C)) {
Devang Patel743cdf82009-03-06 01:37:41 +0000345 C->destroyConstant();
Chris Lattner35c81b02005-02-27 18:58:52 +0000346 // This could have invalidated UI, start over from scratch.
Owen Anderson50895512009-07-06 18:42:36 +0000347 CleanupConstantGlobalUsers(V, Init, Context);
Chris Lattner031955d2004-10-10 16:43:46 +0000348 return true;
Chris Lattnera4be1dc2004-10-08 20:59:28 +0000349 }
Chris Lattnere47ba742004-10-06 20:57:02 +0000350 }
351 }
Chris Lattner031955d2004-10-10 16:43:46 +0000352 return Changed;
Chris Lattnere47ba742004-10-06 20:57:02 +0000353}
354
Chris Lattner941db492008-01-14 02:09:12 +0000355/// isSafeSROAElementUse - Return true if the specified instruction is a safe
356/// user of a derived expression from a global that we want to SROA.
357static bool isSafeSROAElementUse(Value *V) {
358 // We might have a dead and dangling constant hanging off of here.
359 if (Constant *C = dyn_cast<Constant>(V))
Jay Foade3acf152009-06-09 21:37:11 +0000360 return SafeToDestroyConstant(C);
Chris Lattner727c2102008-01-14 01:31:05 +0000361
Chris Lattner941db492008-01-14 02:09:12 +0000362 Instruction *I = dyn_cast<Instruction>(V);
363 if (!I) return false;
364
365 // Loads are ok.
366 if (isa<LoadInst>(I)) return true;
367
368 // Stores *to* the pointer are ok.
369 if (StoreInst *SI = dyn_cast<StoreInst>(I))
370 return SI->getOperand(0) != V;
371
372 // Otherwise, it must be a GEP.
373 GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I);
374 if (GEPI == 0) return false;
375
376 if (GEPI->getNumOperands() < 3 || !isa<Constant>(GEPI->getOperand(1)) ||
377 !cast<Constant>(GEPI->getOperand(1))->isNullValue())
378 return false;
379
380 for (Value::use_iterator I = GEPI->use_begin(), E = GEPI->use_end();
381 I != E; ++I)
382 if (!isSafeSROAElementUse(*I))
383 return false;
Chris Lattner727c2102008-01-14 01:31:05 +0000384 return true;
385}
386
Chris Lattner941db492008-01-14 02:09:12 +0000387
388/// IsUserOfGlobalSafeForSRA - U is a direct user of the specified global value.
389/// Look at it and its uses and decide whether it is safe to SROA this global.
390///
391static bool IsUserOfGlobalSafeForSRA(User *U, GlobalValue *GV) {
392 // The user of the global must be a GEP Inst or a ConstantExpr GEP.
393 if (!isa<GetElementPtrInst>(U) &&
394 (!isa<ConstantExpr>(U) ||
395 cast<ConstantExpr>(U)->getOpcode() != Instruction::GetElementPtr))
396 return false;
397
398 // Check to see if this ConstantExpr GEP is SRA'able. In particular, we
399 // don't like < 3 operand CE's, and we don't like non-constant integer
400 // indices. This enforces that all uses are 'gep GV, 0, C, ...' for some
401 // value of C.
402 if (U->getNumOperands() < 3 || !isa<Constant>(U->getOperand(1)) ||
403 !cast<Constant>(U->getOperand(1))->isNullValue() ||
404 !isa<ConstantInt>(U->getOperand(2)))
405 return false;
406
407 gep_type_iterator GEPI = gep_type_begin(U), E = gep_type_end(U);
408 ++GEPI; // Skip over the pointer index.
409
410 // If this is a use of an array allocation, do a bit more checking for sanity.
411 if (const ArrayType *AT = dyn_cast<ArrayType>(*GEPI)) {
412 uint64_t NumElements = AT->getNumElements();
413 ConstantInt *Idx = cast<ConstantInt>(U->getOperand(2));
414
415 // Check to make sure that index falls within the array. If not,
416 // something funny is going on, so we won't do the optimization.
417 //
418 if (Idx->getZExtValue() >= NumElements)
419 return false;
420
421 // We cannot scalar repl this level of the array unless any array
422 // sub-indices are in-range constants. In particular, consider:
423 // A[0][i]. We cannot know that the user isn't doing invalid things like
424 // allowing i to index an out-of-range subscript that accesses A[1].
425 //
426 // Scalar replacing *just* the outer index of the array is probably not
427 // going to be a win anyway, so just give up.
428 for (++GEPI; // Skip array index.
Dan Gohman6874a2a2009-08-18 14:58:19 +0000429 GEPI != E;
Chris Lattner941db492008-01-14 02:09:12 +0000430 ++GEPI) {
431 uint64_t NumElements;
432 if (const ArrayType *SubArrayTy = dyn_cast<ArrayType>(*GEPI))
433 NumElements = SubArrayTy->getNumElements();
Dan Gohman6874a2a2009-08-18 14:58:19 +0000434 else if (const VectorType *SubVectorTy = dyn_cast<VectorType>(*GEPI))
435 NumElements = SubVectorTy->getNumElements();
436 else {
437 assert(isa<StructType>(*GEPI) &&
438 "Indexed GEP type is not array, vector, or struct!");
439 continue;
440 }
Chris Lattner941db492008-01-14 02:09:12 +0000441
442 ConstantInt *IdxVal = dyn_cast<ConstantInt>(GEPI.getOperand());
443 if (!IdxVal || IdxVal->getZExtValue() >= NumElements)
444 return false;
445 }
446 }
447
448 for (Value::use_iterator I = U->use_begin(), E = U->use_end(); I != E; ++I)
449 if (!isSafeSROAElementUse(*I))
450 return false;
451 return true;
452}
453
454/// GlobalUsersSafeToSRA - Look at all uses of the global and decide whether it
455/// is safe for us to perform this transformation.
456///
457static bool GlobalUsersSafeToSRA(GlobalValue *GV) {
458 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end();
459 UI != E; ++UI) {
460 if (!IsUserOfGlobalSafeForSRA(*UI, GV))
461 return false;
462 }
463 return true;
464}
465
466
Chris Lattner670c8892004-10-08 17:32:09 +0000467/// SRAGlobal - Perform scalar replacement of aggregates on the specified global
468/// variable. This opens the door for other optimizations by exposing the
469/// behavior of the program in a more fine-grained way. We have determined that
470/// this transformation is safe already. We return the first global variable we
471/// insert so that the caller can reprocess it.
Owen Anderson14ce9ef2009-07-06 01:34:54 +0000472static GlobalVariable *SRAGlobal(GlobalVariable *GV, const TargetData &TD,
Owen Andersone922c022009-07-22 00:24:57 +0000473 LLVMContext &Context) {
Chris Lattner727c2102008-01-14 01:31:05 +0000474 // Make sure this global only has simple uses that we can SRA.
Chris Lattner941db492008-01-14 02:09:12 +0000475 if (!GlobalUsersSafeToSRA(GV))
Chris Lattner727c2102008-01-14 01:31:05 +0000476 return 0;
477
Rafael Espindolabb46f522009-01-15 20:18:42 +0000478 assert(GV->hasLocalLinkage() && !GV->isConstant());
Chris Lattner670c8892004-10-08 17:32:09 +0000479 Constant *Init = GV->getInitializer();
480 const Type *Ty = Init->getType();
Misha Brukmanfd939082005-04-21 23:48:37 +0000481
Chris Lattner670c8892004-10-08 17:32:09 +0000482 std::vector<GlobalVariable*> NewGlobals;
483 Module::GlobalListType &Globals = GV->getParent()->getGlobalList();
484
Chris Lattner998182b2008-04-26 07:40:11 +0000485 // Get the alignment of the global, either explicit or target-specific.
486 unsigned StartAlignment = GV->getAlignment();
487 if (StartAlignment == 0)
488 StartAlignment = TD.getABITypeAlignment(GV->getType());
489
Chris Lattner670c8892004-10-08 17:32:09 +0000490 if (const StructType *STy = dyn_cast<StructType>(Ty)) {
491 NewGlobals.reserve(STy->getNumElements());
Chris Lattner998182b2008-04-26 07:40:11 +0000492 const StructLayout &Layout = *TD.getStructLayout(STy);
Chris Lattner670c8892004-10-08 17:32:09 +0000493 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
494 Constant *In = getAggregateConstantElement(Init,
Owen Anderson1d0be152009-08-13 21:58:54 +0000495 ConstantInt::get(Type::getInt32Ty(Context), i),
Owen Anderson14ce9ef2009-07-06 01:34:54 +0000496 Context);
Chris Lattner670c8892004-10-08 17:32:09 +0000497 assert(In && "Couldn't get element of initializer?");
Owen Andersone922c022009-07-22 00:24:57 +0000498 GlobalVariable *NGV = new GlobalVariable(Context,
Owen Andersone9b11b42009-07-08 19:03:57 +0000499 STy->getElementType(i), false,
Chris Lattner670c8892004-10-08 17:32:09 +0000500 GlobalVariable::InternalLinkage,
Daniel Dunbarfe09b202009-07-30 17:37:43 +0000501 In, GV->getName()+"."+Twine(i),
Matthijs Kooijmanbc1f9892008-07-17 11:59:53 +0000502 GV->isThreadLocal(),
Owen Anderson3d29df32009-07-08 01:26:06 +0000503 GV->getType()->getAddressSpace());
Chris Lattner670c8892004-10-08 17:32:09 +0000504 Globals.insert(GV, NGV);
505 NewGlobals.push_back(NGV);
Chris Lattner998182b2008-04-26 07:40:11 +0000506
507 // Calculate the known alignment of the field. If the original aggregate
508 // had 256 byte alignment for example, something might depend on that:
509 // propagate info to each field.
510 uint64_t FieldOffset = Layout.getElementOffset(i);
511 unsigned NewAlign = (unsigned)MinAlign(StartAlignment, FieldOffset);
512 if (NewAlign > TD.getABITypeAlignment(STy->getElementType(i)))
513 NGV->setAlignment(NewAlign);
Chris Lattner670c8892004-10-08 17:32:09 +0000514 }
515 } else if (const SequentialType *STy = dyn_cast<SequentialType>(Ty)) {
516 unsigned NumElements = 0;
517 if (const ArrayType *ATy = dyn_cast<ArrayType>(STy))
518 NumElements = ATy->getNumElements();
Chris Lattner670c8892004-10-08 17:32:09 +0000519 else
Chris Lattner998182b2008-04-26 07:40:11 +0000520 NumElements = cast<VectorType>(STy)->getNumElements();
Chris Lattner670c8892004-10-08 17:32:09 +0000521
Chris Lattner1f21ef12005-02-23 16:53:04 +0000522 if (NumElements > 16 && GV->hasNUsesOrMore(16))
Chris Lattnerd514d822005-02-01 01:23:31 +0000523 return 0; // It's not worth it.
Chris Lattner670c8892004-10-08 17:32:09 +0000524 NewGlobals.reserve(NumElements);
Chris Lattner998182b2008-04-26 07:40:11 +0000525
Duncan Sands777d2302009-05-09 07:06:46 +0000526 uint64_t EltSize = TD.getTypeAllocSize(STy->getElementType());
Chris Lattner998182b2008-04-26 07:40:11 +0000527 unsigned EltAlign = TD.getABITypeAlignment(STy->getElementType());
Chris Lattner670c8892004-10-08 17:32:09 +0000528 for (unsigned i = 0, e = NumElements; i != e; ++i) {
529 Constant *In = getAggregateConstantElement(Init,
Owen Anderson1d0be152009-08-13 21:58:54 +0000530 ConstantInt::get(Type::getInt32Ty(Context), i),
Owen Anderson14ce9ef2009-07-06 01:34:54 +0000531 Context);
Chris Lattner670c8892004-10-08 17:32:09 +0000532 assert(In && "Couldn't get element of initializer?");
533
Owen Andersone922c022009-07-22 00:24:57 +0000534 GlobalVariable *NGV = new GlobalVariable(Context,
Owen Andersone9b11b42009-07-08 19:03:57 +0000535 STy->getElementType(), false,
Chris Lattner670c8892004-10-08 17:32:09 +0000536 GlobalVariable::InternalLinkage,
Daniel Dunbarfe09b202009-07-30 17:37:43 +0000537 In, GV->getName()+"."+Twine(i),
Matthijs Kooijmanbc1f9892008-07-17 11:59:53 +0000538 GV->isThreadLocal(),
Owen Andersone9b11b42009-07-08 19:03:57 +0000539 GV->getType()->getAddressSpace());
Chris Lattner670c8892004-10-08 17:32:09 +0000540 Globals.insert(GV, NGV);
541 NewGlobals.push_back(NGV);
Chris Lattner998182b2008-04-26 07:40:11 +0000542
543 // Calculate the known alignment of the field. If the original aggregate
544 // had 256 byte alignment for example, something might depend on that:
545 // propagate info to each field.
546 unsigned NewAlign = (unsigned)MinAlign(StartAlignment, EltSize*i);
547 if (NewAlign > EltAlign)
548 NGV->setAlignment(NewAlign);
Chris Lattner670c8892004-10-08 17:32:09 +0000549 }
550 }
551
552 if (NewGlobals.empty())
553 return 0;
554
Chris Lattnerbdff5482009-08-23 04:37:46 +0000555 DEBUG(errs() << "PERFORMING GLOBAL SRA ON: " << *GV);
Chris Lattner30ba5692004-10-11 05:54:41 +0000556
Owen Anderson1d0be152009-08-13 21:58:54 +0000557 Constant *NullInt = Constant::getNullValue(Type::getInt32Ty(Context));
Chris Lattner670c8892004-10-08 17:32:09 +0000558
559 // Loop over all of the uses of the global, replacing the constantexpr geps,
560 // with smaller constantexpr geps or direct references.
561 while (!GV->use_empty()) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000562 User *GEP = GV->use_back();
563 assert(((isa<ConstantExpr>(GEP) &&
564 cast<ConstantExpr>(GEP)->getOpcode()==Instruction::GetElementPtr)||
565 isa<GetElementPtrInst>(GEP)) && "NonGEP CE's are not SRAable!");
Misha Brukmanfd939082005-04-21 23:48:37 +0000566
Chris Lattner670c8892004-10-08 17:32:09 +0000567 // Ignore the 1th operand, which has to be zero or else the program is quite
568 // broken (undefined). Get the 2nd operand, which is the structure or array
569 // index.
Reid Spencerb83eb642006-10-20 07:07:24 +0000570 unsigned Val = cast<ConstantInt>(GEP->getOperand(2))->getZExtValue();
Chris Lattner670c8892004-10-08 17:32:09 +0000571 if (Val >= NewGlobals.size()) Val = 0; // Out of bound array access.
572
Chris Lattner30ba5692004-10-11 05:54:41 +0000573 Value *NewPtr = NewGlobals[Val];
Chris Lattner670c8892004-10-08 17:32:09 +0000574
575 // Form a shorter GEP if needed.
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000576 if (GEP->getNumOperands() > 3) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000577 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEP)) {
Chris Lattner55eb1c42007-01-31 04:40:53 +0000578 SmallVector<Constant*, 8> Idxs;
Chris Lattner30ba5692004-10-11 05:54:41 +0000579 Idxs.push_back(NullInt);
580 for (unsigned i = 3, e = CE->getNumOperands(); i != e; ++i)
581 Idxs.push_back(CE->getOperand(i));
Owen Andersonbaf3c402009-07-29 18:55:55 +0000582 NewPtr = ConstantExpr::getGetElementPtr(cast<Constant>(NewPtr),
Chris Lattner55eb1c42007-01-31 04:40:53 +0000583 &Idxs[0], Idxs.size());
Chris Lattner30ba5692004-10-11 05:54:41 +0000584 } else {
585 GetElementPtrInst *GEPI = cast<GetElementPtrInst>(GEP);
Chris Lattner699d1442007-01-31 19:59:55 +0000586 SmallVector<Value*, 8> Idxs;
Chris Lattner30ba5692004-10-11 05:54:41 +0000587 Idxs.push_back(NullInt);
588 for (unsigned i = 3, e = GEPI->getNumOperands(); i != e; ++i)
589 Idxs.push_back(GEPI->getOperand(i));
Gabor Greif051a9502008-04-06 20:25:17 +0000590 NewPtr = GetElementPtrInst::Create(NewPtr, Idxs.begin(), Idxs.end(),
Daniel Dunbarfe09b202009-07-30 17:37:43 +0000591 GEPI->getName()+"."+Twine(Val),GEPI);
Chris Lattner30ba5692004-10-11 05:54:41 +0000592 }
Anton Korobeynikov07e6e562008-02-20 11:26:25 +0000593 }
Chris Lattner30ba5692004-10-11 05:54:41 +0000594 GEP->replaceAllUsesWith(NewPtr);
595
596 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(GEP))
Chris Lattner7a7ed022004-10-16 18:09:00 +0000597 GEPI->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000598 else
599 cast<ConstantExpr>(GEP)->destroyConstant();
Chris Lattner670c8892004-10-08 17:32:09 +0000600 }
601
Chris Lattnere40e2d12004-10-08 20:25:55 +0000602 // Delete the old global, now that it is dead.
603 Globals.erase(GV);
Chris Lattner670c8892004-10-08 17:32:09 +0000604 ++NumSRA;
Chris Lattner30ba5692004-10-11 05:54:41 +0000605
606 // Loop over the new globals array deleting any globals that are obviously
607 // dead. This can arise due to scalarization of a structure or an array that
608 // has elements that are dead.
609 unsigned FirstGlobal = 0;
610 for (unsigned i = 0, e = NewGlobals.size(); i != e; ++i)
611 if (NewGlobals[i]->use_empty()) {
612 Globals.erase(NewGlobals[i]);
613 if (FirstGlobal == i) ++FirstGlobal;
614 }
615
616 return FirstGlobal != NewGlobals.size() ? NewGlobals[FirstGlobal] : 0;
Chris Lattner670c8892004-10-08 17:32:09 +0000617}
618
Chris Lattner9b34a612004-10-09 21:48:45 +0000619/// AllUsesOfValueWillTrapIfNull - Return true if all users of the specified
Chris Lattner81686182007-09-13 16:30:19 +0000620/// value will trap if the value is dynamically null. PHIs keeps track of any
621/// phi nodes we've seen to avoid reprocessing them.
622static bool AllUsesOfValueWillTrapIfNull(Value *V,
623 SmallPtrSet<PHINode*, 8> &PHIs) {
Chris Lattner9b34a612004-10-09 21:48:45 +0000624 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
625 if (isa<LoadInst>(*UI)) {
626 // Will trap.
627 } else if (StoreInst *SI = dyn_cast<StoreInst>(*UI)) {
628 if (SI->getOperand(0) == V) {
Bill Wendlinge8156192006-12-07 01:30:32 +0000629 //cerr << "NONTRAPPING USE: " << **UI;
Chris Lattner9b34a612004-10-09 21:48:45 +0000630 return false; // Storing the value.
631 }
632 } else if (CallInst *CI = dyn_cast<CallInst>(*UI)) {
633 if (CI->getOperand(0) != V) {
Bill Wendlinge8156192006-12-07 01:30:32 +0000634 //cerr << "NONTRAPPING USE: " << **UI;
Chris Lattner9b34a612004-10-09 21:48:45 +0000635 return false; // Not calling the ptr
636 }
637 } else if (InvokeInst *II = dyn_cast<InvokeInst>(*UI)) {
638 if (II->getOperand(0) != V) {
Bill Wendlinge8156192006-12-07 01:30:32 +0000639 //cerr << "NONTRAPPING USE: " << **UI;
Chris Lattner9b34a612004-10-09 21:48:45 +0000640 return false; // Not calling the ptr
641 }
Chris Lattner81686182007-09-13 16:30:19 +0000642 } else if (BitCastInst *CI = dyn_cast<BitCastInst>(*UI)) {
643 if (!AllUsesOfValueWillTrapIfNull(CI, PHIs)) return false;
Chris Lattner9b34a612004-10-09 21:48:45 +0000644 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(*UI)) {
Chris Lattner81686182007-09-13 16:30:19 +0000645 if (!AllUsesOfValueWillTrapIfNull(GEPI, PHIs)) return false;
646 } else if (PHINode *PN = dyn_cast<PHINode>(*UI)) {
647 // If we've already seen this phi node, ignore it, it has already been
648 // checked.
649 if (PHIs.insert(PN))
650 return AllUsesOfValueWillTrapIfNull(PN, PHIs);
Reid Spencere4d87aa2006-12-23 06:05:41 +0000651 } else if (isa<ICmpInst>(*UI) &&
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000652 isa<ConstantPointerNull>(UI->getOperand(1))) {
653 // Ignore setcc X, null
Chris Lattner9b34a612004-10-09 21:48:45 +0000654 } else {
Bill Wendlinge8156192006-12-07 01:30:32 +0000655 //cerr << "NONTRAPPING USE: " << **UI;
Chris Lattner9b34a612004-10-09 21:48:45 +0000656 return false;
657 }
658 return true;
659}
660
661/// AllUsesOfLoadedValueWillTrapIfNull - Return true if all uses of any loads
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000662/// from GV will trap if the loaded value is null. Note that this also permits
663/// comparisons of the loaded value against null, as a special case.
Chris Lattner9b34a612004-10-09 21:48:45 +0000664static bool AllUsesOfLoadedValueWillTrapIfNull(GlobalVariable *GV) {
665 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI!=E; ++UI)
666 if (LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
Chris Lattner81686182007-09-13 16:30:19 +0000667 SmallPtrSet<PHINode*, 8> PHIs;
668 if (!AllUsesOfValueWillTrapIfNull(LI, PHIs))
Chris Lattner9b34a612004-10-09 21:48:45 +0000669 return false;
670 } else if (isa<StoreInst>(*UI)) {
671 // Ignore stores to the global.
672 } else {
673 // We don't know or understand this user, bail out.
Bill Wendlinge8156192006-12-07 01:30:32 +0000674 //cerr << "UNKNOWN USER OF GLOBAL!: " << **UI;
Chris Lattner9b34a612004-10-09 21:48:45 +0000675 return false;
676 }
677
678 return true;
679}
680
Owen Anderson14ce9ef2009-07-06 01:34:54 +0000681static bool OptimizeAwayTrappingUsesOfValue(Value *V, Constant *NewV,
Owen Andersone922c022009-07-22 00:24:57 +0000682 LLVMContext &Context) {
Chris Lattner708148e2004-10-10 23:14:11 +0000683 bool Changed = false;
684 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ) {
685 Instruction *I = cast<Instruction>(*UI++);
686 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
687 LI->setOperand(0, NewV);
688 Changed = true;
689 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
690 if (SI->getOperand(1) == V) {
691 SI->setOperand(1, NewV);
692 Changed = true;
693 }
694 } else if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
695 if (I->getOperand(0) == V) {
696 // Calling through the pointer! Turn into a direct call, but be careful
697 // that the pointer is not also being passed as an argument.
698 I->setOperand(0, NewV);
699 Changed = true;
700 bool PassedAsArg = false;
701 for (unsigned i = 1, e = I->getNumOperands(); i != e; ++i)
702 if (I->getOperand(i) == V) {
703 PassedAsArg = true;
704 I->setOperand(i, NewV);
705 }
706
707 if (PassedAsArg) {
708 // Being passed as an argument also. Be careful to not invalidate UI!
709 UI = V->use_begin();
710 }
711 }
712 } else if (CastInst *CI = dyn_cast<CastInst>(I)) {
713 Changed |= OptimizeAwayTrappingUsesOfValue(CI,
Owen Andersonbaf3c402009-07-29 18:55:55 +0000714 ConstantExpr::getCast(CI->getOpcode(),
Owen Anderson14ce9ef2009-07-06 01:34:54 +0000715 NewV, CI->getType()), Context);
Chris Lattner708148e2004-10-10 23:14:11 +0000716 if (CI->use_empty()) {
717 Changed = true;
Chris Lattner7a7ed022004-10-16 18:09:00 +0000718 CI->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +0000719 }
720 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
721 // Should handle GEP here.
Chris Lattner55eb1c42007-01-31 04:40:53 +0000722 SmallVector<Constant*, 8> Idxs;
723 Idxs.reserve(GEPI->getNumOperands()-1);
Gabor Greif5e463212008-05-29 01:59:18 +0000724 for (User::op_iterator i = GEPI->op_begin() + 1, e = GEPI->op_end();
725 i != e; ++i)
726 if (Constant *C = dyn_cast<Constant>(*i))
Chris Lattner55eb1c42007-01-31 04:40:53 +0000727 Idxs.push_back(C);
Chris Lattner708148e2004-10-10 23:14:11 +0000728 else
729 break;
Chris Lattner55eb1c42007-01-31 04:40:53 +0000730 if (Idxs.size() == GEPI->getNumOperands()-1)
Chris Lattner708148e2004-10-10 23:14:11 +0000731 Changed |= OptimizeAwayTrappingUsesOfValue(GEPI,
Owen Andersonbaf3c402009-07-29 18:55:55 +0000732 ConstantExpr::getGetElementPtr(NewV, &Idxs[0],
Owen Anderson14ce9ef2009-07-06 01:34:54 +0000733 Idxs.size()), Context);
Chris Lattner708148e2004-10-10 23:14:11 +0000734 if (GEPI->use_empty()) {
735 Changed = true;
Chris Lattner7a7ed022004-10-16 18:09:00 +0000736 GEPI->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +0000737 }
738 }
739 }
740
741 return Changed;
742}
743
744
745/// OptimizeAwayTrappingUsesOfLoads - The specified global has only one non-null
746/// value stored into it. If there are uses of the loaded value that would trap
747/// if the loaded value is dynamically null, then we know that they cannot be
748/// reachable with a null optimize away the load.
Owen Anderson14ce9ef2009-07-06 01:34:54 +0000749static bool OptimizeAwayTrappingUsesOfLoads(GlobalVariable *GV, Constant *LV,
Owen Andersone922c022009-07-22 00:24:57 +0000750 LLVMContext &Context) {
Chris Lattner708148e2004-10-10 23:14:11 +0000751 bool Changed = false;
752
Chris Lattner92c6bd22009-01-14 00:12:58 +0000753 // Keep track of whether we are able to remove all the uses of the global
754 // other than the store that defines it.
755 bool AllNonStoreUsesGone = true;
756
Chris Lattner708148e2004-10-10 23:14:11 +0000757 // Replace all uses of loads with uses of uses of the stored value.
Chris Lattner92c6bd22009-01-14 00:12:58 +0000758 for (Value::use_iterator GUI = GV->use_begin(), E = GV->use_end(); GUI != E;){
759 User *GlobalUser = *GUI++;
760 if (LoadInst *LI = dyn_cast<LoadInst>(GlobalUser)) {
Owen Anderson14ce9ef2009-07-06 01:34:54 +0000761 Changed |= OptimizeAwayTrappingUsesOfValue(LI, LV, Context);
Chris Lattner92c6bd22009-01-14 00:12:58 +0000762 // If we were able to delete all uses of the loads
763 if (LI->use_empty()) {
764 LI->eraseFromParent();
765 Changed = true;
766 } else {
767 AllNonStoreUsesGone = false;
768 }
769 } else if (isa<StoreInst>(GlobalUser)) {
770 // Ignore the store that stores "LV" to the global.
771 assert(GlobalUser->getOperand(1) == GV &&
772 "Must be storing *to* the global");
Chris Lattner708148e2004-10-10 23:14:11 +0000773 } else {
Chris Lattner92c6bd22009-01-14 00:12:58 +0000774 AllNonStoreUsesGone = false;
775
776 // If we get here we could have other crazy uses that are transitively
777 // loaded.
778 assert((isa<PHINode>(GlobalUser) || isa<SelectInst>(GlobalUser) ||
779 isa<ConstantExpr>(GlobalUser)) && "Only expect load and stores!");
Chris Lattner708148e2004-10-10 23:14:11 +0000780 }
Chris Lattner92c6bd22009-01-14 00:12:58 +0000781 }
Chris Lattner708148e2004-10-10 23:14:11 +0000782
783 if (Changed) {
Chris Lattnerbdff5482009-08-23 04:37:46 +0000784 DEBUG(errs() << "OPTIMIZED LOADS FROM STORED ONCE POINTER: " << *GV);
Chris Lattner708148e2004-10-10 23:14:11 +0000785 ++NumGlobUses;
786 }
787
Chris Lattner708148e2004-10-10 23:14:11 +0000788 // If we nuked all of the loads, then none of the stores are needed either,
789 // nor is the global.
Chris Lattner92c6bd22009-01-14 00:12:58 +0000790 if (AllNonStoreUsesGone) {
Chris Lattnerbdff5482009-08-23 04:37:46 +0000791 DEBUG(errs() << " *** GLOBAL NOW DEAD!\n");
Owen Anderson50895512009-07-06 18:42:36 +0000792 CleanupConstantGlobalUsers(GV, 0, Context);
Chris Lattner708148e2004-10-10 23:14:11 +0000793 if (GV->use_empty()) {
Chris Lattner7a7ed022004-10-16 18:09:00 +0000794 GV->eraseFromParent();
Chris Lattner708148e2004-10-10 23:14:11 +0000795 ++NumDeleted;
796 }
797 Changed = true;
798 }
799 return Changed;
800}
801
Chris Lattner30ba5692004-10-11 05:54:41 +0000802/// ConstantPropUsersOf - Walk the use list of V, constant folding all of the
803/// instructions that are foldable.
Owen Andersone922c022009-07-22 00:24:57 +0000804static void ConstantPropUsersOf(Value *V, LLVMContext &Context) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000805 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; )
806 if (Instruction *I = dyn_cast<Instruction>(*UI++))
Owen Anderson50895512009-07-06 18:42:36 +0000807 if (Constant *NewC = ConstantFoldInstruction(I, Context)) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000808 I->replaceAllUsesWith(NewC);
809
Chris Lattnerd514d822005-02-01 01:23:31 +0000810 // Advance UI to the next non-I use to avoid invalidating it!
811 // Instructions could multiply use V.
812 while (UI != E && *UI == I)
Chris Lattner30ba5692004-10-11 05:54:41 +0000813 ++UI;
Chris Lattnerd514d822005-02-01 01:23:31 +0000814 I->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000815 }
816}
817
818/// OptimizeGlobalAddressOfMalloc - This function takes the specified global
819/// variable, and transforms the program as if it always contained the result of
820/// the specified malloc. Because it is always the result of the specified
821/// malloc, there is no reason to actually DO the malloc. Instead, turn the
Chris Lattner6e8fbad2006-11-30 17:32:29 +0000822/// malloc into a global, and any loads of GV as uses of the new global.
Chris Lattner30ba5692004-10-11 05:54:41 +0000823static GlobalVariable *OptimizeGlobalAddressOfMalloc(GlobalVariable *GV,
Owen Anderson14ce9ef2009-07-06 01:34:54 +0000824 MallocInst *MI,
Owen Andersone922c022009-07-22 00:24:57 +0000825 LLVMContext &Context) {
Chris Lattnerbdff5482009-08-23 04:37:46 +0000826 DEBUG(errs() << "PROMOTING MALLOC GLOBAL: " << *GV << " MALLOC = " << *MI);
Chris Lattner30ba5692004-10-11 05:54:41 +0000827 ConstantInt *NElements = cast<ConstantInt>(MI->getArraySize());
828
Reid Spencerb83eb642006-10-20 07:07:24 +0000829 if (NElements->getZExtValue() != 1) {
Chris Lattner30ba5692004-10-11 05:54:41 +0000830 // If we have an array allocation, transform it to a single element
831 // allocation to make the code below simpler.
Owen Andersondebcb012009-07-29 22:17:13 +0000832 Type *NewTy = ArrayType::get(MI->getAllocatedType(),
Reid Spencerb83eb642006-10-20 07:07:24 +0000833 NElements->getZExtValue());
Chris Lattner30ba5692004-10-11 05:54:41 +0000834 MallocInst *NewMI =
Owen Anderson1d0be152009-08-13 21:58:54 +0000835 new MallocInst(NewTy, Constant::getNullValue(Type::getInt32Ty(Context)),
Nate Begeman14b05292005-11-05 09:21:28 +0000836 MI->getAlignment(), MI->getName(), MI);
Chris Lattner699d1442007-01-31 19:59:55 +0000837 Value* Indices[2];
Owen Anderson1d0be152009-08-13 21:58:54 +0000838 Indices[0] = Indices[1] = Constant::getNullValue(Type::getInt32Ty(Context));
Gabor Greif051a9502008-04-06 20:25:17 +0000839 Value *NewGEP = GetElementPtrInst::Create(NewMI, Indices, Indices + 2,
840 NewMI->getName()+".el0", MI);
Chris Lattner30ba5692004-10-11 05:54:41 +0000841 MI->replaceAllUsesWith(NewGEP);
Chris Lattner7a7ed022004-10-16 18:09:00 +0000842 MI->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000843 MI = NewMI;
844 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000845
Chris Lattner7a7ed022004-10-16 18:09:00 +0000846 // Create the new global variable. The contents of the malloc'd memory is
847 // undefined, so initialize with an undef value.
Chris Lattner998182b2008-04-26 07:40:11 +0000848 // FIXME: This new global should have the alignment returned by malloc. Code
849 // could depend on malloc returning large alignment (on the mac, 16 bytes) but
850 // this would only guarantee some lower alignment.
Owen Anderson9e9a0d52009-07-30 23:03:37 +0000851 Constant *Init = UndefValue::get(MI->getAllocatedType());
Owen Andersone9b11b42009-07-08 19:03:57 +0000852 GlobalVariable *NewGV = new GlobalVariable(*GV->getParent(),
853 MI->getAllocatedType(), false,
854 GlobalValue::InternalLinkage, Init,
855 GV->getName()+".body",
856 GV,
857 GV->isThreadLocal());
858
Chris Lattner30ba5692004-10-11 05:54:41 +0000859 // Anything that used the malloc now uses the global directly.
860 MI->replaceAllUsesWith(NewGV);
Chris Lattner30ba5692004-10-11 05:54:41 +0000861
862 Constant *RepValue = NewGV;
863 if (NewGV->getType() != GV->getType()->getElementType())
Owen Andersonbaf3c402009-07-29 18:55:55 +0000864 RepValue = ConstantExpr::getBitCast(RepValue,
Reid Spencerd977d862006-12-12 23:36:14 +0000865 GV->getType()->getElementType());
Chris Lattner30ba5692004-10-11 05:54:41 +0000866
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000867 // If there is a comparison against null, we will insert a global bool to
868 // keep track of whether the global was initialized yet or not.
Misha Brukmanfd939082005-04-21 23:48:37 +0000869 GlobalVariable *InitBool =
Owen Anderson1d0be152009-08-13 21:58:54 +0000870 new GlobalVariable(Context, Type::getInt1Ty(Context), false,
Owen Anderson3d29df32009-07-08 01:26:06 +0000871 GlobalValue::InternalLinkage,
Owen Anderson5defacc2009-07-31 17:39:07 +0000872 ConstantInt::getFalse(Context), GV->getName()+".init",
Owen Andersone9b11b42009-07-08 19:03:57 +0000873 GV->isThreadLocal());
Chris Lattnerbc965b92004-12-02 06:25:58 +0000874 bool InitBoolUsed = false;
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000875
Chris Lattner30ba5692004-10-11 05:54:41 +0000876 // Loop over all uses of GV, processing them in turn.
Chris Lattnerbc965b92004-12-02 06:25:58 +0000877 std::vector<StoreInst*> Stores;
Chris Lattner30ba5692004-10-11 05:54:41 +0000878 while (!GV->use_empty())
879 if (LoadInst *LI = dyn_cast<LoadInst>(GV->use_back())) {
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000880 while (!LI->use_empty()) {
Chris Lattnerd514d822005-02-01 01:23:31 +0000881 Use &LoadUse = LI->use_begin().getUse();
Reid Spencere4d87aa2006-12-23 06:05:41 +0000882 if (!isa<ICmpInst>(LoadUse.getUser()))
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000883 LoadUse = RepValue;
884 else {
Reid Spencere4d87aa2006-12-23 06:05:41 +0000885 ICmpInst *CI = cast<ICmpInst>(LoadUse.getUser());
886 // Replace the cmp X, 0 with a use of the bool value.
887 Value *LV = new LoadInst(InitBool, InitBool->getName()+".val", CI);
Chris Lattnerbc965b92004-12-02 06:25:58 +0000888 InitBoolUsed = true;
Reid Spencere4d87aa2006-12-23 06:05:41 +0000889 switch (CI->getPredicate()) {
Torok Edwinc23197a2009-07-14 16:55:14 +0000890 default: llvm_unreachable("Unknown ICmp Predicate!");
Reid Spencere4d87aa2006-12-23 06:05:41 +0000891 case ICmpInst::ICMP_ULT:
892 case ICmpInst::ICMP_SLT:
Owen Anderson5defacc2009-07-31 17:39:07 +0000893 LV = ConstantInt::getFalse(Context); // X < null -> always false
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000894 break;
Reid Spencere4d87aa2006-12-23 06:05:41 +0000895 case ICmpInst::ICMP_ULE:
896 case ICmpInst::ICMP_SLE:
897 case ICmpInst::ICMP_EQ:
Dan Gohman4ae51262009-08-12 16:23:25 +0000898 LV = BinaryOperator::CreateNot(LV, "notinit", CI);
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000899 break;
Reid Spencere4d87aa2006-12-23 06:05:41 +0000900 case ICmpInst::ICMP_NE:
901 case ICmpInst::ICMP_UGE:
902 case ICmpInst::ICMP_SGE:
903 case ICmpInst::ICMP_UGT:
904 case ICmpInst::ICMP_SGT:
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000905 break; // no change.
906 }
Reid Spencere4d87aa2006-12-23 06:05:41 +0000907 CI->replaceAllUsesWith(LV);
908 CI->eraseFromParent();
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000909 }
910 }
Chris Lattner7a7ed022004-10-16 18:09:00 +0000911 LI->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000912 } else {
913 StoreInst *SI = cast<StoreInst>(GV->use_back());
Chris Lattnerbc965b92004-12-02 06:25:58 +0000914 // The global is initialized when the store to it occurs.
Owen Anderson5defacc2009-07-31 17:39:07 +0000915 new StoreInst(ConstantInt::getTrue(Context), InitBool, SI);
Chris Lattner7a7ed022004-10-16 18:09:00 +0000916 SI->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000917 }
918
Chris Lattnerbc965b92004-12-02 06:25:58 +0000919 // If the initialization boolean was used, insert it, otherwise delete it.
920 if (!InitBoolUsed) {
921 while (!InitBool->use_empty()) // Delete initializations
922 cast<Instruction>(InitBool->use_back())->eraseFromParent();
923 delete InitBool;
924 } else
925 GV->getParent()->getGlobalList().insert(GV, InitBool);
926
927
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000928 // Now the GV is dead, nuke it and the malloc.
Chris Lattner7a7ed022004-10-16 18:09:00 +0000929 GV->eraseFromParent();
Chris Lattnere9ece2a2004-10-22 06:43:28 +0000930 MI->eraseFromParent();
Chris Lattner30ba5692004-10-11 05:54:41 +0000931
932 // To further other optimizations, loop over all users of NewGV and try to
933 // constant prop them. This will promote GEP instructions with constant
934 // indices into GEP constant-exprs, which will allow global-opt to hack on it.
Owen Anderson50895512009-07-06 18:42:36 +0000935 ConstantPropUsersOf(NewGV, Context);
Chris Lattner30ba5692004-10-11 05:54:41 +0000936 if (RepValue != NewGV)
Owen Anderson50895512009-07-06 18:42:36 +0000937 ConstantPropUsersOf(RepValue, Context);
Chris Lattner30ba5692004-10-11 05:54:41 +0000938
939 return NewGV;
940}
Chris Lattner708148e2004-10-10 23:14:11 +0000941
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000942/// ValueIsOnlyUsedLocallyOrStoredToOneGlobal - Scan the use-list of V checking
943/// to make sure that there are no complex uses of V. We permit simple things
944/// like dereferencing the pointer, but not storing through the address, unless
945/// it is to the specified global.
946static bool ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Instruction *V,
Chris Lattnerc451f9c2007-09-13 16:37:20 +0000947 GlobalVariable *GV,
948 SmallPtrSet<PHINode*, 8> &PHIs) {
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000949 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
Jay Foad0906b1b2009-06-06 17:49:35 +0000950 Instruction *Inst = cast<Instruction>(*UI);
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000951
952 if (isa<LoadInst>(Inst) || isa<CmpInst>(Inst)) {
953 continue; // Fine, ignore.
954 }
955
956 if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000957 if (SI->getOperand(0) == V && SI->getOperand(1) != GV)
958 return false; // Storing the pointer itself... bad.
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000959 continue; // Otherwise, storing through it, or storing into GV... fine.
960 }
961
962 if (isa<GetElementPtrInst>(Inst)) {
963 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Inst, GV, PHIs))
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000964 return false;
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000965 continue;
966 }
967
968 if (PHINode *PN = dyn_cast<PHINode>(Inst)) {
Chris Lattnerc451f9c2007-09-13 16:37:20 +0000969 // PHIs are ok if all uses are ok. Don't infinitely recurse through PHI
970 // cycles.
971 if (PHIs.insert(PN))
Chris Lattner5e6e4942007-09-14 03:41:21 +0000972 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(PN, GV, PHIs))
973 return false;
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000974 continue;
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000975 }
Chris Lattner49b6d4a2008-12-15 21:08:54 +0000976
977 if (BitCastInst *BCI = dyn_cast<BitCastInst>(Inst)) {
978 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(BCI, GV, PHIs))
979 return false;
980 continue;
981 }
982
983 return false;
984 }
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000985 return true;
Chris Lattnerfa07e4f2004-12-02 07:11:07 +0000986}
987
Chris Lattner86395032006-09-30 23:32:09 +0000988/// ReplaceUsesOfMallocWithGlobal - The Alloc pointer is stored into GV
989/// somewhere. Transform all uses of the allocation into loads from the
990/// global and uses of the resultant pointer. Further, delete the store into
991/// GV. This assumes that these value pass the
992/// 'ValueIsOnlyUsedLocallyOrStoredToOneGlobal' predicate.
993static void ReplaceUsesOfMallocWithGlobal(Instruction *Alloc,
994 GlobalVariable *GV) {
995 while (!Alloc->use_empty()) {
Chris Lattnera637a8b2007-09-13 18:00:31 +0000996 Instruction *U = cast<Instruction>(*Alloc->use_begin());
997 Instruction *InsertPt = U;
Chris Lattner86395032006-09-30 23:32:09 +0000998 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
999 // If this is the store of the allocation into the global, remove it.
1000 if (SI->getOperand(1) == GV) {
1001 SI->eraseFromParent();
1002 continue;
1003 }
Chris Lattnera637a8b2007-09-13 18:00:31 +00001004 } else if (PHINode *PN = dyn_cast<PHINode>(U)) {
1005 // Insert the load in the corresponding predecessor, not right before the
1006 // PHI.
Gabor Greifa36791d2009-01-23 19:40:15 +00001007 InsertPt = PN->getIncomingBlock(Alloc->use_begin())->getTerminator();
Chris Lattner101f44e2008-12-15 21:44:34 +00001008 } else if (isa<BitCastInst>(U)) {
1009 // Must be bitcast between the malloc and store to initialize the global.
1010 ReplaceUsesOfMallocWithGlobal(U, GV);
1011 U->eraseFromParent();
1012 continue;
1013 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
1014 // If this is a "GEP bitcast" and the user is a store to the global, then
1015 // just process it as a bitcast.
1016 if (GEPI->hasAllZeroIndices() && GEPI->hasOneUse())
1017 if (StoreInst *SI = dyn_cast<StoreInst>(GEPI->use_back()))
1018 if (SI->getOperand(1) == GV) {
1019 // Must be bitcast GEP between the malloc and store to initialize
1020 // the global.
1021 ReplaceUsesOfMallocWithGlobal(GEPI, GV);
1022 GEPI->eraseFromParent();
1023 continue;
1024 }
Chris Lattner86395032006-09-30 23:32:09 +00001025 }
Chris Lattner101f44e2008-12-15 21:44:34 +00001026
Chris Lattner86395032006-09-30 23:32:09 +00001027 // Insert a load from the global, and use it instead of the malloc.
Chris Lattnera637a8b2007-09-13 18:00:31 +00001028 Value *NL = new LoadInst(GV, GV->getName()+".val", InsertPt);
Chris Lattner86395032006-09-30 23:32:09 +00001029 U->replaceUsesOfWith(Alloc, NL);
1030 }
1031}
1032
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001033/// LoadUsesSimpleEnoughForHeapSRA - Verify that all uses of V (a load, or a phi
1034/// of a load) are simple enough to perform heap SRA on. This permits GEP's
1035/// that index through the array and struct field, icmps of null, and PHIs.
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001036static bool LoadUsesSimpleEnoughForHeapSRA(Value *V,
Evan Cheng5d163962009-06-02 00:56:07 +00001037 SmallPtrSet<PHINode*, 32> &LoadUsingPHIs,
1038 SmallPtrSet<PHINode*, 32> &LoadUsingPHIsPerLoad) {
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001039 // We permit two users of the load: setcc comparing against the null
1040 // pointer, and a getelementptr of a specific form.
1041 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
1042 Instruction *User = cast<Instruction>(*UI);
1043
1044 // Comparison against null is ok.
1045 if (ICmpInst *ICI = dyn_cast<ICmpInst>(User)) {
1046 if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
1047 return false;
1048 continue;
1049 }
1050
1051 // getelementptr is also ok, but only a simple form.
1052 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
1053 // Must index into the array and into the struct.
1054 if (GEPI->getNumOperands() < 3)
1055 return false;
1056
1057 // Otherwise the GEP is ok.
1058 continue;
1059 }
1060
1061 if (PHINode *PN = dyn_cast<PHINode>(User)) {
Evan Cheng5d163962009-06-02 00:56:07 +00001062 if (!LoadUsingPHIsPerLoad.insert(PN))
1063 // This means some phi nodes are dependent on each other.
1064 // Avoid infinite looping!
1065 return false;
1066 if (!LoadUsingPHIs.insert(PN))
1067 // If we have already analyzed this PHI, then it is safe.
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001068 continue;
1069
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001070 // Make sure all uses of the PHI are simple enough to transform.
Evan Cheng5d163962009-06-02 00:56:07 +00001071 if (!LoadUsesSimpleEnoughForHeapSRA(PN,
1072 LoadUsingPHIs, LoadUsingPHIsPerLoad))
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001073 return false;
1074
1075 continue;
Chris Lattner86395032006-09-30 23:32:09 +00001076 }
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001077
1078 // Otherwise we don't know what this is, not ok.
1079 return false;
1080 }
1081
1082 return true;
1083}
1084
1085
1086/// AllGlobalLoadUsesSimpleEnoughForHeapSRA - If all users of values loaded from
1087/// GV are simple enough to perform HeapSRA, return true.
1088static bool AllGlobalLoadUsesSimpleEnoughForHeapSRA(GlobalVariable *GV,
1089 MallocInst *MI) {
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001090 SmallPtrSet<PHINode*, 32> LoadUsingPHIs;
Evan Cheng5d163962009-06-02 00:56:07 +00001091 SmallPtrSet<PHINode*, 32> LoadUsingPHIsPerLoad;
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001092 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI != E;
1093 ++UI)
Evan Cheng5d163962009-06-02 00:56:07 +00001094 if (LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
1095 if (!LoadUsesSimpleEnoughForHeapSRA(LI, LoadUsingPHIs,
1096 LoadUsingPHIsPerLoad))
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001097 return false;
Evan Cheng5d163962009-06-02 00:56:07 +00001098 LoadUsingPHIsPerLoad.clear();
1099 }
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001100
1101 // If we reach here, we know that all uses of the loads and transitive uses
1102 // (through PHI nodes) are simple enough to transform. However, we don't know
1103 // that all inputs the to the PHI nodes are in the same equivalence sets.
1104 // Check to verify that all operands of the PHIs are either PHIS that can be
1105 // transformed, loads from GV, or MI itself.
1106 for (SmallPtrSet<PHINode*, 32>::iterator I = LoadUsingPHIs.begin(),
1107 E = LoadUsingPHIs.end(); I != E; ++I) {
1108 PHINode *PN = *I;
1109 for (unsigned op = 0, e = PN->getNumIncomingValues(); op != e; ++op) {
1110 Value *InVal = PN->getIncomingValue(op);
1111
1112 // PHI of the stored value itself is ok.
1113 if (InVal == MI) continue;
1114
1115 if (PHINode *InPN = dyn_cast<PHINode>(InVal)) {
1116 // One of the PHIs in our set is (optimistically) ok.
1117 if (LoadUsingPHIs.count(InPN))
1118 continue;
1119 return false;
1120 }
1121
1122 // Load from GV is ok.
1123 if (LoadInst *LI = dyn_cast<LoadInst>(InVal))
1124 if (LI->getOperand(0) == GV)
1125 continue;
1126
1127 // UNDEF? NULL?
1128
1129 // Anything else is rejected.
1130 return false;
1131 }
1132 }
1133
Chris Lattner86395032006-09-30 23:32:09 +00001134 return true;
1135}
1136
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001137static Value *GetHeapSROAValue(Value *V, unsigned FieldNo,
1138 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001139 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite,
Owen Andersone922c022009-07-22 00:24:57 +00001140 LLVMContext &Context) {
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001141 std::vector<Value*> &FieldVals = InsertedScalarizedValues[V];
1142
1143 if (FieldNo >= FieldVals.size())
1144 FieldVals.resize(FieldNo+1);
1145
1146 // If we already have this value, just reuse the previously scalarized
1147 // version.
1148 if (Value *FieldVal = FieldVals[FieldNo])
1149 return FieldVal;
1150
1151 // Depending on what instruction this is, we have several cases.
1152 Value *Result;
1153 if (LoadInst *LI = dyn_cast<LoadInst>(V)) {
1154 // This is a scalarized version of the load from the global. Just create
1155 // a new Load of the scalarized global.
1156 Result = new LoadInst(GetHeapSROAValue(LI->getOperand(0), FieldNo,
1157 InsertedScalarizedValues,
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001158 PHIsToRewrite, Context),
Daniel Dunbarfe09b202009-07-30 17:37:43 +00001159 LI->getName()+".f"+Twine(FieldNo), LI);
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001160 } else if (PHINode *PN = dyn_cast<PHINode>(V)) {
1161 // PN's type is pointer to struct. Make a new PHI of pointer to struct
1162 // field.
1163 const StructType *ST =
1164 cast<StructType>(cast<PointerType>(PN->getType())->getElementType());
1165
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001166 Result =
Owen Andersondebcb012009-07-29 22:17:13 +00001167 PHINode::Create(PointerType::getUnqual(ST->getElementType(FieldNo)),
Daniel Dunbarfe09b202009-07-30 17:37:43 +00001168 PN->getName()+".f"+Twine(FieldNo), PN);
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001169 PHIsToRewrite.push_back(std::make_pair(PN, FieldNo));
1170 } else {
Torok Edwinc23197a2009-07-14 16:55:14 +00001171 llvm_unreachable("Unknown usable value");
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001172 Result = 0;
1173 }
1174
1175 return FieldVals[FieldNo] = Result;
Chris Lattnera637a8b2007-09-13 18:00:31 +00001176}
1177
Chris Lattner330245e2007-09-13 17:29:05 +00001178/// RewriteHeapSROALoadUser - Given a load instruction and a value derived from
1179/// the load, rewrite the derived value to use the HeapSRoA'd load.
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001180static void RewriteHeapSROALoadUser(Instruction *LoadUser,
1181 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001182 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite,
Owen Andersone922c022009-07-22 00:24:57 +00001183 LLVMContext &Context) {
Chris Lattner330245e2007-09-13 17:29:05 +00001184 // If this is a comparison against null, handle it.
1185 if (ICmpInst *SCI = dyn_cast<ICmpInst>(LoadUser)) {
1186 assert(isa<ConstantPointerNull>(SCI->getOperand(1)));
1187 // If we have a setcc of the loaded pointer, we can use a setcc of any
1188 // field.
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001189 Value *NPtr = GetHeapSROAValue(SCI->getOperand(0), 0,
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001190 InsertedScalarizedValues, PHIsToRewrite,
1191 Context);
Chris Lattner330245e2007-09-13 17:29:05 +00001192
Owen Anderson333c4002009-07-09 23:48:35 +00001193 Value *New = new ICmpInst(SCI, SCI->getPredicate(), NPtr,
Owen Andersona7235ea2009-07-31 20:28:14 +00001194 Constant::getNullValue(NPtr->getType()),
Owen Anderson333c4002009-07-09 23:48:35 +00001195 SCI->getName());
Chris Lattner330245e2007-09-13 17:29:05 +00001196 SCI->replaceAllUsesWith(New);
1197 SCI->eraseFromParent();
1198 return;
1199 }
1200
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001201 // Handle 'getelementptr Ptr, Idx, i32 FieldNo ...'
Chris Lattnera637a8b2007-09-13 18:00:31 +00001202 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(LoadUser)) {
1203 assert(GEPI->getNumOperands() >= 3 && isa<ConstantInt>(GEPI->getOperand(2))
1204 && "Unexpected GEPI!");
Chris Lattner330245e2007-09-13 17:29:05 +00001205
Chris Lattnera637a8b2007-09-13 18:00:31 +00001206 // Load the pointer for this field.
1207 unsigned FieldNo = cast<ConstantInt>(GEPI->getOperand(2))->getZExtValue();
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001208 Value *NewPtr = GetHeapSROAValue(GEPI->getOperand(0), FieldNo,
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001209 InsertedScalarizedValues, PHIsToRewrite,
1210 Context);
Chris Lattnera637a8b2007-09-13 18:00:31 +00001211
1212 // Create the new GEP idx vector.
1213 SmallVector<Value*, 8> GEPIdx;
1214 GEPIdx.push_back(GEPI->getOperand(1));
1215 GEPIdx.append(GEPI->op_begin()+3, GEPI->op_end());
1216
Gabor Greifb1dbcd82008-05-15 10:04:30 +00001217 Value *NGEPI = GetElementPtrInst::Create(NewPtr,
1218 GEPIdx.begin(), GEPIdx.end(),
Gabor Greif051a9502008-04-06 20:25:17 +00001219 GEPI->getName(), GEPI);
Chris Lattnera637a8b2007-09-13 18:00:31 +00001220 GEPI->replaceAllUsesWith(NGEPI);
1221 GEPI->eraseFromParent();
1222 return;
1223 }
Chris Lattner309f20f2007-09-13 21:31:36 +00001224
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001225 // Recursively transform the users of PHI nodes. This will lazily create the
1226 // PHIs that are needed for individual elements. Keep track of what PHIs we
1227 // see in InsertedScalarizedValues so that we don't get infinite loops (very
1228 // antisocial). If the PHI is already in InsertedScalarizedValues, it has
1229 // already been seen first by another load, so its uses have already been
1230 // processed.
1231 PHINode *PN = cast<PHINode>(LoadUser);
1232 bool Inserted;
1233 DenseMap<Value*, std::vector<Value*> >::iterator InsertPos;
1234 tie(InsertPos, Inserted) =
1235 InsertedScalarizedValues.insert(std::make_pair(PN, std::vector<Value*>()));
1236 if (!Inserted) return;
Chris Lattner309f20f2007-09-13 21:31:36 +00001237
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001238 // If this is the first time we've seen this PHI, recursively process all
1239 // users.
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001240 for (Value::use_iterator UI = PN->use_begin(), E = PN->use_end(); UI != E; ) {
1241 Instruction *User = cast<Instruction>(*UI++);
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001242 RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite,
1243 Context);
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001244 }
Chris Lattner330245e2007-09-13 17:29:05 +00001245}
1246
Chris Lattner86395032006-09-30 23:32:09 +00001247/// RewriteUsesOfLoadForHeapSRoA - We are performing Heap SRoA on a global. Ptr
1248/// is a value loaded from the global. Eliminate all uses of Ptr, making them
1249/// use FieldGlobals instead. All uses of loaded values satisfy
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001250/// AllGlobalLoadUsesSimpleEnoughForHeapSRA.
Chris Lattner330245e2007-09-13 17:29:05 +00001251static void RewriteUsesOfLoadForHeapSRoA(LoadInst *Load,
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001252 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001253 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite,
Owen Andersone922c022009-07-22 00:24:57 +00001254 LLVMContext &Context) {
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001255 for (Value::use_iterator UI = Load->use_begin(), E = Load->use_end();
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001256 UI != E; ) {
1257 Instruction *User = cast<Instruction>(*UI++);
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001258 RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite,
1259 Context);
Chris Lattnerf49a28c2008-12-17 05:42:08 +00001260 }
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001261
1262 if (Load->use_empty()) {
1263 Load->eraseFromParent();
1264 InsertedScalarizedValues.erase(Load);
1265 }
Chris Lattner86395032006-09-30 23:32:09 +00001266}
1267
1268/// PerformHeapAllocSRoA - MI is an allocation of an array of structures. Break
1269/// it up into multiple allocations of arrays of the fields.
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001270static GlobalVariable *PerformHeapAllocSRoA(GlobalVariable *GV, MallocInst *MI,
Owen Andersone922c022009-07-22 00:24:57 +00001271 LLVMContext &Context){
Chris Lattnerbdff5482009-08-23 04:37:46 +00001272 DEBUG(errs() << "SROA HEAP ALLOC: " << *GV << " MALLOC = " << *MI);
Chris Lattner86395032006-09-30 23:32:09 +00001273 const StructType *STy = cast<StructType>(MI->getAllocatedType());
1274
1275 // There is guaranteed to be at least one use of the malloc (storing
1276 // it into GV). If there are other uses, change them to be uses of
1277 // the global to simplify later code. This also deletes the store
1278 // into GV.
1279 ReplaceUsesOfMallocWithGlobal(MI, GV);
1280
1281 // Okay, at this point, there are no users of the malloc. Insert N
1282 // new mallocs at the same place as MI, and N globals.
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001283 std::vector<Value*> FieldGlobals;
Chris Lattner86395032006-09-30 23:32:09 +00001284 std::vector<MallocInst*> FieldMallocs;
1285
1286 for (unsigned FieldNo = 0, e = STy->getNumElements(); FieldNo != e;++FieldNo){
1287 const Type *FieldTy = STy->getElementType(FieldNo);
Owen Andersondebcb012009-07-29 22:17:13 +00001288 const Type *PFieldTy = PointerType::getUnqual(FieldTy);
Chris Lattner86395032006-09-30 23:32:09 +00001289
1290 GlobalVariable *NGV =
Owen Andersone9b11b42009-07-08 19:03:57 +00001291 new GlobalVariable(*GV->getParent(),
1292 PFieldTy, false, GlobalValue::InternalLinkage,
Owen Andersona7235ea2009-07-31 20:28:14 +00001293 Constant::getNullValue(PFieldTy),
Daniel Dunbarfe09b202009-07-30 17:37:43 +00001294 GV->getName() + ".f" + Twine(FieldNo), GV,
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00001295 GV->isThreadLocal());
Chris Lattner86395032006-09-30 23:32:09 +00001296 FieldGlobals.push_back(NGV);
1297
Owen Anderson50dead02009-07-15 23:53:25 +00001298 MallocInst *NMI = new MallocInst(FieldTy, MI->getArraySize(),
Daniel Dunbarfe09b202009-07-30 17:37:43 +00001299 MI->getName() + ".f" + Twine(FieldNo), MI);
Chris Lattner86395032006-09-30 23:32:09 +00001300 FieldMallocs.push_back(NMI);
1301 new StoreInst(NMI, NGV, MI);
1302 }
1303
1304 // The tricky aspect of this transformation is handling the case when malloc
1305 // fails. In the original code, malloc failing would set the result pointer
1306 // of malloc to null. In this case, some mallocs could succeed and others
1307 // could fail. As such, we emit code that looks like this:
1308 // F0 = malloc(field0)
1309 // F1 = malloc(field1)
1310 // F2 = malloc(field2)
1311 // if (F0 == 0 || F1 == 0 || F2 == 0) {
1312 // if (F0) { free(F0); F0 = 0; }
1313 // if (F1) { free(F1); F1 = 0; }
1314 // if (F2) { free(F2); F2 = 0; }
1315 // }
1316 Value *RunningOr = 0;
1317 for (unsigned i = 0, e = FieldMallocs.size(); i != e; ++i) {
Owen Anderson333c4002009-07-09 23:48:35 +00001318 Value *Cond = new ICmpInst(MI, ICmpInst::ICMP_EQ, FieldMallocs[i],
Owen Andersona7235ea2009-07-31 20:28:14 +00001319 Constant::getNullValue(FieldMallocs[i]->getType()),
Owen Anderson333c4002009-07-09 23:48:35 +00001320 "isnull");
Chris Lattner86395032006-09-30 23:32:09 +00001321 if (!RunningOr)
1322 RunningOr = Cond; // First seteq
1323 else
Gabor Greif7cbd8a32008-05-16 19:29:10 +00001324 RunningOr = BinaryOperator::CreateOr(RunningOr, Cond, "tmp", MI);
Chris Lattner86395032006-09-30 23:32:09 +00001325 }
1326
1327 // Split the basic block at the old malloc.
1328 BasicBlock *OrigBB = MI->getParent();
1329 BasicBlock *ContBB = OrigBB->splitBasicBlock(MI, "malloc_cont");
1330
1331 // Create the block to check the first condition. Put all these blocks at the
1332 // end of the function as they are unlikely to be executed.
Owen Anderson1d0be152009-08-13 21:58:54 +00001333 BasicBlock *NullPtrBlock = BasicBlock::Create(Context, "malloc_ret_null",
Gabor Greif051a9502008-04-06 20:25:17 +00001334 OrigBB->getParent());
Chris Lattner86395032006-09-30 23:32:09 +00001335
1336 // Remove the uncond branch from OrigBB to ContBB, turning it into a cond
1337 // branch on RunningOr.
1338 OrigBB->getTerminator()->eraseFromParent();
Gabor Greif051a9502008-04-06 20:25:17 +00001339 BranchInst::Create(NullPtrBlock, ContBB, RunningOr, OrigBB);
Chris Lattner86395032006-09-30 23:32:09 +00001340
1341 // Within the NullPtrBlock, we need to emit a comparison and branch for each
1342 // pointer, because some may be null while others are not.
1343 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1344 Value *GVVal = new LoadInst(FieldGlobals[i], "tmp", NullPtrBlock);
Owen Anderson333c4002009-07-09 23:48:35 +00001345 Value *Cmp = new ICmpInst(*NullPtrBlock, ICmpInst::ICMP_NE, GVVal,
Owen Andersona7235ea2009-07-31 20:28:14 +00001346 Constant::getNullValue(GVVal->getType()),
Owen Anderson333c4002009-07-09 23:48:35 +00001347 "tmp");
Owen Anderson1d0be152009-08-13 21:58:54 +00001348 BasicBlock *FreeBlock = BasicBlock::Create(Context, "free_it",
1349 OrigBB->getParent());
1350 BasicBlock *NextBlock = BasicBlock::Create(Context, "next",
1351 OrigBB->getParent());
Gabor Greif051a9502008-04-06 20:25:17 +00001352 BranchInst::Create(FreeBlock, NextBlock, Cmp, NullPtrBlock);
Chris Lattner86395032006-09-30 23:32:09 +00001353
1354 // Fill in FreeBlock.
1355 new FreeInst(GVVal, FreeBlock);
Owen Andersona7235ea2009-07-31 20:28:14 +00001356 new StoreInst(Constant::getNullValue(GVVal->getType()), FieldGlobals[i],
Chris Lattner86395032006-09-30 23:32:09 +00001357 FreeBlock);
Gabor Greif051a9502008-04-06 20:25:17 +00001358 BranchInst::Create(NextBlock, FreeBlock);
Chris Lattner86395032006-09-30 23:32:09 +00001359
1360 NullPtrBlock = NextBlock;
1361 }
1362
Gabor Greif051a9502008-04-06 20:25:17 +00001363 BranchInst::Create(ContBB, NullPtrBlock);
Chris Lattner86395032006-09-30 23:32:09 +00001364
1365 // MI is no longer needed, remove it.
1366 MI->eraseFromParent();
1367
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001368 /// InsertedScalarizedLoads - As we process loads, if we can't immediately
1369 /// update all uses of the load, keep track of what scalarized loads are
1370 /// inserted for a given load.
1371 DenseMap<Value*, std::vector<Value*> > InsertedScalarizedValues;
1372 InsertedScalarizedValues[GV] = FieldGlobals;
1373
1374 std::vector<std::pair<PHINode*, unsigned> > PHIsToRewrite;
Chris Lattner86395032006-09-30 23:32:09 +00001375
1376 // Okay, the malloc site is completely handled. All of the uses of GV are now
1377 // loads, and all uses of those loads are simple. Rewrite them to use loads
1378 // of the per-field globals instead.
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001379 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI != E;) {
1380 Instruction *User = cast<Instruction>(*UI++);
1381
1382 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001383 RewriteUsesOfLoadForHeapSRoA(LI, InsertedScalarizedValues, PHIsToRewrite,
1384 Context);
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001385 continue;
Chris Lattner39ff1e22007-01-09 23:29:37 +00001386 }
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001387
1388 // Must be a store of null.
1389 StoreInst *SI = cast<StoreInst>(User);
1390 assert(isa<ConstantPointerNull>(SI->getOperand(0)) &&
1391 "Unexpected heap-sra user!");
1392
1393 // Insert a store of null into each global.
1394 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1395 const PointerType *PT = cast<PointerType>(FieldGlobals[i]->getType());
Owen Andersona7235ea2009-07-31 20:28:14 +00001396 Constant *Null = Constant::getNullValue(PT->getElementType());
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001397 new StoreInst(Null, FieldGlobals[i], SI);
1398 }
1399 // Erase the original store.
1400 SI->eraseFromParent();
Chris Lattner86395032006-09-30 23:32:09 +00001401 }
1402
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001403 // While we have PHIs that are interesting to rewrite, do it.
1404 while (!PHIsToRewrite.empty()) {
1405 PHINode *PN = PHIsToRewrite.back().first;
1406 unsigned FieldNo = PHIsToRewrite.back().second;
1407 PHIsToRewrite.pop_back();
1408 PHINode *FieldPN = cast<PHINode>(InsertedScalarizedValues[PN][FieldNo]);
1409 assert(FieldPN->getNumIncomingValues() == 0 &&"Already processed this phi");
1410
1411 // Add all the incoming values. This can materialize more phis.
1412 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1413 Value *InVal = PN->getIncomingValue(i);
1414 InVal = GetHeapSROAValue(InVal, FieldNo, InsertedScalarizedValues,
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001415 PHIsToRewrite, Context);
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001416 FieldPN->addIncoming(InVal, PN->getIncomingBlock(i));
1417 }
1418 }
1419
1420 // Drop all inter-phi links and any loads that made it this far.
1421 for (DenseMap<Value*, std::vector<Value*> >::iterator
1422 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1423 I != E; ++I) {
1424 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1425 PN->dropAllReferences();
1426 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1427 LI->dropAllReferences();
1428 }
1429
1430 // Delete all the phis and loads now that inter-references are dead.
1431 for (DenseMap<Value*, std::vector<Value*> >::iterator
1432 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1433 I != E; ++I) {
1434 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1435 PN->eraseFromParent();
1436 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1437 LI->eraseFromParent();
1438 }
1439
Chris Lattner86395032006-09-30 23:32:09 +00001440 // The old global is now dead, remove it.
1441 GV->eraseFromParent();
1442
1443 ++NumHeapSRA;
Chris Lattnerbce4afe2008-12-17 05:28:49 +00001444 return cast<GlobalVariable>(FieldGlobals[0]);
Chris Lattner86395032006-09-30 23:32:09 +00001445}
1446
Chris Lattnere61d0a62008-12-15 21:02:25 +00001447/// TryToOptimizeStoreOfMallocToGlobal - This function is called when we see a
1448/// pointer global variable with a single value stored it that is a malloc or
1449/// cast of malloc.
1450static bool TryToOptimizeStoreOfMallocToGlobal(GlobalVariable *GV,
1451 MallocInst *MI,
1452 Module::global_iterator &GVI,
Dan Gohman7eb28f32009-08-14 00:11:03 +00001453 TargetData *TD,
Owen Andersone922c022009-07-22 00:24:57 +00001454 LLVMContext &Context) {
Chris Lattnere61d0a62008-12-15 21:02:25 +00001455 // If this is a malloc of an abstract type, don't touch it.
1456 if (!MI->getAllocatedType()->isSized())
1457 return false;
1458
1459 // We can't optimize this global unless all uses of it are *known* to be
1460 // of the malloc value, not of the null initializer value (consider a use
1461 // that compares the global's value against zero to see if the malloc has
1462 // been reached). To do this, we check to see if all uses of the global
1463 // would trap if the global were null: this proves that they must all
1464 // happen after the malloc.
1465 if (!AllUsesOfLoadedValueWillTrapIfNull(GV))
1466 return false;
1467
1468 // We can't optimize this if the malloc itself is used in a complex way,
1469 // for example, being stored into multiple globals. This allows the
1470 // malloc to be stored into the specified global, loaded setcc'd, and
1471 // GEP'd. These are all things we could transform to using the global
1472 // for.
1473 {
1474 SmallPtrSet<PHINode*, 8> PHIs;
1475 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(MI, GV, PHIs))
1476 return false;
1477 }
1478
1479
1480 // If we have a global that is only initialized with a fixed size malloc,
1481 // transform the program to use global memory instead of malloc'd memory.
1482 // This eliminates dynamic allocation, avoids an indirection accessing the
1483 // data, and exposes the resultant global to further GlobalOpt.
1484 if (ConstantInt *NElements = dyn_cast<ConstantInt>(MI->getArraySize())) {
1485 // Restrict this transformation to only working on small allocations
1486 // (2048 bytes currently), as we don't want to introduce a 16M global or
1487 // something.
Dan Gohman7eb28f32009-08-14 00:11:03 +00001488 if (TD &&
1489 NElements->getZExtValue()*
1490 TD->getTypeAllocSize(MI->getAllocatedType()) < 2048) {
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001491 GVI = OptimizeGlobalAddressOfMalloc(GV, MI, Context);
Chris Lattnere61d0a62008-12-15 21:02:25 +00001492 return true;
1493 }
1494 }
1495
1496 // If the allocation is an array of structures, consider transforming this
1497 // into multiple malloc'd arrays, one for each field. This is basically
1498 // SRoA for malloc'd memory.
Chris Lattner101f44e2008-12-15 21:44:34 +00001499 const Type *AllocTy = MI->getAllocatedType();
1500
1501 // If this is an allocation of a fixed size array of structs, analyze as a
1502 // variable size array. malloc [100 x struct],1 -> malloc struct, 100
1503 if (!MI->isArrayAllocation())
1504 if (const ArrayType *AT = dyn_cast<ArrayType>(AllocTy))
1505 AllocTy = AT->getElementType();
1506
1507 if (const StructType *AllocSTy = dyn_cast<StructType>(AllocTy)) {
Chris Lattnere61d0a62008-12-15 21:02:25 +00001508 // This the structure has an unreasonable number of fields, leave it
1509 // alone.
Chris Lattner101f44e2008-12-15 21:44:34 +00001510 if (AllocSTy->getNumElements() <= 16 && AllocSTy->getNumElements() != 0 &&
Chris Lattner85d3d4f2008-12-16 21:24:51 +00001511 AllGlobalLoadUsesSimpleEnoughForHeapSRA(GV, MI)) {
Chris Lattner101f44e2008-12-15 21:44:34 +00001512
1513 // If this is a fixed size array, transform the Malloc to be an alloc of
1514 // structs. malloc [100 x struct],1 -> malloc struct, 100
1515 if (const ArrayType *AT = dyn_cast<ArrayType>(MI->getAllocatedType())) {
1516 MallocInst *NewMI =
Owen Anderson50dead02009-07-15 23:53:25 +00001517 new MallocInst(AllocSTy,
Owen Anderson1d0be152009-08-13 21:58:54 +00001518 ConstantInt::get(Type::getInt32Ty(Context),
1519 AT->getNumElements()),
Chris Lattner101f44e2008-12-15 21:44:34 +00001520 "", MI);
1521 NewMI->takeName(MI);
1522 Value *Cast = new BitCastInst(NewMI, MI->getType(), "tmp", MI);
1523 MI->replaceAllUsesWith(Cast);
1524 MI->eraseFromParent();
1525 MI = NewMI;
1526 }
1527
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001528 GVI = PerformHeapAllocSRoA(GV, MI, Context);
Chris Lattnere61d0a62008-12-15 21:02:25 +00001529 return true;
1530 }
1531 }
1532
1533 return false;
1534}
Chris Lattner86395032006-09-30 23:32:09 +00001535
Chris Lattner9b34a612004-10-09 21:48:45 +00001536// OptimizeOnceStoredGlobal - Try to optimize globals based on the knowledge
1537// that only one value (besides its initializer) is ever stored to the global.
Chris Lattner30ba5692004-10-11 05:54:41 +00001538static bool OptimizeOnceStoredGlobal(GlobalVariable *GV, Value *StoredOnceVal,
Chris Lattner7f8897f2006-08-27 22:42:52 +00001539 Module::global_iterator &GVI,
Dan Gohman7eb28f32009-08-14 00:11:03 +00001540 TargetData *TD, LLVMContext &Context) {
Chris Lattner344b41c2008-12-15 21:20:32 +00001541 // Ignore no-op GEPs and bitcasts.
1542 StoredOnceVal = StoredOnceVal->stripPointerCasts();
Chris Lattner9b34a612004-10-09 21:48:45 +00001543
Chris Lattner708148e2004-10-10 23:14:11 +00001544 // If we are dealing with a pointer global that is initialized to null and
1545 // only has one (non-null) value stored into it, then we can optimize any
1546 // users of the loaded value (often calls and loads) that would trap if the
1547 // value was null.
Chris Lattner9b34a612004-10-09 21:48:45 +00001548 if (isa<PointerType>(GV->getInitializer()->getType()) &&
1549 GV->getInitializer()->isNullValue()) {
Chris Lattner708148e2004-10-10 23:14:11 +00001550 if (Constant *SOVC = dyn_cast<Constant>(StoredOnceVal)) {
1551 if (GV->getInitializer()->getType() != SOVC->getType())
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001552 SOVC =
Owen Andersonbaf3c402009-07-29 18:55:55 +00001553 ConstantExpr::getBitCast(SOVC, GV->getInitializer()->getType());
Misha Brukmanfd939082005-04-21 23:48:37 +00001554
Chris Lattner708148e2004-10-10 23:14:11 +00001555 // Optimize away any trapping uses of the loaded value.
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001556 if (OptimizeAwayTrappingUsesOfLoads(GV, SOVC, Context))
Chris Lattner8be80122004-10-10 17:07:12 +00001557 return true;
Chris Lattner30ba5692004-10-11 05:54:41 +00001558 } else if (MallocInst *MI = dyn_cast<MallocInst>(StoredOnceVal)) {
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001559 if (TryToOptimizeStoreOfMallocToGlobal(GV, MI, GVI, TD, Context))
Chris Lattnere61d0a62008-12-15 21:02:25 +00001560 return true;
Chris Lattner708148e2004-10-10 23:14:11 +00001561 }
Chris Lattner9b34a612004-10-09 21:48:45 +00001562 }
Chris Lattner30ba5692004-10-11 05:54:41 +00001563
Chris Lattner9b34a612004-10-09 21:48:45 +00001564 return false;
1565}
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001566
Chris Lattner58e44f42008-01-14 01:17:44 +00001567/// TryToShrinkGlobalToBoolean - At this point, we have learned that the only
1568/// two values ever stored into GV are its initializer and OtherVal. See if we
1569/// can shrink the global into a boolean and select between the two values
1570/// whenever it is used. This exposes the values to other scalar optimizations.
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001571static bool TryToShrinkGlobalToBoolean(GlobalVariable *GV, Constant *OtherVal,
Owen Andersone922c022009-07-22 00:24:57 +00001572 LLVMContext &Context) {
Chris Lattner58e44f42008-01-14 01:17:44 +00001573 const Type *GVElType = GV->getType()->getElementType();
1574
1575 // If GVElType is already i1, it is already shrunk. If the type of the GV is
Chris Lattner6f6923f2009-03-07 23:32:02 +00001576 // an FP value, pointer or vector, don't do this optimization because a select
1577 // between them is very expensive and unlikely to lead to later
1578 // simplification. In these cases, we typically end up with "cond ? v1 : v2"
1579 // where v1 and v2 both require constant pool loads, a big loss.
Owen Anderson1d0be152009-08-13 21:58:54 +00001580 if (GVElType == Type::getInt1Ty(Context) || GVElType->isFloatingPoint() ||
Chris Lattner6f6923f2009-03-07 23:32:02 +00001581 isa<PointerType>(GVElType) || isa<VectorType>(GVElType))
Chris Lattner58e44f42008-01-14 01:17:44 +00001582 return false;
1583
1584 // Walk the use list of the global seeing if all the uses are load or store.
1585 // If there is anything else, bail out.
1586 for (Value::use_iterator I = GV->use_begin(), E = GV->use_end(); I != E; ++I)
Devang Patel771281f2009-03-06 01:39:36 +00001587 if (!isa<LoadInst>(I) && !isa<StoreInst>(I))
Chris Lattner58e44f42008-01-14 01:17:44 +00001588 return false;
1589
Chris Lattnerbdff5482009-08-23 04:37:46 +00001590 DEBUG(errs() << " *** SHRINKING TO BOOL: " << *GV);
Chris Lattner58e44f42008-01-14 01:17:44 +00001591
Chris Lattner96a86b22004-12-12 05:53:50 +00001592 // Create the new global, initializing it to false.
Owen Anderson1d0be152009-08-13 21:58:54 +00001593 GlobalVariable *NewGV = new GlobalVariable(Context,
1594 Type::getInt1Ty(Context), false,
Owen Anderson5defacc2009-07-31 17:39:07 +00001595 GlobalValue::InternalLinkage, ConstantInt::getFalse(Context),
Nick Lewycky0e670df2009-05-03 03:49:08 +00001596 GV->getName()+".b",
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00001597 GV->isThreadLocal());
Chris Lattner96a86b22004-12-12 05:53:50 +00001598 GV->getParent()->getGlobalList().insert(GV, NewGV);
1599
1600 Constant *InitVal = GV->getInitializer();
Owen Anderson1d0be152009-08-13 21:58:54 +00001601 assert(InitVal->getType() != Type::getInt1Ty(Context) &&
1602 "No reason to shrink to bool!");
Chris Lattner96a86b22004-12-12 05:53:50 +00001603
1604 // If initialized to zero and storing one into the global, we can use a cast
1605 // instead of a select to synthesize the desired value.
1606 bool IsOneZero = false;
1607 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal))
Reid Spencercae57542007-03-02 00:28:52 +00001608 IsOneZero = InitVal->isNullValue() && CI->isOne();
Chris Lattner96a86b22004-12-12 05:53:50 +00001609
1610 while (!GV->use_empty()) {
Devang Patel771281f2009-03-06 01:39:36 +00001611 Instruction *UI = cast<Instruction>(GV->use_back());
1612 if (StoreInst *SI = dyn_cast<StoreInst>(UI)) {
Chris Lattner96a86b22004-12-12 05:53:50 +00001613 // Change the store into a boolean store.
1614 bool StoringOther = SI->getOperand(0) == OtherVal;
1615 // Only do this if we weren't storing a loaded value.
Chris Lattner38c25562004-12-12 19:34:41 +00001616 Value *StoreVal;
Chris Lattner96a86b22004-12-12 05:53:50 +00001617 if (StoringOther || SI->getOperand(0) == InitVal)
Owen Anderson1d0be152009-08-13 21:58:54 +00001618 StoreVal = ConstantInt::get(Type::getInt1Ty(Context), StoringOther);
Chris Lattner38c25562004-12-12 19:34:41 +00001619 else {
1620 // Otherwise, we are storing a previously loaded copy. To do this,
1621 // change the copy from copying the original value to just copying the
1622 // bool.
1623 Instruction *StoredVal = cast<Instruction>(SI->getOperand(0));
1624
1625 // If we're already replaced the input, StoredVal will be a cast or
1626 // select instruction. If not, it will be a load of the original
1627 // global.
1628 if (LoadInst *LI = dyn_cast<LoadInst>(StoredVal)) {
1629 assert(LI->getOperand(0) == GV && "Not a copy!");
1630 // Insert a new load, to preserve the saved value.
1631 StoreVal = new LoadInst(NewGV, LI->getName()+".b", LI);
1632 } else {
1633 assert((isa<CastInst>(StoredVal) || isa<SelectInst>(StoredVal)) &&
1634 "This is not a form that we understand!");
1635 StoreVal = StoredVal->getOperand(0);
1636 assert(isa<LoadInst>(StoreVal) && "Not a load of NewGV!");
1637 }
1638 }
1639 new StoreInst(StoreVal, NewGV, SI);
Devang Patel771281f2009-03-06 01:39:36 +00001640 } else {
Chris Lattner96a86b22004-12-12 05:53:50 +00001641 // Change the load into a load of bool then a select.
Devang Patel771281f2009-03-06 01:39:36 +00001642 LoadInst *LI = cast<LoadInst>(UI);
Chris Lattner046800a2007-02-11 01:08:35 +00001643 LoadInst *NLI = new LoadInst(NewGV, LI->getName()+".b", LI);
Chris Lattner96a86b22004-12-12 05:53:50 +00001644 Value *NSI;
1645 if (IsOneZero)
Chris Lattner046800a2007-02-11 01:08:35 +00001646 NSI = new ZExtInst(NLI, LI->getType(), "", LI);
Misha Brukmanfd939082005-04-21 23:48:37 +00001647 else
Gabor Greif051a9502008-04-06 20:25:17 +00001648 NSI = SelectInst::Create(NLI, OtherVal, InitVal, "", LI);
Chris Lattner046800a2007-02-11 01:08:35 +00001649 NSI->takeName(LI);
Chris Lattner96a86b22004-12-12 05:53:50 +00001650 LI->replaceAllUsesWith(NSI);
Devang Patel771281f2009-03-06 01:39:36 +00001651 }
1652 UI->eraseFromParent();
Chris Lattner96a86b22004-12-12 05:53:50 +00001653 }
1654
1655 GV->eraseFromParent();
Chris Lattner58e44f42008-01-14 01:17:44 +00001656 return true;
Chris Lattner96a86b22004-12-12 05:53:50 +00001657}
1658
1659
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001660/// ProcessInternalGlobal - Analyze the specified global variable and optimize
1661/// it if possible. If we make a change, return true.
Chris Lattner30ba5692004-10-11 05:54:41 +00001662bool GlobalOpt::ProcessInternalGlobal(GlobalVariable *GV,
Chris Lattnere4d5c442005-03-15 04:54:21 +00001663 Module::global_iterator &GVI) {
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00001664 SmallPtrSet<PHINode*, 16> PHIUsers;
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001665 GlobalStatus GS;
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001666 GV->removeDeadConstantUsers();
1667
1668 if (GV->use_empty()) {
Chris Lattnerbdff5482009-08-23 04:37:46 +00001669 DEBUG(errs() << "GLOBAL DEAD: " << *GV);
Chris Lattner7a7ed022004-10-16 18:09:00 +00001670 GV->eraseFromParent();
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001671 ++NumDeleted;
1672 return true;
1673 }
1674
1675 if (!AnalyzeGlobal(GV, GS, PHIUsers)) {
Chris Lattnercff16732006-09-30 19:40:30 +00001676#if 0
Bill Wendlinge8156192006-12-07 01:30:32 +00001677 cerr << "Global: " << *GV;
1678 cerr << " isLoaded = " << GS.isLoaded << "\n";
1679 cerr << " StoredType = ";
Chris Lattnercff16732006-09-30 19:40:30 +00001680 switch (GS.StoredType) {
Bill Wendlinge8156192006-12-07 01:30:32 +00001681 case GlobalStatus::NotStored: cerr << "NEVER STORED\n"; break;
1682 case GlobalStatus::isInitializerStored: cerr << "INIT STORED\n"; break;
1683 case GlobalStatus::isStoredOnce: cerr << "STORED ONCE\n"; break;
1684 case GlobalStatus::isStored: cerr << "stored\n"; break;
Chris Lattnercff16732006-09-30 19:40:30 +00001685 }
1686 if (GS.StoredType == GlobalStatus::isStoredOnce && GS.StoredOnceValue)
Bill Wendlinge8156192006-12-07 01:30:32 +00001687 cerr << " StoredOnceValue = " << *GS.StoredOnceValue << "\n";
Chris Lattnercff16732006-09-30 19:40:30 +00001688 if (GS.AccessingFunction && !GS.HasMultipleAccessingFunctions)
Bill Wendlinge8156192006-12-07 01:30:32 +00001689 cerr << " AccessingFunction = " << GS.AccessingFunction->getName()
Chris Lattnercff16732006-09-30 19:40:30 +00001690 << "\n";
Bill Wendlinge8156192006-12-07 01:30:32 +00001691 cerr << " HasMultipleAccessingFunctions = "
Chris Lattnercff16732006-09-30 19:40:30 +00001692 << GS.HasMultipleAccessingFunctions << "\n";
Bill Wendlinge8156192006-12-07 01:30:32 +00001693 cerr << " HasNonInstructionUser = " << GS.HasNonInstructionUser<<"\n";
Bill Wendlinge8156192006-12-07 01:30:32 +00001694 cerr << "\n";
Chris Lattnercff16732006-09-30 19:40:30 +00001695#endif
1696
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +00001697 // If this is a first class global and has only one accessing function
1698 // and this function is main (which we know is not recursive we can make
1699 // this global a local variable) we replace the global with a local alloca
1700 // in this function.
1701 //
Dan Gohman399101a2008-05-23 00:17:26 +00001702 // NOTE: It doesn't make sense to promote non single-value types since we
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +00001703 // are just replacing static memory to stack memory.
Sanjiv Gupta059aa8c2009-06-17 06:47:15 +00001704 //
1705 // If the global is in different address space, don't bring it to stack.
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +00001706 if (!GS.HasMultipleAccessingFunctions &&
Chris Lattner553ca522005-06-15 21:11:48 +00001707 GS.AccessingFunction && !GS.HasNonInstructionUser &&
Dan Gohman399101a2008-05-23 00:17:26 +00001708 GV->getType()->getElementType()->isSingleValueType() &&
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +00001709 GS.AccessingFunction->getName() == "main" &&
Sanjiv Gupta059aa8c2009-06-17 06:47:15 +00001710 GS.AccessingFunction->hasExternalLinkage() &&
1711 GV->getType()->getAddressSpace() == 0) {
Chris Lattnerbdff5482009-08-23 04:37:46 +00001712 DEBUG(errs() << "LOCALIZING GLOBAL: " << *GV);
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +00001713 Instruction* FirstI = GS.AccessingFunction->getEntryBlock().begin();
1714 const Type* ElemTy = GV->getType()->getElementType();
Nate Begeman14b05292005-11-05 09:21:28 +00001715 // FIXME: Pass Global's alignment when globals have alignment
Owen Anderson50dead02009-07-15 23:53:25 +00001716 AllocaInst* Alloca = new AllocaInst(ElemTy, NULL, GV->getName(), FirstI);
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +00001717 if (!isa<UndefValue>(GV->getInitializer()))
1718 new StoreInst(GV->getInitializer(), Alloca, FirstI);
Misha Brukmanfd939082005-04-21 23:48:37 +00001719
Alkis Evlogimenosf64ea9d2005-02-10 18:36:30 +00001720 GV->replaceAllUsesWith(Alloca);
1721 GV->eraseFromParent();
1722 ++NumLocalized;
1723 return true;
1724 }
Chris Lattnercff16732006-09-30 19:40:30 +00001725
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001726 // If the global is never loaded (but may be stored to), it is dead.
1727 // Delete it now.
1728 if (!GS.isLoaded) {
Chris Lattnerbdff5482009-08-23 04:37:46 +00001729 DEBUG(errs() << "GLOBAL NEVER LOADED: " << *GV);
Chris Lattner930f4752004-10-09 03:32:52 +00001730
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001731 // Delete any stores we can find to the global. We may not be able to
1732 // make it completely dead though.
Owen Anderson50895512009-07-06 18:42:36 +00001733 bool Changed = CleanupConstantGlobalUsers(GV, GV->getInitializer(),
Owen Andersone922c022009-07-22 00:24:57 +00001734 GV->getContext());
Chris Lattner930f4752004-10-09 03:32:52 +00001735
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001736 // If the global is dead now, delete it.
1737 if (GV->use_empty()) {
Chris Lattner7a7ed022004-10-16 18:09:00 +00001738 GV->eraseFromParent();
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001739 ++NumDeleted;
Chris Lattner930f4752004-10-09 03:32:52 +00001740 Changed = true;
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001741 }
Chris Lattner930f4752004-10-09 03:32:52 +00001742 return Changed;
Misha Brukmanfd939082005-04-21 23:48:37 +00001743
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001744 } else if (GS.StoredType <= GlobalStatus::isInitializerStored) {
Chris Lattnerbdff5482009-08-23 04:37:46 +00001745 DEBUG(errs() << "MARKING CONSTANT: " << *GV);
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001746 GV->setConstant(true);
Misha Brukmanfd939082005-04-21 23:48:37 +00001747
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001748 // Clean up any obviously simplifiable users now.
Owen Andersone922c022009-07-22 00:24:57 +00001749 CleanupConstantGlobalUsers(GV, GV->getInitializer(), GV->getContext());
Misha Brukmanfd939082005-04-21 23:48:37 +00001750
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001751 // If the global is dead now, just nuke it.
1752 if (GV->use_empty()) {
Chris Lattnerbdff5482009-08-23 04:37:46 +00001753 DEBUG(errs() << " *** Marking constant allowed us to simplify "
1754 << "all users and delete global!\n");
Chris Lattner7a7ed022004-10-16 18:09:00 +00001755 GV->eraseFromParent();
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001756 ++NumDeleted;
1757 }
Misha Brukmanfd939082005-04-21 23:48:37 +00001758
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001759 ++NumMarked;
1760 return true;
Dan Gohman399101a2008-05-23 00:17:26 +00001761 } else if (!GV->getInitializer()->getType()->isSingleValueType()) {
Dan Gohman7eb28f32009-08-14 00:11:03 +00001762 if (TargetData *TD = getAnalysisIfAvailable<TargetData>())
1763 if (GlobalVariable *FirstNewGV = SRAGlobal(GV, *TD,
1764 GV->getContext())) {
1765 GVI = FirstNewGV; // Don't skip the newly produced globals!
1766 return true;
1767 }
Chris Lattner9b34a612004-10-09 21:48:45 +00001768 } else if (GS.StoredType == GlobalStatus::isStoredOnce) {
Chris Lattner96a86b22004-12-12 05:53:50 +00001769 // If the initial value for the global was an undef value, and if only
1770 // one other value was stored into it, we can just change the
Duncan Sandsb5024402009-01-13 13:48:44 +00001771 // initializer to be the stored value, then delete all stores to the
Chris Lattner96a86b22004-12-12 05:53:50 +00001772 // global. This allows us to mark it constant.
1773 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1774 if (isa<UndefValue>(GV->getInitializer())) {
1775 // Change the initial value here.
1776 GV->setInitializer(SOVConstant);
Misha Brukmanfd939082005-04-21 23:48:37 +00001777
Chris Lattner96a86b22004-12-12 05:53:50 +00001778 // Clean up any obviously simplifiable users now.
Owen Andersone922c022009-07-22 00:24:57 +00001779 CleanupConstantGlobalUsers(GV, GV->getInitializer(),
1780 GV->getContext());
Misha Brukmanfd939082005-04-21 23:48:37 +00001781
Chris Lattner96a86b22004-12-12 05:53:50 +00001782 if (GV->use_empty()) {
Chris Lattnerbdff5482009-08-23 04:37:46 +00001783 DEBUG(errs() << " *** Substituting initializer allowed us to "
1784 << "simplify all users and delete global!\n");
Chris Lattner96a86b22004-12-12 05:53:50 +00001785 GV->eraseFromParent();
1786 ++NumDeleted;
1787 } else {
1788 GVI = GV;
1789 }
1790 ++NumSubstitute;
1791 return true;
Chris Lattner7a7ed022004-10-16 18:09:00 +00001792 }
Chris Lattner7a7ed022004-10-16 18:09:00 +00001793
Chris Lattner9b34a612004-10-09 21:48:45 +00001794 // Try to optimize globals based on the knowledge that only one value
1795 // (besides its initializer) is ever stored to the global.
Chris Lattner30ba5692004-10-11 05:54:41 +00001796 if (OptimizeOnceStoredGlobal(GV, GS.StoredOnceValue, GVI,
Dan Gohman7eb28f32009-08-14 00:11:03 +00001797 getAnalysisIfAvailable<TargetData>(),
1798 GV->getContext()))
Chris Lattner9b34a612004-10-09 21:48:45 +00001799 return true;
Chris Lattner96a86b22004-12-12 05:53:50 +00001800
1801 // Otherwise, if the global was not a boolean, we can shrink it to be a
1802 // boolean.
1803 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
Owen Andersone922c022009-07-22 00:24:57 +00001804 if (TryToShrinkGlobalToBoolean(GV, SOVConstant, GV->getContext())) {
Chris Lattner96a86b22004-12-12 05:53:50 +00001805 ++NumShrunkToBool;
1806 return true;
1807 }
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001808 }
1809 }
1810 return false;
1811}
1812
Chris Lattnerfb217ad2005-05-08 22:18:06 +00001813/// ChangeCalleesToFastCall - Walk all of the direct calls of the specified
1814/// function, changing them to FastCC.
1815static void ChangeCalleesToFastCall(Function *F) {
1816 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
Duncan Sands548448a2008-02-18 17:32:13 +00001817 CallSite User(cast<Instruction>(*UI));
1818 User.setCallingConv(CallingConv::Fast);
Chris Lattnerfb217ad2005-05-08 22:18:06 +00001819 }
1820}
Chris Lattnera4be1dc2004-10-08 20:59:28 +00001821
Devang Patel05988662008-09-25 21:00:45 +00001822static AttrListPtr StripNest(const AttrListPtr &Attrs) {
Chris Lattner58d74912008-03-12 17:45:29 +00001823 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Devang Patel05988662008-09-25 21:00:45 +00001824 if ((Attrs.getSlot(i).Attrs & Attribute::Nest) == 0)
Duncan Sands548448a2008-02-18 17:32:13 +00001825 continue;
1826
Duncan Sands548448a2008-02-18 17:32:13 +00001827 // There can be only one.
Devang Patel05988662008-09-25 21:00:45 +00001828 return Attrs.removeAttr(Attrs.getSlot(i).Index, Attribute::Nest);
Duncan Sands3d5378f2008-02-16 20:56:04 +00001829 }
1830
1831 return Attrs;
1832}
1833
1834static void RemoveNestAttribute(Function *F) {
Devang Patel05988662008-09-25 21:00:45 +00001835 F->setAttributes(StripNest(F->getAttributes()));
Duncan Sands3d5378f2008-02-16 20:56:04 +00001836 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
Duncan Sands548448a2008-02-18 17:32:13 +00001837 CallSite User(cast<Instruction>(*UI));
Devang Patel05988662008-09-25 21:00:45 +00001838 User.setAttributes(StripNest(User.getAttributes()));
Duncan Sands3d5378f2008-02-16 20:56:04 +00001839 }
1840}
1841
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001842bool GlobalOpt::OptimizeFunctions(Module &M) {
1843 bool Changed = false;
1844 // Optimize functions.
1845 for (Module::iterator FI = M.begin(), E = M.end(); FI != E; ) {
1846 Function *F = FI++;
Duncan Sandsfc5940d2009-03-06 10:21:56 +00001847 // Functions without names cannot be referenced outside this module.
1848 if (!F->hasName() && !F->isDeclaration())
1849 F->setLinkage(GlobalValue::InternalLinkage);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001850 F->removeDeadConstantUsers();
Rafael Espindolabb46f522009-01-15 20:18:42 +00001851 if (F->use_empty() && (F->hasLocalLinkage() ||
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001852 F->hasLinkOnceLinkage())) {
1853 M.getFunctionList().erase(F);
1854 Changed = true;
1855 ++NumFnDeleted;
Rafael Espindolabb46f522009-01-15 20:18:42 +00001856 } else if (F->hasLocalLinkage()) {
Duncan Sands3d5378f2008-02-16 20:56:04 +00001857 if (F->getCallingConv() == CallingConv::C && !F->isVarArg() &&
Jay Foad757068f2009-06-10 08:41:11 +00001858 !F->hasAddressTaken()) {
Duncan Sands3d5378f2008-02-16 20:56:04 +00001859 // If this function has C calling conventions, is not a varargs
1860 // function, and is only called directly, promote it to use the Fast
1861 // calling convention.
1862 F->setCallingConv(CallingConv::Fast);
1863 ChangeCalleesToFastCall(F);
1864 ++NumFastCallFns;
1865 Changed = true;
1866 }
1867
Devang Patel05988662008-09-25 21:00:45 +00001868 if (F->getAttributes().hasAttrSomewhere(Attribute::Nest) &&
Jay Foad757068f2009-06-10 08:41:11 +00001869 !F->hasAddressTaken()) {
Duncan Sands3d5378f2008-02-16 20:56:04 +00001870 // The function is not used by a trampoline intrinsic, so it is safe
1871 // to remove the 'nest' attribute.
1872 RemoveNestAttribute(F);
1873 ++NumNestRemoved;
1874 Changed = true;
1875 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001876 }
1877 }
1878 return Changed;
1879}
1880
1881bool GlobalOpt::OptimizeGlobalVars(Module &M) {
1882 bool Changed = false;
1883 for (Module::global_iterator GVI = M.global_begin(), E = M.global_end();
1884 GVI != E; ) {
1885 GlobalVariable *GV = GVI++;
Duncan Sandsfc5940d2009-03-06 10:21:56 +00001886 // Global variables without names cannot be referenced outside this module.
1887 if (!GV->hasName() && !GV->isDeclaration())
1888 GV->setLinkage(GlobalValue::InternalLinkage);
Rafael Espindolabb46f522009-01-15 20:18:42 +00001889 if (!GV->isConstant() && GV->hasLocalLinkage() &&
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001890 GV->hasInitializer())
1891 Changed |= ProcessInternalGlobal(GV, GVI);
1892 }
1893 return Changed;
1894}
1895
1896/// FindGlobalCtors - Find the llvm.globalctors list, verifying that all
1897/// initializers have an init priority of 65535.
1898GlobalVariable *GlobalOpt::FindGlobalCtors(Module &M) {
Alkis Evlogimenose9c6d362005-10-25 11:18:06 +00001899 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
1900 I != E; ++I)
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001901 if (I->getName() == "llvm.global_ctors") {
1902 // Found it, verify it's an array of { int, void()* }.
1903 const ArrayType *ATy =dyn_cast<ArrayType>(I->getType()->getElementType());
1904 if (!ATy) return 0;
1905 const StructType *STy = dyn_cast<StructType>(ATy->getElementType());
1906 if (!STy || STy->getNumElements() != 2 ||
Owen Anderson1d0be152009-08-13 21:58:54 +00001907 STy->getElementType(0) != Type::getInt32Ty(M.getContext())) return 0;
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001908 const PointerType *PFTy = dyn_cast<PointerType>(STy->getElementType(1));
1909 if (!PFTy) return 0;
1910 const FunctionType *FTy = dyn_cast<FunctionType>(PFTy->getElementType());
Owen Anderson1d0be152009-08-13 21:58:54 +00001911 if (!FTy || FTy->getReturnType() != Type::getVoidTy(M.getContext()) ||
1912 FTy->isVarArg() || FTy->getNumParams() != 0)
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001913 return 0;
1914
1915 // Verify that the initializer is simple enough for us to handle.
Dan Gohman82555732009-08-19 18:20:44 +00001916 if (!I->hasDefinitiveInitializer()) return 0;
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001917 ConstantArray *CA = dyn_cast<ConstantArray>(I->getInitializer());
1918 if (!CA) return 0;
Gabor Greif5e463212008-05-29 01:59:18 +00001919 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i)
1920 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(*i)) {
Chris Lattner7d8e58f2005-09-26 02:19:27 +00001921 if (isa<ConstantPointerNull>(CS->getOperand(1)))
1922 continue;
1923
1924 // Must have a function or null ptr.
1925 if (!isa<Function>(CS->getOperand(1)))
1926 return 0;
1927
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001928 // Init priority must be standard.
1929 ConstantInt *CI = dyn_cast<ConstantInt>(CS->getOperand(0));
Reid Spencerb83eb642006-10-20 07:07:24 +00001930 if (!CI || CI->getZExtValue() != 65535)
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001931 return 0;
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001932 } else {
1933 return 0;
1934 }
1935
1936 return I;
1937 }
1938 return 0;
1939}
1940
Chris Lattnerdb973e62005-09-26 02:31:18 +00001941/// ParseGlobalCtors - Given a llvm.global_ctors list that we can understand,
1942/// return a list of the functions and null terminator as a vector.
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001943static std::vector<Function*> ParseGlobalCtors(GlobalVariable *GV) {
1944 ConstantArray *CA = cast<ConstantArray>(GV->getInitializer());
1945 std::vector<Function*> Result;
1946 Result.reserve(CA->getNumOperands());
Gabor Greif5e463212008-05-29 01:59:18 +00001947 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i) {
1948 ConstantStruct *CS = cast<ConstantStruct>(*i);
Chris Lattnerb1ab4582005-09-26 01:43:45 +00001949 Result.push_back(dyn_cast<Function>(CS->getOperand(1)));
1950 }
1951 return Result;
1952}
1953
Chris Lattnerdb973e62005-09-26 02:31:18 +00001954/// InstallGlobalCtors - Given a specified llvm.global_ctors list, install the
1955/// specified array, returning the new global to use.
1956static GlobalVariable *InstallGlobalCtors(GlobalVariable *GCL,
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001957 const std::vector<Function*> &Ctors,
Owen Andersone922c022009-07-22 00:24:57 +00001958 LLVMContext &Context) {
Chris Lattnerdb973e62005-09-26 02:31:18 +00001959 // If we made a change, reassemble the initializer list.
1960 std::vector<Constant*> CSVals;
Owen Anderson1d0be152009-08-13 21:58:54 +00001961 CSVals.push_back(ConstantInt::get(Type::getInt32Ty(Context), 65535));
Chris Lattnerdb973e62005-09-26 02:31:18 +00001962 CSVals.push_back(0);
1963
1964 // Create the new init list.
1965 std::vector<Constant*> CAList;
1966 for (unsigned i = 0, e = Ctors.size(); i != e; ++i) {
Chris Lattner79c11012005-09-26 04:44:35 +00001967 if (Ctors[i]) {
Chris Lattnerdb973e62005-09-26 02:31:18 +00001968 CSVals[1] = Ctors[i];
Chris Lattner79c11012005-09-26 04:44:35 +00001969 } else {
Owen Anderson1d0be152009-08-13 21:58:54 +00001970 const Type *FTy = FunctionType::get(Type::getVoidTy(Context), false);
Owen Andersondebcb012009-07-29 22:17:13 +00001971 const PointerType *PFTy = PointerType::getUnqual(FTy);
Owen Andersona7235ea2009-07-31 20:28:14 +00001972 CSVals[1] = Constant::getNullValue(PFTy);
Owen Anderson1d0be152009-08-13 21:58:54 +00001973 CSVals[0] = ConstantInt::get(Type::getInt32Ty(Context), 2147483647);
Chris Lattnerdb973e62005-09-26 02:31:18 +00001974 }
Owen Andersond7f2a6c2009-08-05 23:16:16 +00001975 CAList.push_back(ConstantStruct::get(Context, CSVals));
Chris Lattnerdb973e62005-09-26 02:31:18 +00001976 }
1977
1978 // Create the array initializer.
1979 const Type *StructTy =
1980 cast<ArrayType>(GCL->getType()->getElementType())->getElementType();
Owen Anderson1fd70962009-07-28 18:32:17 +00001981 Constant *CA = ConstantArray::get(ArrayType::get(StructTy,
Owen Anderson14ce9ef2009-07-06 01:34:54 +00001982 CAList.size()), CAList);
Chris Lattnerdb973e62005-09-26 02:31:18 +00001983
1984 // If we didn't change the number of elements, don't create a new GV.
1985 if (CA->getType() == GCL->getInitializer()->getType()) {
1986 GCL->setInitializer(CA);
1987 return GCL;
1988 }
1989
1990 // Create the new global and insert it next to the existing list.
Owen Andersone922c022009-07-22 00:24:57 +00001991 GlobalVariable *NGV = new GlobalVariable(Context, CA->getType(),
Owen Anderson3d29df32009-07-08 01:26:06 +00001992 GCL->isConstant(),
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00001993 GCL->getLinkage(), CA, "",
Lauro Ramos Venancioc7635522007-04-12 18:32:50 +00001994 GCL->isThreadLocal());
Chris Lattnerdb973e62005-09-26 02:31:18 +00001995 GCL->getParent()->getGlobalList().insert(GCL, NGV);
Chris Lattner046800a2007-02-11 01:08:35 +00001996 NGV->takeName(GCL);
Chris Lattnerdb973e62005-09-26 02:31:18 +00001997
1998 // Nuke the old list, replacing any uses with the new one.
1999 if (!GCL->use_empty()) {
2000 Constant *V = NGV;
2001 if (V->getType() != GCL->getType())
Owen Andersonbaf3c402009-07-29 18:55:55 +00002002 V = ConstantExpr::getBitCast(V, GCL->getType());
Chris Lattnerdb973e62005-09-26 02:31:18 +00002003 GCL->replaceAllUsesWith(V);
2004 }
2005 GCL->eraseFromParent();
2006
2007 if (Ctors.size())
2008 return NGV;
2009 else
2010 return 0;
2011}
Chris Lattner79c11012005-09-26 04:44:35 +00002012
2013
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002014static Constant *getVal(DenseMap<Value*, Constant*> &ComputedValues,
Chris Lattner79c11012005-09-26 04:44:35 +00002015 Value *V) {
2016 if (Constant *CV = dyn_cast<Constant>(V)) return CV;
2017 Constant *R = ComputedValues[V];
2018 assert(R && "Reference to an uncomputed value!");
2019 return R;
2020}
2021
2022/// isSimpleEnoughPointerToCommit - Return true if this constant is simple
2023/// enough for us to understand. In particular, if it is a cast of something,
2024/// we punt. We basically just support direct accesses to globals and GEP's of
2025/// globals. This should be kept up to date with CommitValueTo.
Owen Andersone922c022009-07-22 00:24:57 +00002026static bool isSimpleEnoughPointerToCommit(Constant *C, LLVMContext &Context) {
Chris Lattner231308c2005-09-27 04:50:03 +00002027 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C)) {
Rafael Espindolabb46f522009-01-15 20:18:42 +00002028 if (!GV->hasExternalLinkage() && !GV->hasLocalLinkage())
Anton Korobeynikovb74ed072006-09-14 18:23:27 +00002029 return false; // do not allow weak/linkonce/dllimport/dllexport linkage.
Reid Spencer5cbf9852007-01-30 20:08:39 +00002030 return !GV->isDeclaration(); // reject external globals.
Chris Lattner231308c2005-09-27 04:50:03 +00002031 }
Chris Lattner798b4d52005-09-26 06:52:44 +00002032 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
2033 // Handle a constantexpr gep.
2034 if (CE->getOpcode() == Instruction::GetElementPtr &&
2035 isa<GlobalVariable>(CE->getOperand(0))) {
2036 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Rafael Espindolabb46f522009-01-15 20:18:42 +00002037 if (!GV->hasExternalLinkage() && !GV->hasLocalLinkage())
Anton Korobeynikovb74ed072006-09-14 18:23:27 +00002038 return false; // do not allow weak/linkonce/dllimport/dllexport linkage.
Chris Lattner798b4d52005-09-26 06:52:44 +00002039 return GV->hasInitializer() &&
Owen Anderson50895512009-07-06 18:42:36 +00002040 ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE,
2041 Context);
Chris Lattner798b4d52005-09-26 06:52:44 +00002042 }
Chris Lattner79c11012005-09-26 04:44:35 +00002043 return false;
2044}
2045
Chris Lattner798b4d52005-09-26 06:52:44 +00002046/// EvaluateStoreInto - Evaluate a piece of a constantexpr store into a global
2047/// initializer. This returns 'Init' modified to reflect 'Val' stored into it.
2048/// At this point, the GEP operands of Addr [0, OpNo) have been stepped into.
2049static Constant *EvaluateStoreInto(Constant *Init, Constant *Val,
Owen Anderson14ce9ef2009-07-06 01:34:54 +00002050 ConstantExpr *Addr, unsigned OpNo,
Owen Andersone922c022009-07-22 00:24:57 +00002051 LLVMContext &Context) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002052 // Base case of the recursion.
2053 if (OpNo == Addr->getNumOperands()) {
2054 assert(Val->getType() == Init->getType() && "Type mismatch!");
2055 return Val;
2056 }
2057
2058 if (const StructType *STy = dyn_cast<StructType>(Init->getType())) {
2059 std::vector<Constant*> Elts;
2060
2061 // Break up the constant into its elements.
2062 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Init)) {
Gabor Greif5e463212008-05-29 01:59:18 +00002063 for (User::op_iterator i = CS->op_begin(), e = CS->op_end(); i != e; ++i)
2064 Elts.push_back(cast<Constant>(*i));
Chris Lattner798b4d52005-09-26 06:52:44 +00002065 } else if (isa<ConstantAggregateZero>(Init)) {
2066 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
Owen Andersona7235ea2009-07-31 20:28:14 +00002067 Elts.push_back(Constant::getNullValue(STy->getElementType(i)));
Chris Lattner798b4d52005-09-26 06:52:44 +00002068 } else if (isa<UndefValue>(Init)) {
2069 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
Owen Anderson9e9a0d52009-07-30 23:03:37 +00002070 Elts.push_back(UndefValue::get(STy->getElementType(i)));
Chris Lattner798b4d52005-09-26 06:52:44 +00002071 } else {
Torok Edwinc23197a2009-07-14 16:55:14 +00002072 llvm_unreachable("This code is out of sync with "
Chris Lattner798b4d52005-09-26 06:52:44 +00002073 " ConstantFoldLoadThroughGEPConstantExpr");
2074 }
2075
2076 // Replace the element that we are supposed to.
Reid Spencerb83eb642006-10-20 07:07:24 +00002077 ConstantInt *CU = cast<ConstantInt>(Addr->getOperand(OpNo));
2078 unsigned Idx = CU->getZExtValue();
2079 assert(Idx < STy->getNumElements() && "Struct index out of range!");
Owen Anderson14ce9ef2009-07-06 01:34:54 +00002080 Elts[Idx] = EvaluateStoreInto(Elts[Idx], Val, Addr, OpNo+1, Context);
Chris Lattner798b4d52005-09-26 06:52:44 +00002081
2082 // Return the modified struct.
Owen Andersond7f2a6c2009-08-05 23:16:16 +00002083 return ConstantStruct::get(Context, &Elts[0], Elts.size(), STy->isPacked());
Chris Lattner798b4d52005-09-26 06:52:44 +00002084 } else {
2085 ConstantInt *CI = cast<ConstantInt>(Addr->getOperand(OpNo));
2086 const ArrayType *ATy = cast<ArrayType>(Init->getType());
2087
2088 // Break up the array into elements.
2089 std::vector<Constant*> Elts;
2090 if (ConstantArray *CA = dyn_cast<ConstantArray>(Init)) {
Gabor Greif5e463212008-05-29 01:59:18 +00002091 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i)
2092 Elts.push_back(cast<Constant>(*i));
Chris Lattner798b4d52005-09-26 06:52:44 +00002093 } else if (isa<ConstantAggregateZero>(Init)) {
Owen Andersona7235ea2009-07-31 20:28:14 +00002094 Constant *Elt = Constant::getNullValue(ATy->getElementType());
Chris Lattner798b4d52005-09-26 06:52:44 +00002095 Elts.assign(ATy->getNumElements(), Elt);
2096 } else if (isa<UndefValue>(Init)) {
Owen Anderson9e9a0d52009-07-30 23:03:37 +00002097 Constant *Elt = UndefValue::get(ATy->getElementType());
Chris Lattner798b4d52005-09-26 06:52:44 +00002098 Elts.assign(ATy->getNumElements(), Elt);
2099 } else {
Torok Edwinc23197a2009-07-14 16:55:14 +00002100 llvm_unreachable("This code is out of sync with "
Chris Lattner798b4d52005-09-26 06:52:44 +00002101 " ConstantFoldLoadThroughGEPConstantExpr");
2102 }
2103
Reid Spencerb83eb642006-10-20 07:07:24 +00002104 assert(CI->getZExtValue() < ATy->getNumElements());
2105 Elts[CI->getZExtValue()] =
Owen Anderson14ce9ef2009-07-06 01:34:54 +00002106 EvaluateStoreInto(Elts[CI->getZExtValue()], Val, Addr, OpNo+1, Context);
Owen Anderson1fd70962009-07-28 18:32:17 +00002107 return ConstantArray::get(ATy, Elts);
Chris Lattner798b4d52005-09-26 06:52:44 +00002108 }
2109}
2110
Chris Lattner79c11012005-09-26 04:44:35 +00002111/// CommitValueTo - We have decided that Addr (which satisfies the predicate
2112/// isSimpleEnoughPointerToCommit) should get Val as its value. Make it happen.
Owen Anderson14ce9ef2009-07-06 01:34:54 +00002113static void CommitValueTo(Constant *Val, Constant *Addr,
Owen Andersone922c022009-07-22 00:24:57 +00002114 LLVMContext &Context) {
Chris Lattner798b4d52005-09-26 06:52:44 +00002115 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Addr)) {
2116 assert(GV->hasInitializer());
2117 GV->setInitializer(Val);
2118 return;
2119 }
2120
2121 ConstantExpr *CE = cast<ConstantExpr>(Addr);
2122 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
2123
2124 Constant *Init = GV->getInitializer();
Owen Anderson14ce9ef2009-07-06 01:34:54 +00002125 Init = EvaluateStoreInto(Init, Val, CE, 2, Context);
Chris Lattner798b4d52005-09-26 06:52:44 +00002126 GV->setInitializer(Init);
Chris Lattner79c11012005-09-26 04:44:35 +00002127}
2128
Chris Lattner562a0552005-09-26 05:16:34 +00002129/// ComputeLoadResult - Return the value that would be computed by a load from
2130/// P after the stores reflected by 'memory' have been performed. If we can't
2131/// decide, return null.
Chris Lattner04de1cf2005-09-26 05:15:37 +00002132static Constant *ComputeLoadResult(Constant *P,
Owen Anderson50895512009-07-06 18:42:36 +00002133 const DenseMap<Constant*, Constant*> &Memory,
Owen Andersone922c022009-07-22 00:24:57 +00002134 LLVMContext &Context) {
Chris Lattner04de1cf2005-09-26 05:15:37 +00002135 // If this memory location has been recently stored, use the stored value: it
2136 // is the most up-to-date.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002137 DenseMap<Constant*, Constant*>::const_iterator I = Memory.find(P);
Chris Lattner04de1cf2005-09-26 05:15:37 +00002138 if (I != Memory.end()) return I->second;
2139
2140 // Access it.
2141 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(P)) {
Dan Gohman82555732009-08-19 18:20:44 +00002142 if (GV->hasDefinitiveInitializer())
Chris Lattner04de1cf2005-09-26 05:15:37 +00002143 return GV->getInitializer();
2144 return 0;
Chris Lattner04de1cf2005-09-26 05:15:37 +00002145 }
Chris Lattner798b4d52005-09-26 06:52:44 +00002146
2147 // Handle a constantexpr getelementptr.
2148 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(P))
2149 if (CE->getOpcode() == Instruction::GetElementPtr &&
2150 isa<GlobalVariable>(CE->getOperand(0))) {
2151 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Dan Gohman82555732009-08-19 18:20:44 +00002152 if (GV->hasDefinitiveInitializer())
Owen Anderson50895512009-07-06 18:42:36 +00002153 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE,
2154 Context);
Chris Lattner798b4d52005-09-26 06:52:44 +00002155 }
2156
2157 return 0; // don't know how to evaluate.
Chris Lattner04de1cf2005-09-26 05:15:37 +00002158}
2159
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002160/// EvaluateFunction - Evaluate a call to function F, returning true if
2161/// successful, false if we can't evaluate it. ActualArgs contains the formal
2162/// arguments for the function.
Chris Lattnercd271422005-09-27 04:45:34 +00002163static bool EvaluateFunction(Function *F, Constant *&RetVal,
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002164 const SmallVectorImpl<Constant*> &ActualArgs,
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002165 std::vector<Function*> &CallStack,
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002166 DenseMap<Constant*, Constant*> &MutatedMemory,
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002167 std::vector<GlobalVariable*> &AllocaTmps) {
Chris Lattnercd271422005-09-27 04:45:34 +00002168 // Check to see if this function is already executing (recursion). If so,
2169 // bail out. TODO: we might want to accept limited recursion.
2170 if (std::find(CallStack.begin(), CallStack.end(), F) != CallStack.end())
2171 return false;
2172
Owen Andersone922c022009-07-22 00:24:57 +00002173 LLVMContext &Context = F->getContext();
Owen Anderson14ce9ef2009-07-06 01:34:54 +00002174
Chris Lattnercd271422005-09-27 04:45:34 +00002175 CallStack.push_back(F);
2176
Chris Lattner79c11012005-09-26 04:44:35 +00002177 /// Values - As we compute SSA register values, we store their contents here.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002178 DenseMap<Value*, Constant*> Values;
Chris Lattnercd271422005-09-27 04:45:34 +00002179
2180 // Initialize arguments to the incoming values specified.
2181 unsigned ArgNo = 0;
2182 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end(); AI != E;
2183 ++AI, ++ArgNo)
2184 Values[AI] = ActualArgs[ArgNo];
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002185
Chris Lattnercdf98be2005-09-26 04:57:38 +00002186 /// ExecutedBlocks - We only handle non-looping, non-recursive code. As such,
2187 /// we can only evaluate any one basic block at most once. This set keeps
2188 /// track of what we have executed so we can detect recursive cases etc.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002189 SmallPtrSet<BasicBlock*, 32> ExecutedBlocks;
Chris Lattnera22fdb02005-09-26 17:07:09 +00002190
Chris Lattner79c11012005-09-26 04:44:35 +00002191 // CurInst - The current instruction we're evaluating.
2192 BasicBlock::iterator CurInst = F->begin()->begin();
2193
2194 // This is the main evaluation loop.
2195 while (1) {
2196 Constant *InstResult = 0;
2197
2198 if (StoreInst *SI = dyn_cast<StoreInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002199 if (SI->isVolatile()) return false; // no volatile accesses.
Chris Lattner79c11012005-09-26 04:44:35 +00002200 Constant *Ptr = getVal(Values, SI->getOperand(1));
Owen Anderson50895512009-07-06 18:42:36 +00002201 if (!isSimpleEnoughPointerToCommit(Ptr, Context))
Chris Lattner79c11012005-09-26 04:44:35 +00002202 // If this is too complex for us to commit, reject it.
Chris Lattnercd271422005-09-27 04:45:34 +00002203 return false;
Chris Lattner79c11012005-09-26 04:44:35 +00002204 Constant *Val = getVal(Values, SI->getOperand(0));
2205 MutatedMemory[Ptr] = Val;
2206 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(CurInst)) {
Owen Andersonbaf3c402009-07-29 18:55:55 +00002207 InstResult = ConstantExpr::get(BO->getOpcode(),
Chris Lattner79c11012005-09-26 04:44:35 +00002208 getVal(Values, BO->getOperand(0)),
2209 getVal(Values, BO->getOperand(1)));
Reid Spencere4d87aa2006-12-23 06:05:41 +00002210 } else if (CmpInst *CI = dyn_cast<CmpInst>(CurInst)) {
Owen Andersonbaf3c402009-07-29 18:55:55 +00002211 InstResult = ConstantExpr::getCompare(CI->getPredicate(),
Reid Spencere4d87aa2006-12-23 06:05:41 +00002212 getVal(Values, CI->getOperand(0)),
2213 getVal(Values, CI->getOperand(1)));
Chris Lattner79c11012005-09-26 04:44:35 +00002214 } else if (CastInst *CI = dyn_cast<CastInst>(CurInst)) {
Owen Andersonbaf3c402009-07-29 18:55:55 +00002215 InstResult = ConstantExpr::getCast(CI->getOpcode(),
Chris Lattner9a989f02006-11-30 17:26:08 +00002216 getVal(Values, CI->getOperand(0)),
Chris Lattner79c11012005-09-26 04:44:35 +00002217 CI->getType());
2218 } else if (SelectInst *SI = dyn_cast<SelectInst>(CurInst)) {
Owen Anderson14ce9ef2009-07-06 01:34:54 +00002219 InstResult =
Owen Andersonbaf3c402009-07-29 18:55:55 +00002220 ConstantExpr::getSelect(getVal(Values, SI->getOperand(0)),
Chris Lattner79c11012005-09-26 04:44:35 +00002221 getVal(Values, SI->getOperand(1)),
2222 getVal(Values, SI->getOperand(2)));
Chris Lattner04de1cf2005-09-26 05:15:37 +00002223 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(CurInst)) {
2224 Constant *P = getVal(Values, GEP->getOperand(0));
Chris Lattner55eb1c42007-01-31 04:40:53 +00002225 SmallVector<Constant*, 8> GEPOps;
Gabor Greif5e463212008-05-29 01:59:18 +00002226 for (User::op_iterator i = GEP->op_begin() + 1, e = GEP->op_end();
2227 i != e; ++i)
2228 GEPOps.push_back(getVal(Values, *i));
Owen Anderson14ce9ef2009-07-06 01:34:54 +00002229 InstResult =
Owen Andersonbaf3c402009-07-29 18:55:55 +00002230 ConstantExpr::getGetElementPtr(P, &GEPOps[0], GEPOps.size());
Chris Lattner04de1cf2005-09-26 05:15:37 +00002231 } else if (LoadInst *LI = dyn_cast<LoadInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002232 if (LI->isVolatile()) return false; // no volatile accesses.
Chris Lattner04de1cf2005-09-26 05:15:37 +00002233 InstResult = ComputeLoadResult(getVal(Values, LI->getOperand(0)),
Owen Anderson50895512009-07-06 18:42:36 +00002234 MutatedMemory, Context);
Chris Lattnercd271422005-09-27 04:45:34 +00002235 if (InstResult == 0) return false; // Could not evaluate load.
Chris Lattnera22fdb02005-09-26 17:07:09 +00002236 } else if (AllocaInst *AI = dyn_cast<AllocaInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002237 if (AI->isArrayAllocation()) return false; // Cannot handle array allocs.
Chris Lattnera22fdb02005-09-26 17:07:09 +00002238 const Type *Ty = AI->getType()->getElementType();
Owen Andersone922c022009-07-22 00:24:57 +00002239 AllocaTmps.push_back(new GlobalVariable(Context, Ty, false,
Chris Lattnera22fdb02005-09-26 17:07:09 +00002240 GlobalValue::InternalLinkage,
Owen Anderson9e9a0d52009-07-30 23:03:37 +00002241 UndefValue::get(Ty),
Chris Lattnera22fdb02005-09-26 17:07:09 +00002242 AI->getName()));
Chris Lattnercd271422005-09-27 04:45:34 +00002243 InstResult = AllocaTmps.back();
2244 } else if (CallInst *CI = dyn_cast<CallInst>(CurInst)) {
Devang Patel412a4462009-03-09 23:04:12 +00002245
2246 // Debug info can safely be ignored here.
2247 if (isa<DbgInfoIntrinsic>(CI)) {
2248 ++CurInst;
2249 continue;
2250 }
2251
Chris Lattner7cd580f2006-07-07 21:37:01 +00002252 // Cannot handle inline asm.
2253 if (isa<InlineAsm>(CI->getOperand(0))) return false;
2254
Chris Lattnercd271422005-09-27 04:45:34 +00002255 // Resolve function pointers.
2256 Function *Callee = dyn_cast<Function>(getVal(Values, CI->getOperand(0)));
2257 if (!Callee) return false; // Cannot resolve.
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002258
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002259 SmallVector<Constant*, 8> Formals;
Gabor Greif5e463212008-05-29 01:59:18 +00002260 for (User::op_iterator i = CI->op_begin() + 1, e = CI->op_end();
2261 i != e; ++i)
2262 Formals.push_back(getVal(Values, *i));
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002263
Reid Spencer5cbf9852007-01-30 20:08:39 +00002264 if (Callee->isDeclaration()) {
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002265 // If this is a function we can constant fold, do it.
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002266 if (Constant *C = ConstantFoldCall(Callee, Formals.data(),
Chris Lattner6c1f5652007-01-30 23:14:52 +00002267 Formals.size())) {
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002268 InstResult = C;
2269 } else {
2270 return false;
2271 }
2272 } else {
2273 if (Callee->getFunctionType()->isVarArg())
2274 return false;
2275
2276 Constant *RetVal;
Chris Lattnera9ec8ab2005-09-27 05:02:43 +00002277 // Execute the call, if successful, use the return value.
2278 if (!EvaluateFunction(Callee, RetVal, Formals, CallStack,
2279 MutatedMemory, AllocaTmps))
2280 return false;
2281 InstResult = RetVal;
2282 }
Reid Spencer3ed469c2006-11-02 20:25:50 +00002283 } else if (isa<TerminatorInst>(CurInst)) {
Chris Lattnercdf98be2005-09-26 04:57:38 +00002284 BasicBlock *NewBB = 0;
2285 if (BranchInst *BI = dyn_cast<BranchInst>(CurInst)) {
2286 if (BI->isUnconditional()) {
2287 NewBB = BI->getSuccessor(0);
2288 } else {
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00002289 ConstantInt *Cond =
2290 dyn_cast<ConstantInt>(getVal(Values, BI->getCondition()));
Chris Lattner97d1fad2007-01-12 18:30:11 +00002291 if (!Cond) return false; // Cannot determine.
Zhou Sheng6b6b6ef2007-01-11 12:24:14 +00002292
Reid Spencer579dca12007-01-12 04:24:46 +00002293 NewBB = BI->getSuccessor(!Cond->getZExtValue());
Chris Lattnercdf98be2005-09-26 04:57:38 +00002294 }
2295 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(CurInst)) {
2296 ConstantInt *Val =
2297 dyn_cast<ConstantInt>(getVal(Values, SI->getCondition()));
Chris Lattnercd271422005-09-27 04:45:34 +00002298 if (!Val) return false; // Cannot determine.
Chris Lattnercdf98be2005-09-26 04:57:38 +00002299 NewBB = SI->getSuccessor(SI->findCaseValue(Val));
2300 } else if (ReturnInst *RI = dyn_cast<ReturnInst>(CurInst)) {
Chris Lattnercd271422005-09-27 04:45:34 +00002301 if (RI->getNumOperands())
2302 RetVal = getVal(Values, RI->getOperand(0));
2303
2304 CallStack.pop_back(); // return from fn.
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002305 return true; // We succeeded at evaluating this ctor!
Chris Lattnercdf98be2005-09-26 04:57:38 +00002306 } else {
Chris Lattnercd271422005-09-27 04:45:34 +00002307 // invoke, unwind, unreachable.
2308 return false; // Cannot handle this terminator.
Chris Lattnercdf98be2005-09-26 04:57:38 +00002309 }
2310
2311 // Okay, we succeeded in evaluating this control flow. See if we have
Chris Lattnercd271422005-09-27 04:45:34 +00002312 // executed the new block before. If so, we have a looping function,
2313 // which we cannot evaluate in reasonable time.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002314 if (!ExecutedBlocks.insert(NewBB))
Chris Lattnercd271422005-09-27 04:45:34 +00002315 return false; // looped!
Chris Lattnercdf98be2005-09-26 04:57:38 +00002316
2317 // Okay, we have never been in this block before. Check to see if there
2318 // are any PHI nodes. If so, evaluate them with information about where
2319 // we came from.
2320 BasicBlock *OldBB = CurInst->getParent();
2321 CurInst = NewBB->begin();
2322 PHINode *PN;
2323 for (; (PN = dyn_cast<PHINode>(CurInst)); ++CurInst)
2324 Values[PN] = getVal(Values, PN->getIncomingValueForBlock(OldBB));
2325
2326 // Do NOT increment CurInst. We know that the terminator had no value.
2327 continue;
Chris Lattner79c11012005-09-26 04:44:35 +00002328 } else {
Chris Lattner79c11012005-09-26 04:44:35 +00002329 // Did not know how to evaluate this!
Chris Lattnercd271422005-09-27 04:45:34 +00002330 return false;
Chris Lattner79c11012005-09-26 04:44:35 +00002331 }
2332
2333 if (!CurInst->use_empty())
2334 Values[CurInst] = InstResult;
2335
2336 // Advance program counter.
2337 ++CurInst;
2338 }
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002339}
2340
2341/// EvaluateStaticConstructor - Evaluate static constructors in the function, if
2342/// we can. Return true if we can, false otherwise.
2343static bool EvaluateStaticConstructor(Function *F) {
2344 /// MutatedMemory - For each store we execute, we update this map. Loads
2345 /// check this to get the most up-to-date value. If evaluation is successful,
2346 /// this state is committed to the process.
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002347 DenseMap<Constant*, Constant*> MutatedMemory;
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002348
2349 /// AllocaTmps - To 'execute' an alloca, we create a temporary global variable
2350 /// to represent its body. This vector is needed so we can delete the
2351 /// temporary globals when we are done.
2352 std::vector<GlobalVariable*> AllocaTmps;
2353
2354 /// CallStack - This is used to detect recursion. In pathological situations
2355 /// we could hit exponential behavior, but at least there is nothing
2356 /// unbounded.
2357 std::vector<Function*> CallStack;
2358
2359 // Call the function.
Chris Lattnercd271422005-09-27 04:45:34 +00002360 Constant *RetValDummy;
Duncan Sandsfa6a1cf2009-08-17 14:33:27 +00002361 bool EvalSuccess = EvaluateFunction(F, RetValDummy,
2362 SmallVector<Constant*, 0>(), CallStack,
2363 MutatedMemory, AllocaTmps);
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002364 if (EvalSuccess) {
Chris Lattnera22fdb02005-09-26 17:07:09 +00002365 // We succeeded at evaluation: commit the result.
Daniel Dunbarce63ffb2009-07-25 00:23:56 +00002366 DEBUG(errs() << "FULLY EVALUATED GLOBAL CTOR FUNCTION '"
2367 << F->getName() << "' to " << MutatedMemory.size()
2368 << " stores.\n");
Chris Lattner5a6bb6a2008-12-16 07:34:30 +00002369 for (DenseMap<Constant*, Constant*>::iterator I = MutatedMemory.begin(),
Chris Lattnera22fdb02005-09-26 17:07:09 +00002370 E = MutatedMemory.end(); I != E; ++I)
Owen Anderson14ce9ef2009-07-06 01:34:54 +00002371 CommitValueTo(I->second, I->first, F->getContext());
Chris Lattnera22fdb02005-09-26 17:07:09 +00002372 }
Chris Lattner79c11012005-09-26 04:44:35 +00002373
Chris Lattnera22fdb02005-09-26 17:07:09 +00002374 // At this point, we are done interpreting. If we created any 'alloca'
2375 // temporaries, release them now.
2376 while (!AllocaTmps.empty()) {
2377 GlobalVariable *Tmp = AllocaTmps.back();
2378 AllocaTmps.pop_back();
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002379
Chris Lattnera22fdb02005-09-26 17:07:09 +00002380 // If there are still users of the alloca, the program is doing something
2381 // silly, e.g. storing the address of the alloca somewhere and using it
2382 // later. Since this is undefined, we'll just make it be null.
2383 if (!Tmp->use_empty())
Owen Andersona7235ea2009-07-31 20:28:14 +00002384 Tmp->replaceAllUsesWith(Constant::getNullValue(Tmp->getType()));
Chris Lattnera22fdb02005-09-26 17:07:09 +00002385 delete Tmp;
2386 }
Chris Lattneraae4a1c2005-09-26 07:34:35 +00002387
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002388 return EvalSuccess;
Chris Lattner79c11012005-09-26 04:44:35 +00002389}
2390
Chris Lattnerdb973e62005-09-26 02:31:18 +00002391
Chris Lattner8a7cc6e2005-09-27 04:27:01 +00002392
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002393/// OptimizeGlobalCtorsList - Simplify and evaluation global ctors if possible.
2394/// Return true if anything changed.
2395bool GlobalOpt::OptimizeGlobalCtorsList(GlobalVariable *&GCL) {
2396 std::vector<Function*> Ctors = ParseGlobalCtors(GCL);
2397 bool MadeChange = false;
2398 if (Ctors.empty()) return false;
2399
2400 // Loop over global ctors, optimizing them when we can.
2401 for (unsigned i = 0; i != Ctors.size(); ++i) {
2402 Function *F = Ctors[i];
2403 // Found a null terminator in the middle of the list, prune off the rest of
2404 // the list.
Chris Lattner7d8e58f2005-09-26 02:19:27 +00002405 if (F == 0) {
2406 if (i != Ctors.size()-1) {
2407 Ctors.resize(i+1);
2408 MadeChange = true;
2409 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002410 break;
2411 }
2412
Chris Lattner79c11012005-09-26 04:44:35 +00002413 // We cannot simplify external ctor functions.
2414 if (F->empty()) continue;
2415
2416 // If we can evaluate the ctor at compile time, do.
2417 if (EvaluateStaticConstructor(F)) {
2418 Ctors.erase(Ctors.begin()+i);
2419 MadeChange = true;
2420 --i;
2421 ++NumCtorsEvaluated;
2422 continue;
2423 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002424 }
2425
2426 if (!MadeChange) return false;
2427
Owen Andersone922c022009-07-22 00:24:57 +00002428 GCL = InstallGlobalCtors(GCL, Ctors, GCL->getContext());
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002429 return true;
2430}
2431
Duncan Sandsfc5940d2009-03-06 10:21:56 +00002432bool GlobalOpt::OptimizeGlobalAliases(Module &M) {
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002433 bool Changed = false;
2434
Duncan Sands177d84e2009-01-07 20:01:06 +00002435 for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
Duncan Sands4782b302009-02-15 09:56:08 +00002436 I != E;) {
2437 Module::alias_iterator J = I++;
Duncan Sandsfc5940d2009-03-06 10:21:56 +00002438 // Aliases without names cannot be referenced outside this module.
2439 if (!J->hasName() && !J->isDeclaration())
2440 J->setLinkage(GlobalValue::InternalLinkage);
Duncan Sands4782b302009-02-15 09:56:08 +00002441 // If the aliasee may change at link time, nothing can be done - bail out.
2442 if (J->mayBeOverridden())
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002443 continue;
2444
Duncan Sands4782b302009-02-15 09:56:08 +00002445 Constant *Aliasee = J->getAliasee();
2446 GlobalValue *Target = cast<GlobalValue>(Aliasee->stripPointerCasts());
Duncan Sands95c5d0f2009-02-18 17:55:38 +00002447 Target->removeDeadConstantUsers();
Duncan Sands4782b302009-02-15 09:56:08 +00002448 bool hasOneUse = Target->hasOneUse() && Aliasee->hasOneUse();
2449
2450 // Make all users of the alias use the aliasee instead.
2451 if (!J->use_empty()) {
2452 J->replaceAllUsesWith(Aliasee);
2453 ++NumAliasesResolved;
2454 Changed = true;
2455 }
2456
2457 // If the aliasee has internal linkage, give it the name and linkage
2458 // of the alias, and delete the alias. This turns:
2459 // define internal ... @f(...)
2460 // @a = alias ... @f
2461 // into:
2462 // define ... @a(...)
Duncan Sands7ae5b9e2009-02-17 17:50:04 +00002463 if (!Target->hasLocalLinkage())
Duncan Sands4782b302009-02-15 09:56:08 +00002464 continue;
2465
2466 // The transform is only useful if the alias does not have internal linkage.
Duncan Sands7ae5b9e2009-02-17 17:50:04 +00002467 if (J->hasLocalLinkage())
Duncan Sands4782b302009-02-15 09:56:08 +00002468 continue;
2469
Duncan Sandsa37d1192009-02-15 11:54:49 +00002470 // Do not perform the transform if multiple aliases potentially target the
2471 // aliasee. This check also ensures that it is safe to replace the section
2472 // and other attributes of the aliasee with those of the alias.
Duncan Sands4782b302009-02-15 09:56:08 +00002473 if (!hasOneUse)
2474 continue;
2475
Duncan Sandsa37d1192009-02-15 11:54:49 +00002476 // Give the aliasee the name, linkage and other attributes of the alias.
Duncan Sands4782b302009-02-15 09:56:08 +00002477 Target->takeName(J);
2478 Target->setLinkage(J->getLinkage());
Duncan Sandsa37d1192009-02-15 11:54:49 +00002479 Target->GlobalValue::copyAttributesFrom(J);
Duncan Sands4782b302009-02-15 09:56:08 +00002480
2481 // Delete the alias.
2482 M.getAliasList().erase(J);
2483 ++NumAliasesRemoved;
2484 Changed = true;
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002485 }
2486
2487 return Changed;
2488}
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002489
Chris Lattner7a90b682004-10-07 04:16:33 +00002490bool GlobalOpt::runOnModule(Module &M) {
Chris Lattner079236d2004-02-25 21:34:36 +00002491 bool Changed = false;
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002492
2493 // Try to find the llvm.globalctors list.
2494 GlobalVariable *GlobalCtors = FindGlobalCtors(M);
Chris Lattner7a90b682004-10-07 04:16:33 +00002495
Chris Lattner7a90b682004-10-07 04:16:33 +00002496 bool LocalChange = true;
2497 while (LocalChange) {
2498 LocalChange = false;
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002499
2500 // Delete functions that are trivially dead, ccc -> fastcc
2501 LocalChange |= OptimizeFunctions(M);
2502
2503 // Optimize global_ctors list.
2504 if (GlobalCtors)
2505 LocalChange |= OptimizeGlobalCtorsList(GlobalCtors);
2506
2507 // Optimize non-address-taken globals.
2508 LocalChange |= OptimizeGlobalVars(M);
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002509
2510 // Resolve aliases, when possible.
Duncan Sandsfc5940d2009-03-06 10:21:56 +00002511 LocalChange |= OptimizeGlobalAliases(M);
Anton Korobeynikove4c6b612008-09-09 19:04:59 +00002512 Changed |= LocalChange;
Chris Lattner7a90b682004-10-07 04:16:33 +00002513 }
Chris Lattnerb1ab4582005-09-26 01:43:45 +00002514
2515 // TODO: Move all global ctors functions to the end of the module for code
2516 // layout.
2517
Chris Lattner079236d2004-02-25 21:34:36 +00002518 return Changed;
2519}