blob: cf9cdaa74447e6d8e66703244331037c6c5300ed [file] [log] [blame]
Chris Lattner25db5802004-10-07 04:16:33 +00001//===- GlobalOpt.cpp - Optimize Global Variables --------------------------===//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
Chris Lattner25db5802004-10-07 04:16:33 +00003// The LLVM Compiler Infrastructure
4//
5// This file was developed by the LLVM research group and is distributed under
6// the University of Illinois Open Source License. See LICENSE.TXT for details.
Misha Brukmanb1c93172005-04-21 23:48:37 +00007//
Chris Lattner25db5802004-10-07 04:16:33 +00008//===----------------------------------------------------------------------===//
9//
10// 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.
13//
14//===----------------------------------------------------------------------===//
15
16#define DEBUG_TYPE "globalopt"
17#include "llvm/Transforms/IPO.h"
Chris Lattnera4c80222005-05-08 22:18:06 +000018#include "llvm/CallingConv.h"
Chris Lattner25db5802004-10-07 04:16:33 +000019#include "llvm/Constants.h"
20#include "llvm/DerivedTypes.h"
21#include "llvm/Instructions.h"
Chris Lattner7561ca12005-02-27 18:58:52 +000022#include "llvm/IntrinsicInst.h"
Chris Lattner25db5802004-10-07 04:16:33 +000023#include "llvm/Module.h"
24#include "llvm/Pass.h"
25#include "llvm/Support/Debug.h"
Chris Lattner004e2502004-10-11 05:54:41 +000026#include "llvm/Target/TargetData.h"
27#include "llvm/Transforms/Utils/Local.h"
Chris Lattner25db5802004-10-07 04:16:33 +000028#include "llvm/ADT/Statistic.h"
Chris Lattnerabab0712004-10-08 17:32:09 +000029#include "llvm/ADT/StringExtras.h"
Chris Lattner25db5802004-10-07 04:16:33 +000030#include <algorithm>
Chris Lattnerc597b8a2006-01-22 23:32:06 +000031#include <set>
Chris Lattner25db5802004-10-07 04:16:33 +000032using namespace llvm;
33
34namespace {
Chris Lattner700b8732006-12-06 17:46:33 +000035 Statistic NumMarked ("globalopt", "Number of globals marked constant");
36 Statistic NumSRA ("globalopt", "Number of aggregate globals broken "
Chris Lattnerabab0712004-10-08 17:32:09 +000037 "into scalars");
Chris Lattner700b8732006-12-06 17:46:33 +000038 Statistic NumHeapSRA ("globalopt", "Number of heap objects SRA'd");
39 Statistic NumSubstitute("globalopt",
Chris Lattner8e71c6a2004-10-16 18:09:00 +000040 "Number of globals with initializers stored into them");
Chris Lattner700b8732006-12-06 17:46:33 +000041 Statistic NumDeleted ("globalopt", "Number of globals deleted");
42 Statistic NumFnDeleted("globalopt", "Number of functions deleted");
43 Statistic NumGlobUses ("globalopt", "Number of global uses devirtualized");
44 Statistic NumLocalized("globalopt", "Number of globals localized");
45 Statistic NumShrunkToBool("globalopt",
Chris Lattner40e4cec2004-12-12 05:53:50 +000046 "Number of global vars shrunk to booleans");
Chris Lattner700b8732006-12-06 17:46:33 +000047 Statistic NumFastCallFns("globalopt",
Chris Lattnera4c80222005-05-08 22:18:06 +000048 "Number of functions converted to fastcc");
Chris Lattner700b8732006-12-06 17:46:33 +000049 Statistic NumCtorsEvaluated("globalopt","Number of static ctors evaluated");
Chris Lattner25db5802004-10-07 04:16:33 +000050
51 struct GlobalOpt : public ModulePass {
Chris Lattner004e2502004-10-11 05:54:41 +000052 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
53 AU.addRequired<TargetData>();
54 }
Misha Brukmanb1c93172005-04-21 23:48:37 +000055
Chris Lattner25db5802004-10-07 04:16:33 +000056 bool runOnModule(Module &M);
Chris Lattner004e2502004-10-11 05:54:41 +000057
58 private:
Chris Lattner41b6a5a2005-09-26 01:43:45 +000059 GlobalVariable *FindGlobalCtors(Module &M);
60 bool OptimizeFunctions(Module &M);
61 bool OptimizeGlobalVars(Module &M);
62 bool OptimizeGlobalCtorsList(GlobalVariable *&GCL);
Chris Lattnerc2d3d312006-08-27 22:42:52 +000063 bool ProcessInternalGlobal(GlobalVariable *GV,Module::global_iterator &GVI);
Chris Lattner25db5802004-10-07 04:16:33 +000064 };
65
Chris Lattnerc2d3d312006-08-27 22:42:52 +000066 RegisterPass<GlobalOpt> X("globalopt", "Global Variable Optimizer");
Chris Lattner25db5802004-10-07 04:16:33 +000067}
68
69ModulePass *llvm::createGlobalOptimizerPass() { return new GlobalOpt(); }
70
71/// GlobalStatus - As we analyze each global, keep track of some information
72/// about it. If we find out that the address of the global is taken, none of
Chris Lattner617f1a32004-10-07 21:30:30 +000073/// this info will be accurate.
Chris Lattner25db5802004-10-07 04:16:33 +000074struct GlobalStatus {
Chris Lattner617f1a32004-10-07 21:30:30 +000075 /// isLoaded - True if the global is ever loaded. If the global isn't ever
76 /// loaded it can be deleted.
Chris Lattner25db5802004-10-07 04:16:33 +000077 bool isLoaded;
Chris Lattner617f1a32004-10-07 21:30:30 +000078
79 /// StoredType - Keep track of what stores to the global look like.
80 ///
Chris Lattner25db5802004-10-07 04:16:33 +000081 enum StoredType {
Chris Lattner617f1a32004-10-07 21:30:30 +000082 /// NotStored - There is no store to this global. It can thus be marked
83 /// constant.
84 NotStored,
85
86 /// isInitializerStored - This global is stored to, but the only thing
87 /// stored is the constant it was initialized with. This is only tracked
88 /// for scalar globals.
89 isInitializerStored,
90
91 /// isStoredOnce - This global is stored to, but only its initializer and
92 /// one other value is ever stored to it. If this global isStoredOnce, we
93 /// track the value stored to it in StoredOnceValue below. This is only
94 /// tracked for scalar globals.
95 isStoredOnce,
96
97 /// isStored - This global is stored to by multiple values or something else
98 /// that we cannot track.
99 isStored
Chris Lattner25db5802004-10-07 04:16:33 +0000100 } StoredType;
Chris Lattner617f1a32004-10-07 21:30:30 +0000101
102 /// StoredOnceValue - If only one value (besides the initializer constant) is
103 /// ever stored to this global, keep track of what value it is.
104 Value *StoredOnceValue;
105
Chris Lattner5a0bd612006-11-01 18:03:33 +0000106 /// AccessingFunction/HasMultipleAccessingFunctions - These start out
107 /// null/false. When the first accessing function is noticed, it is recorded.
108 /// When a second different accessing function is noticed,
109 /// HasMultipleAccessingFunctions is set to true.
Alkis Evlogimenosc4a44c62005-02-10 18:36:30 +0000110 Function *AccessingFunction;
111 bool HasMultipleAccessingFunctions;
112
Chris Lattner5a0bd612006-11-01 18:03:33 +0000113 /// HasNonInstructionUser - Set to true if this global has a user that is not
114 /// an instruction (e.g. a constant expr or GV initializer).
Chris Lattner50bdfcb2005-06-15 21:11:48 +0000115 bool HasNonInstructionUser;
116
Chris Lattner5a0bd612006-11-01 18:03:33 +0000117 /// HasPHIUser - Set to true if this global has a user that is a PHI node.
118 bool HasPHIUser;
119
Chris Lattner617f1a32004-10-07 21:30:30 +0000120 /// isNotSuitableForSRA - Keep track of whether any SRA preventing users of
121 /// the global exist. Such users include GEP instruction with variable
122 /// indexes, and non-gep/load/store users like constant expr casts.
Chris Lattner25db5802004-10-07 04:16:33 +0000123 bool isNotSuitableForSRA;
124
Chris Lattner617f1a32004-10-07 21:30:30 +0000125 GlobalStatus() : isLoaded(false), StoredType(NotStored), StoredOnceValue(0),
Alkis Evlogimenosc4a44c62005-02-10 18:36:30 +0000126 AccessingFunction(0), HasMultipleAccessingFunctions(false),
Chris Lattner5a0bd612006-11-01 18:03:33 +0000127 HasNonInstructionUser(false), HasPHIUser(false),
128 isNotSuitableForSRA(false) {}
Chris Lattner25db5802004-10-07 04:16:33 +0000129};
130
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000131
132
133/// ConstantIsDead - Return true if the specified constant is (transitively)
134/// dead. The constant may be used by other constants (e.g. constant arrays and
135/// constant exprs) as long as they are dead, but it cannot be used by anything
136/// else.
137static bool ConstantIsDead(Constant *C) {
138 if (isa<GlobalValue>(C)) return false;
139
140 for (Value::use_iterator UI = C->use_begin(), E = C->use_end(); UI != E; ++UI)
141 if (Constant *CU = dyn_cast<Constant>(*UI)) {
142 if (!ConstantIsDead(CU)) return false;
143 } else
144 return false;
145 return true;
146}
147
148
Chris Lattner25db5802004-10-07 04:16:33 +0000149/// AnalyzeGlobal - Look at all uses of the global and fill in the GlobalStatus
150/// structure. If the global has its address taken, return true to indicate we
151/// can't do anything with it.
152///
153static bool AnalyzeGlobal(Value *V, GlobalStatus &GS,
154 std::set<PHINode*> &PHIUsers) {
155 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
156 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(*UI)) {
Chris Lattner50bdfcb2005-06-15 21:11:48 +0000157 GS.HasNonInstructionUser = true;
158
Chris Lattner25db5802004-10-07 04:16:33 +0000159 if (AnalyzeGlobal(CE, GS, PHIUsers)) return true;
160 if (CE->getOpcode() != Instruction::GetElementPtr)
161 GS.isNotSuitableForSRA = true;
Chris Lattnerabab0712004-10-08 17:32:09 +0000162 else if (!GS.isNotSuitableForSRA) {
163 // Check to see if this ConstantExpr GEP is SRA'able. In particular, we
164 // don't like < 3 operand CE's, and we don't like non-constant integer
165 // indices.
166 if (CE->getNumOperands() < 3 || !CE->getOperand(1)->isNullValue())
167 GS.isNotSuitableForSRA = true;
168 else {
169 for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
170 if (!isa<ConstantInt>(CE->getOperand(i))) {
171 GS.isNotSuitableForSRA = true;
172 break;
173 }
174 }
175 }
176
Chris Lattner25db5802004-10-07 04:16:33 +0000177 } else if (Instruction *I = dyn_cast<Instruction>(*UI)) {
Alkis Evlogimenosc4a44c62005-02-10 18:36:30 +0000178 if (!GS.HasMultipleAccessingFunctions) {
179 Function *F = I->getParent()->getParent();
180 if (GS.AccessingFunction == 0)
181 GS.AccessingFunction = F;
182 else if (GS.AccessingFunction != F)
183 GS.HasMultipleAccessingFunctions = true;
184 }
Chris Lattner25db5802004-10-07 04:16:33 +0000185 if (isa<LoadInst>(I)) {
186 GS.isLoaded = true;
187 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
Chris Lattner02b6c912004-10-07 06:01:25 +0000188 // Don't allow a store OF the address, only stores TO the address.
189 if (SI->getOperand(0) == V) return true;
190
Chris Lattner617f1a32004-10-07 21:30:30 +0000191 // If this is a direct store to the global (i.e., the global is a scalar
192 // value, not an aggregate), keep more specific information about
193 // stores.
194 if (GS.StoredType != GlobalStatus::isStored)
195 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(SI->getOperand(1))){
Chris Lattner28eeb732004-11-14 20:50:30 +0000196 Value *StoredVal = SI->getOperand(0);
197 if (StoredVal == GV->getInitializer()) {
198 if (GS.StoredType < GlobalStatus::isInitializerStored)
199 GS.StoredType = GlobalStatus::isInitializerStored;
200 } else if (isa<LoadInst>(StoredVal) &&
201 cast<LoadInst>(StoredVal)->getOperand(0) == GV) {
202 // G = G
Chris Lattner617f1a32004-10-07 21:30:30 +0000203 if (GS.StoredType < GlobalStatus::isInitializerStored)
204 GS.StoredType = GlobalStatus::isInitializerStored;
205 } else if (GS.StoredType < GlobalStatus::isStoredOnce) {
206 GS.StoredType = GlobalStatus::isStoredOnce;
Chris Lattner28eeb732004-11-14 20:50:30 +0000207 GS.StoredOnceValue = StoredVal;
Chris Lattner617f1a32004-10-07 21:30:30 +0000208 } else if (GS.StoredType == GlobalStatus::isStoredOnce &&
Chris Lattner28eeb732004-11-14 20:50:30 +0000209 GS.StoredOnceValue == StoredVal) {
Chris Lattner617f1a32004-10-07 21:30:30 +0000210 // noop.
211 } else {
212 GS.StoredType = GlobalStatus::isStored;
213 }
214 } else {
Chris Lattner25db5802004-10-07 04:16:33 +0000215 GS.StoredType = GlobalStatus::isStored;
Chris Lattner617f1a32004-10-07 21:30:30 +0000216 }
Chris Lattner7561ca12005-02-27 18:58:52 +0000217 } else if (isa<GetElementPtrInst>(I)) {
Chris Lattner25db5802004-10-07 04:16:33 +0000218 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
Chris Lattner004e2502004-10-11 05:54:41 +0000219
220 // If the first two indices are constants, this can be SRA'd.
221 if (isa<GlobalVariable>(I->getOperand(0))) {
222 if (I->getNumOperands() < 3 || !isa<Constant>(I->getOperand(1)) ||
Misha Brukmanb1c93172005-04-21 23:48:37 +0000223 !cast<Constant>(I->getOperand(1))->isNullValue() ||
Chris Lattner004e2502004-10-11 05:54:41 +0000224 !isa<ConstantInt>(I->getOperand(2)))
225 GS.isNotSuitableForSRA = true;
226 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I->getOperand(0))){
227 if (CE->getOpcode() != Instruction::GetElementPtr ||
228 CE->getNumOperands() < 3 || I->getNumOperands() < 2 ||
229 !isa<Constant>(I->getOperand(0)) ||
230 !cast<Constant>(I->getOperand(0))->isNullValue())
231 GS.isNotSuitableForSRA = true;
232 } else {
233 GS.isNotSuitableForSRA = true;
234 }
Chris Lattner7561ca12005-02-27 18:58:52 +0000235 } else if (isa<SelectInst>(I)) {
Chris Lattner25db5802004-10-07 04:16:33 +0000236 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
237 GS.isNotSuitableForSRA = true;
238 } else if (PHINode *PN = dyn_cast<PHINode>(I)) {
239 // PHI nodes we can check just like select or GEP instructions, but we
240 // have to be careful about infinite recursion.
241 if (PHIUsers.insert(PN).second) // Not already visited.
242 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
243 GS.isNotSuitableForSRA = true;
Chris Lattner5a0bd612006-11-01 18:03:33 +0000244 GS.HasPHIUser = true;
Chris Lattner25db5802004-10-07 04:16:33 +0000245 } else if (isa<SetCondInst>(I)) {
246 GS.isNotSuitableForSRA = true;
Chris Lattner7561ca12005-02-27 18:58:52 +0000247 } else if (isa<MemCpyInst>(I) || isa<MemMoveInst>(I)) {
248 if (I->getOperand(1) == V)
249 GS.StoredType = GlobalStatus::isStored;
250 if (I->getOperand(2) == V)
251 GS.isLoaded = true;
252 GS.isNotSuitableForSRA = true;
253 } else if (isa<MemSetInst>(I)) {
254 assert(I->getOperand(1) == V && "Memset only takes one pointer!");
255 GS.StoredType = GlobalStatus::isStored;
256 GS.isNotSuitableForSRA = true;
Chris Lattner25db5802004-10-07 04:16:33 +0000257 } else {
258 return true; // Any other non-load instruction might take address!
259 }
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000260 } else if (Constant *C = dyn_cast<Constant>(*UI)) {
Chris Lattner50bdfcb2005-06-15 21:11:48 +0000261 GS.HasNonInstructionUser = true;
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000262 // We might have a dead and dangling constant hanging off of here.
263 if (!ConstantIsDead(C))
264 return true;
Chris Lattner25db5802004-10-07 04:16:33 +0000265 } else {
Chris Lattner50bdfcb2005-06-15 21:11:48 +0000266 GS.HasNonInstructionUser = true;
267 // Otherwise must be some other user.
Chris Lattner25db5802004-10-07 04:16:33 +0000268 return true;
269 }
270
271 return false;
272}
273
Chris Lattnerabab0712004-10-08 17:32:09 +0000274static Constant *getAggregateConstantElement(Constant *Agg, Constant *Idx) {
275 ConstantInt *CI = dyn_cast<ConstantInt>(Idx);
276 if (!CI) return 0;
Reid Spencere0fc4df2006-10-20 07:07:24 +0000277 unsigned IdxV = CI->getZExtValue();
Chris Lattner25db5802004-10-07 04:16:33 +0000278
Chris Lattnerabab0712004-10-08 17:32:09 +0000279 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Agg)) {
280 if (IdxV < CS->getNumOperands()) return CS->getOperand(IdxV);
281 } else if (ConstantArray *CA = dyn_cast<ConstantArray>(Agg)) {
282 if (IdxV < CA->getNumOperands()) return CA->getOperand(IdxV);
283 } else if (ConstantPacked *CP = dyn_cast<ConstantPacked>(Agg)) {
284 if (IdxV < CP->getNumOperands()) return CP->getOperand(IdxV);
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000285 } else if (isa<ConstantAggregateZero>(Agg)) {
Chris Lattnerabab0712004-10-08 17:32:09 +0000286 if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
287 if (IdxV < STy->getNumElements())
288 return Constant::getNullValue(STy->getElementType(IdxV));
289 } else if (const SequentialType *STy =
290 dyn_cast<SequentialType>(Agg->getType())) {
291 return Constant::getNullValue(STy->getElementType());
292 }
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000293 } else if (isa<UndefValue>(Agg)) {
294 if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
295 if (IdxV < STy->getNumElements())
296 return UndefValue::get(STy->getElementType(IdxV));
297 } else if (const SequentialType *STy =
298 dyn_cast<SequentialType>(Agg->getType())) {
299 return UndefValue::get(STy->getElementType());
300 }
Chris Lattnerabab0712004-10-08 17:32:09 +0000301 }
302 return 0;
303}
Chris Lattner25db5802004-10-07 04:16:33 +0000304
Chris Lattner25db5802004-10-07 04:16:33 +0000305
306/// CleanupConstantGlobalUsers - We just marked GV constant. Loop over all
307/// users of the global, cleaning up the obvious ones. This is largely just a
Chris Lattnercb9f1522004-10-10 16:43:46 +0000308/// quick scan over the use list to clean up the easy and obvious cruft. This
309/// returns true if it made a change.
310static bool CleanupConstantGlobalUsers(Value *V, Constant *Init) {
311 bool Changed = false;
Chris Lattner25db5802004-10-07 04:16:33 +0000312 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;) {
313 User *U = *UI++;
Misha Brukmanb1c93172005-04-21 23:48:37 +0000314
Chris Lattner25db5802004-10-07 04:16:33 +0000315 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattner7561ca12005-02-27 18:58:52 +0000316 if (Init) {
317 // Replace the load with the initializer.
318 LI->replaceAllUsesWith(Init);
319 LI->eraseFromParent();
320 Changed = true;
321 }
Chris Lattner25db5802004-10-07 04:16:33 +0000322 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
323 // Store must be unreachable or storing Init into the global.
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000324 SI->eraseFromParent();
Chris Lattnercb9f1522004-10-10 16:43:46 +0000325 Changed = true;
Chris Lattner25db5802004-10-07 04:16:33 +0000326 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
327 if (CE->getOpcode() == Instruction::GetElementPtr) {
Chris Lattner46d9ff082005-09-26 07:34:35 +0000328 Constant *SubInit = 0;
329 if (Init)
330 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
Chris Lattner7561ca12005-02-27 18:58:52 +0000331 Changed |= CleanupConstantGlobalUsers(CE, SubInit);
Reid Spencer6c38f0b2006-11-27 01:05:10 +0000332 } else if (CE->getOpcode() == Instruction::BitCast &&
Chris Lattner7561ca12005-02-27 18:58:52 +0000333 isa<PointerType>(CE->getType())) {
334 // Pointer cast, delete any stores and memsets to the global.
335 Changed |= CleanupConstantGlobalUsers(CE, 0);
336 }
337
338 if (CE->use_empty()) {
339 CE->destroyConstant();
340 Changed = true;
Chris Lattner25db5802004-10-07 04:16:33 +0000341 }
342 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner61ff32c2005-09-26 05:34:07 +0000343 Constant *SubInit = 0;
Chris Lattner46af55e2005-09-26 06:52:44 +0000344 ConstantExpr *CE =
345 dyn_cast_or_null<ConstantExpr>(ConstantFoldInstruction(GEP));
Chris Lattnereb953f02005-09-27 22:28:11 +0000346 if (Init && CE && CE->getOpcode() == Instruction::GetElementPtr)
Chris Lattner61ff32c2005-09-26 05:34:07 +0000347 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
Chris Lattner7561ca12005-02-27 18:58:52 +0000348 Changed |= CleanupConstantGlobalUsers(GEP, SubInit);
Chris Lattnera0e769c2004-10-10 16:47:33 +0000349
Chris Lattnercb9f1522004-10-10 16:43:46 +0000350 if (GEP->use_empty()) {
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000351 GEP->eraseFromParent();
Chris Lattnercb9f1522004-10-10 16:43:46 +0000352 Changed = true;
353 }
Chris Lattner7561ca12005-02-27 18:58:52 +0000354 } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(U)) { // memset/cpy/mv
355 if (MI->getRawDest() == V) {
356 MI->eraseFromParent();
357 Changed = true;
358 }
359
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000360 } else if (Constant *C = dyn_cast<Constant>(U)) {
361 // If we have a chain of dead constantexprs or other things dangling from
362 // us, and if they are all dead, nuke them without remorse.
363 if (ConstantIsDead(C)) {
364 C->destroyConstant();
Chris Lattner7561ca12005-02-27 18:58:52 +0000365 // This could have invalidated UI, start over from scratch.
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000366 CleanupConstantGlobalUsers(V, Init);
Chris Lattnercb9f1522004-10-10 16:43:46 +0000367 return true;
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000368 }
Chris Lattner25db5802004-10-07 04:16:33 +0000369 }
370 }
Chris Lattnercb9f1522004-10-10 16:43:46 +0000371 return Changed;
Chris Lattner25db5802004-10-07 04:16:33 +0000372}
373
Chris Lattnerabab0712004-10-08 17:32:09 +0000374/// SRAGlobal - Perform scalar replacement of aggregates on the specified global
375/// variable. This opens the door for other optimizations by exposing the
376/// behavior of the program in a more fine-grained way. We have determined that
377/// this transformation is safe already. We return the first global variable we
378/// insert so that the caller can reprocess it.
379static GlobalVariable *SRAGlobal(GlobalVariable *GV) {
380 assert(GV->hasInternalLinkage() && !GV->isConstant());
381 Constant *Init = GV->getInitializer();
382 const Type *Ty = Init->getType();
Misha Brukmanb1c93172005-04-21 23:48:37 +0000383
Chris Lattnerabab0712004-10-08 17:32:09 +0000384 std::vector<GlobalVariable*> NewGlobals;
385 Module::GlobalListType &Globals = GV->getParent()->getGlobalList();
386
387 if (const StructType *STy = dyn_cast<StructType>(Ty)) {
388 NewGlobals.reserve(STy->getNumElements());
389 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
390 Constant *In = getAggregateConstantElement(Init,
Reid Spencere0fc4df2006-10-20 07:07:24 +0000391 ConstantInt::get(Type::UIntTy, i));
Chris Lattnerabab0712004-10-08 17:32:09 +0000392 assert(In && "Couldn't get element of initializer?");
393 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(i), false,
394 GlobalVariable::InternalLinkage,
395 In, GV->getName()+"."+utostr(i));
396 Globals.insert(GV, NGV);
397 NewGlobals.push_back(NGV);
398 }
399 } else if (const SequentialType *STy = dyn_cast<SequentialType>(Ty)) {
400 unsigned NumElements = 0;
401 if (const ArrayType *ATy = dyn_cast<ArrayType>(STy))
402 NumElements = ATy->getNumElements();
403 else if (const PackedType *PTy = dyn_cast<PackedType>(STy))
404 NumElements = PTy->getNumElements();
405 else
406 assert(0 && "Unknown aggregate sequential type!");
407
Chris Lattner25169ca2005-02-23 16:53:04 +0000408 if (NumElements > 16 && GV->hasNUsesOrMore(16))
Chris Lattnerd6a44922005-02-01 01:23:31 +0000409 return 0; // It's not worth it.
Chris Lattnerabab0712004-10-08 17:32:09 +0000410 NewGlobals.reserve(NumElements);
411 for (unsigned i = 0, e = NumElements; i != e; ++i) {
412 Constant *In = getAggregateConstantElement(Init,
Reid Spencere0fc4df2006-10-20 07:07:24 +0000413 ConstantInt::get(Type::UIntTy, i));
Chris Lattnerabab0712004-10-08 17:32:09 +0000414 assert(In && "Couldn't get element of initializer?");
415
416 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(), false,
417 GlobalVariable::InternalLinkage,
418 In, GV->getName()+"."+utostr(i));
419 Globals.insert(GV, NGV);
420 NewGlobals.push_back(NGV);
421 }
422 }
423
424 if (NewGlobals.empty())
425 return 0;
426
Bill Wendling8f13b5c2006-11-26 10:02:32 +0000427 DOUT << "PERFORMING GLOBAL SRA ON: " << *GV;
Chris Lattner004e2502004-10-11 05:54:41 +0000428
Chris Lattnerabab0712004-10-08 17:32:09 +0000429 Constant *NullInt = Constant::getNullValue(Type::IntTy);
430
431 // Loop over all of the uses of the global, replacing the constantexpr geps,
432 // with smaller constantexpr geps or direct references.
433 while (!GV->use_empty()) {
Chris Lattner004e2502004-10-11 05:54:41 +0000434 User *GEP = GV->use_back();
435 assert(((isa<ConstantExpr>(GEP) &&
436 cast<ConstantExpr>(GEP)->getOpcode()==Instruction::GetElementPtr)||
437 isa<GetElementPtrInst>(GEP)) && "NonGEP CE's are not SRAable!");
Misha Brukmanb1c93172005-04-21 23:48:37 +0000438
Chris Lattnerabab0712004-10-08 17:32:09 +0000439 // Ignore the 1th operand, which has to be zero or else the program is quite
440 // broken (undefined). Get the 2nd operand, which is the structure or array
441 // index.
Reid Spencere0fc4df2006-10-20 07:07:24 +0000442 unsigned Val = cast<ConstantInt>(GEP->getOperand(2))->getZExtValue();
Chris Lattnerabab0712004-10-08 17:32:09 +0000443 if (Val >= NewGlobals.size()) Val = 0; // Out of bound array access.
444
Chris Lattner004e2502004-10-11 05:54:41 +0000445 Value *NewPtr = NewGlobals[Val];
Chris Lattnerabab0712004-10-08 17:32:09 +0000446
447 // Form a shorter GEP if needed.
Chris Lattner004e2502004-10-11 05:54:41 +0000448 if (GEP->getNumOperands() > 3)
449 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEP)) {
450 std::vector<Constant*> Idxs;
451 Idxs.push_back(NullInt);
452 for (unsigned i = 3, e = CE->getNumOperands(); i != e; ++i)
453 Idxs.push_back(CE->getOperand(i));
454 NewPtr = ConstantExpr::getGetElementPtr(cast<Constant>(NewPtr), Idxs);
455 } else {
456 GetElementPtrInst *GEPI = cast<GetElementPtrInst>(GEP);
457 std::vector<Value*> Idxs;
458 Idxs.push_back(NullInt);
459 for (unsigned i = 3, e = GEPI->getNumOperands(); i != e; ++i)
460 Idxs.push_back(GEPI->getOperand(i));
461 NewPtr = new GetElementPtrInst(NewPtr, Idxs,
462 GEPI->getName()+"."+utostr(Val), GEPI);
463 }
464 GEP->replaceAllUsesWith(NewPtr);
465
466 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(GEP))
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000467 GEPI->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000468 else
469 cast<ConstantExpr>(GEP)->destroyConstant();
Chris Lattnerabab0712004-10-08 17:32:09 +0000470 }
471
Chris Lattner73ad73e2004-10-08 20:25:55 +0000472 // Delete the old global, now that it is dead.
473 Globals.erase(GV);
Chris Lattnerabab0712004-10-08 17:32:09 +0000474 ++NumSRA;
Chris Lattner004e2502004-10-11 05:54:41 +0000475
476 // Loop over the new globals array deleting any globals that are obviously
477 // dead. This can arise due to scalarization of a structure or an array that
478 // has elements that are dead.
479 unsigned FirstGlobal = 0;
480 for (unsigned i = 0, e = NewGlobals.size(); i != e; ++i)
481 if (NewGlobals[i]->use_empty()) {
482 Globals.erase(NewGlobals[i]);
483 if (FirstGlobal == i) ++FirstGlobal;
484 }
485
486 return FirstGlobal != NewGlobals.size() ? NewGlobals[FirstGlobal] : 0;
Chris Lattnerabab0712004-10-08 17:32:09 +0000487}
488
Chris Lattner09a52722004-10-09 21:48:45 +0000489/// AllUsesOfValueWillTrapIfNull - Return true if all users of the specified
490/// value will trap if the value is dynamically null.
491static bool AllUsesOfValueWillTrapIfNull(Value *V) {
492 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
493 if (isa<LoadInst>(*UI)) {
494 // Will trap.
495 } else if (StoreInst *SI = dyn_cast<StoreInst>(*UI)) {
496 if (SI->getOperand(0) == V) {
Bill Wendlingf3baad32006-12-07 01:30:32 +0000497 //cerr << "NONTRAPPING USE: " << **UI;
Chris Lattner09a52722004-10-09 21:48:45 +0000498 return false; // Storing the value.
499 }
500 } else if (CallInst *CI = dyn_cast<CallInst>(*UI)) {
501 if (CI->getOperand(0) != V) {
Bill Wendlingf3baad32006-12-07 01:30:32 +0000502 //cerr << "NONTRAPPING USE: " << **UI;
Chris Lattner09a52722004-10-09 21:48:45 +0000503 return false; // Not calling the ptr
504 }
505 } else if (InvokeInst *II = dyn_cast<InvokeInst>(*UI)) {
506 if (II->getOperand(0) != V) {
Bill Wendlingf3baad32006-12-07 01:30:32 +0000507 //cerr << "NONTRAPPING USE: " << **UI;
Chris Lattner09a52722004-10-09 21:48:45 +0000508 return false; // Not calling the ptr
509 }
510 } else if (CastInst *CI = dyn_cast<CastInst>(*UI)) {
511 if (!AllUsesOfValueWillTrapIfNull(CI)) return false;
512 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(*UI)) {
513 if (!AllUsesOfValueWillTrapIfNull(GEPI)) return false;
Misha Brukmanb1c93172005-04-21 23:48:37 +0000514 } else if (isa<SetCondInst>(*UI) &&
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000515 isa<ConstantPointerNull>(UI->getOperand(1))) {
516 // Ignore setcc X, null
Chris Lattner09a52722004-10-09 21:48:45 +0000517 } else {
Bill Wendlingf3baad32006-12-07 01:30:32 +0000518 //cerr << "NONTRAPPING USE: " << **UI;
Chris Lattner09a52722004-10-09 21:48:45 +0000519 return false;
520 }
521 return true;
522}
523
524/// AllUsesOfLoadedValueWillTrapIfNull - Return true if all uses of any loads
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000525/// from GV will trap if the loaded value is null. Note that this also permits
526/// comparisons of the loaded value against null, as a special case.
Chris Lattner09a52722004-10-09 21:48:45 +0000527static bool AllUsesOfLoadedValueWillTrapIfNull(GlobalVariable *GV) {
528 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI!=E; ++UI)
529 if (LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
530 if (!AllUsesOfValueWillTrapIfNull(LI))
531 return false;
532 } else if (isa<StoreInst>(*UI)) {
533 // Ignore stores to the global.
534 } else {
535 // We don't know or understand this user, bail out.
Bill Wendlingf3baad32006-12-07 01:30:32 +0000536 //cerr << "UNKNOWN USER OF GLOBAL!: " << **UI;
Chris Lattner09a52722004-10-09 21:48:45 +0000537 return false;
538 }
539
540 return true;
541}
542
Chris Lattnere42eb312004-10-10 23:14:11 +0000543static bool OptimizeAwayTrappingUsesOfValue(Value *V, Constant *NewV) {
544 bool Changed = false;
545 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ) {
546 Instruction *I = cast<Instruction>(*UI++);
547 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
548 LI->setOperand(0, NewV);
549 Changed = true;
550 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
551 if (SI->getOperand(1) == V) {
552 SI->setOperand(1, NewV);
553 Changed = true;
554 }
555 } else if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
556 if (I->getOperand(0) == V) {
557 // Calling through the pointer! Turn into a direct call, but be careful
558 // that the pointer is not also being passed as an argument.
559 I->setOperand(0, NewV);
560 Changed = true;
561 bool PassedAsArg = false;
562 for (unsigned i = 1, e = I->getNumOperands(); i != e; ++i)
563 if (I->getOperand(i) == V) {
564 PassedAsArg = true;
565 I->setOperand(i, NewV);
566 }
567
568 if (PassedAsArg) {
569 // Being passed as an argument also. Be careful to not invalidate UI!
570 UI = V->use_begin();
571 }
572 }
573 } else if (CastInst *CI = dyn_cast<CastInst>(I)) {
574 Changed |= OptimizeAwayTrappingUsesOfValue(CI,
Chris Lattner3ede00b2006-11-30 17:32:29 +0000575 ConstantExpr::getCast(CI->getOpcode(),
576 NewV, CI->getType()));
Chris Lattnere42eb312004-10-10 23:14:11 +0000577 if (CI->use_empty()) {
578 Changed = true;
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000579 CI->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000580 }
581 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
582 // Should handle GEP here.
583 std::vector<Constant*> Indices;
584 Indices.reserve(GEPI->getNumOperands()-1);
585 for (unsigned i = 1, e = GEPI->getNumOperands(); i != e; ++i)
586 if (Constant *C = dyn_cast<Constant>(GEPI->getOperand(i)))
587 Indices.push_back(C);
588 else
589 break;
590 if (Indices.size() == GEPI->getNumOperands()-1)
591 Changed |= OptimizeAwayTrappingUsesOfValue(GEPI,
592 ConstantExpr::getGetElementPtr(NewV, Indices));
593 if (GEPI->use_empty()) {
594 Changed = true;
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000595 GEPI->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000596 }
597 }
598 }
599
600 return Changed;
601}
602
603
604/// OptimizeAwayTrappingUsesOfLoads - The specified global has only one non-null
605/// value stored into it. If there are uses of the loaded value that would trap
606/// if the loaded value is dynamically null, then we know that they cannot be
607/// reachable with a null optimize away the load.
608static bool OptimizeAwayTrappingUsesOfLoads(GlobalVariable *GV, Constant *LV) {
609 std::vector<LoadInst*> Loads;
610 bool Changed = false;
611
612 // Replace all uses of loads with uses of uses of the stored value.
613 for (Value::use_iterator GUI = GV->use_begin(), E = GV->use_end();
614 GUI != E; ++GUI)
615 if (LoadInst *LI = dyn_cast<LoadInst>(*GUI)) {
616 Loads.push_back(LI);
617 Changed |= OptimizeAwayTrappingUsesOfValue(LI, LV);
618 } else {
619 assert(isa<StoreInst>(*GUI) && "Only expect load and stores!");
620 }
621
622 if (Changed) {
Bill Wendling8f13b5c2006-11-26 10:02:32 +0000623 DOUT << "OPTIMIZED LOADS FROM STORED ONCE POINTER: " << *GV;
Chris Lattnere42eb312004-10-10 23:14:11 +0000624 ++NumGlobUses;
625 }
626
627 // Delete all of the loads we can, keeping track of whether we nuked them all!
628 bool AllLoadsGone = true;
629 while (!Loads.empty()) {
630 LoadInst *L = Loads.back();
631 if (L->use_empty()) {
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000632 L->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000633 Changed = true;
634 } else {
635 AllLoadsGone = false;
636 }
637 Loads.pop_back();
638 }
639
640 // If we nuked all of the loads, then none of the stores are needed either,
641 // nor is the global.
642 if (AllLoadsGone) {
Bill Wendling8f13b5c2006-11-26 10:02:32 +0000643 DOUT << " *** GLOBAL NOW DEAD!\n";
Chris Lattnere42eb312004-10-10 23:14:11 +0000644 CleanupConstantGlobalUsers(GV, 0);
645 if (GV->use_empty()) {
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000646 GV->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000647 ++NumDeleted;
648 }
649 Changed = true;
650 }
651 return Changed;
652}
653
Chris Lattner004e2502004-10-11 05:54:41 +0000654/// ConstantPropUsersOf - Walk the use list of V, constant folding all of the
655/// instructions that are foldable.
656static void ConstantPropUsersOf(Value *V) {
657 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; )
658 if (Instruction *I = dyn_cast<Instruction>(*UI++))
659 if (Constant *NewC = ConstantFoldInstruction(I)) {
660 I->replaceAllUsesWith(NewC);
661
Chris Lattnerd6a44922005-02-01 01:23:31 +0000662 // Advance UI to the next non-I use to avoid invalidating it!
663 // Instructions could multiply use V.
664 while (UI != E && *UI == I)
Chris Lattner004e2502004-10-11 05:54:41 +0000665 ++UI;
Chris Lattnerd6a44922005-02-01 01:23:31 +0000666 I->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000667 }
668}
669
670/// OptimizeGlobalAddressOfMalloc - This function takes the specified global
671/// variable, and transforms the program as if it always contained the result of
672/// the specified malloc. Because it is always the result of the specified
673/// malloc, there is no reason to actually DO the malloc. Instead, turn the
Chris Lattner3ede00b2006-11-30 17:32:29 +0000674/// malloc into a global, and any loads of GV as uses of the new global.
Chris Lattner004e2502004-10-11 05:54:41 +0000675static GlobalVariable *OptimizeGlobalAddressOfMalloc(GlobalVariable *GV,
676 MallocInst *MI) {
Bill Wendling8f13b5c2006-11-26 10:02:32 +0000677 DOUT << "PROMOTING MALLOC GLOBAL: " << *GV << " MALLOC = " << *MI;
Chris Lattner004e2502004-10-11 05:54:41 +0000678 ConstantInt *NElements = cast<ConstantInt>(MI->getArraySize());
679
Reid Spencere0fc4df2006-10-20 07:07:24 +0000680 if (NElements->getZExtValue() != 1) {
Chris Lattner004e2502004-10-11 05:54:41 +0000681 // If we have an array allocation, transform it to a single element
682 // allocation to make the code below simpler.
683 Type *NewTy = ArrayType::get(MI->getAllocatedType(),
Reid Spencere0fc4df2006-10-20 07:07:24 +0000684 NElements->getZExtValue());
Chris Lattner004e2502004-10-11 05:54:41 +0000685 MallocInst *NewMI =
686 new MallocInst(NewTy, Constant::getNullValue(Type::UIntTy),
Nate Begeman848622f2005-11-05 09:21:28 +0000687 MI->getAlignment(), MI->getName(), MI);
Chris Lattner004e2502004-10-11 05:54:41 +0000688 std::vector<Value*> Indices;
689 Indices.push_back(Constant::getNullValue(Type::IntTy));
690 Indices.push_back(Indices[0]);
691 Value *NewGEP = new GetElementPtrInst(NewMI, Indices,
692 NewMI->getName()+".el0", MI);
693 MI->replaceAllUsesWith(NewGEP);
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000694 MI->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000695 MI = NewMI;
696 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000697
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000698 // Create the new global variable. The contents of the malloc'd memory is
699 // undefined, so initialize with an undef value.
700 Constant *Init = UndefValue::get(MI->getAllocatedType());
Chris Lattner004e2502004-10-11 05:54:41 +0000701 GlobalVariable *NewGV = new GlobalVariable(MI->getAllocatedType(), false,
702 GlobalValue::InternalLinkage, Init,
703 GV->getName()+".body");
704 GV->getParent()->getGlobalList().insert(GV, NewGV);
Misha Brukmanb1c93172005-04-21 23:48:37 +0000705
Chris Lattner004e2502004-10-11 05:54:41 +0000706 // Anything that used the malloc now uses the global directly.
707 MI->replaceAllUsesWith(NewGV);
Chris Lattner004e2502004-10-11 05:54:41 +0000708
709 Constant *RepValue = NewGV;
710 if (NewGV->getType() != GV->getType()->getElementType())
Reid Spencerbb65ebf2006-12-12 23:36:14 +0000711 RepValue = ConstantExpr::getBitCast(RepValue,
712 GV->getType()->getElementType());
Chris Lattner004e2502004-10-11 05:54:41 +0000713
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000714 // If there is a comparison against null, we will insert a global bool to
715 // keep track of whether the global was initialized yet or not.
Misha Brukmanb1c93172005-04-21 23:48:37 +0000716 GlobalVariable *InitBool =
717 new GlobalVariable(Type::BoolTy, false, GlobalValue::InternalLinkage,
Chris Lattner6ab03f62006-09-28 23:35:22 +0000718 ConstantBool::getFalse(), GV->getName()+".init");
Chris Lattner3b181392004-12-02 06:25:58 +0000719 bool InitBoolUsed = false;
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000720
Chris Lattner004e2502004-10-11 05:54:41 +0000721 // Loop over all uses of GV, processing them in turn.
Chris Lattner3b181392004-12-02 06:25:58 +0000722 std::vector<StoreInst*> Stores;
Chris Lattner004e2502004-10-11 05:54:41 +0000723 while (!GV->use_empty())
724 if (LoadInst *LI = dyn_cast<LoadInst>(GV->use_back())) {
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000725 while (!LI->use_empty()) {
Chris Lattnerd6a44922005-02-01 01:23:31 +0000726 Use &LoadUse = LI->use_begin().getUse();
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000727 if (!isa<SetCondInst>(LoadUse.getUser()))
728 LoadUse = RepValue;
729 else {
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000730 // Replace the setcc X, 0 with a use of the bool value.
731 SetCondInst *SCI = cast<SetCondInst>(LoadUse.getUser());
732 Value *LV = new LoadInst(InitBool, InitBool->getName()+".val", SCI);
Chris Lattner3b181392004-12-02 06:25:58 +0000733 InitBoolUsed = true;
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000734 switch (SCI->getOpcode()) {
735 default: assert(0 && "Unknown opcode!");
736 case Instruction::SetLT:
Chris Lattner6ab03f62006-09-28 23:35:22 +0000737 LV = ConstantBool::getFalse(); // X < null -> always false
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000738 break;
739 case Instruction::SetEQ:
740 case Instruction::SetLE:
741 LV = BinaryOperator::createNot(LV, "notinit", SCI);
742 break;
743 case Instruction::SetNE:
744 case Instruction::SetGE:
745 case Instruction::SetGT:
746 break; // no change.
747 }
748 SCI->replaceAllUsesWith(LV);
749 SCI->eraseFromParent();
750 }
751 }
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000752 LI->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000753 } else {
754 StoreInst *SI = cast<StoreInst>(GV->use_back());
Chris Lattner3b181392004-12-02 06:25:58 +0000755 // The global is initialized when the store to it occurs.
Chris Lattner6ab03f62006-09-28 23:35:22 +0000756 new StoreInst(ConstantBool::getTrue(), InitBool, SI);
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000757 SI->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000758 }
759
Chris Lattner3b181392004-12-02 06:25:58 +0000760 // If the initialization boolean was used, insert it, otherwise delete it.
761 if (!InitBoolUsed) {
762 while (!InitBool->use_empty()) // Delete initializations
763 cast<Instruction>(InitBool->use_back())->eraseFromParent();
764 delete InitBool;
765 } else
766 GV->getParent()->getGlobalList().insert(GV, InitBool);
767
768
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000769 // Now the GV is dead, nuke it and the malloc.
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000770 GV->eraseFromParent();
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000771 MI->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000772
773 // To further other optimizations, loop over all users of NewGV and try to
774 // constant prop them. This will promote GEP instructions with constant
775 // indices into GEP constant-exprs, which will allow global-opt to hack on it.
776 ConstantPropUsersOf(NewGV);
777 if (RepValue != NewGV)
778 ConstantPropUsersOf(RepValue);
779
780 return NewGV;
781}
Chris Lattnere42eb312004-10-10 23:14:11 +0000782
Chris Lattnerc0677c02004-12-02 07:11:07 +0000783/// ValueIsOnlyUsedLocallyOrStoredToOneGlobal - Scan the use-list of V checking
784/// to make sure that there are no complex uses of V. We permit simple things
785/// like dereferencing the pointer, but not storing through the address, unless
786/// it is to the specified global.
787static bool ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Instruction *V,
788 GlobalVariable *GV) {
789 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI)
790 if (isa<LoadInst>(*UI) || isa<SetCondInst>(*UI)) {
791 // Fine, ignore.
792 } else if (StoreInst *SI = dyn_cast<StoreInst>(*UI)) {
793 if (SI->getOperand(0) == V && SI->getOperand(1) != GV)
794 return false; // Storing the pointer itself... bad.
795 // Otherwise, storing through it, or storing into GV... fine.
796 } else if (isa<GetElementPtrInst>(*UI) || isa<SelectInst>(*UI)) {
797 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(cast<Instruction>(*UI),GV))
798 return false;
799 } else {
800 return false;
801 }
802 return true;
Chris Lattnerc0677c02004-12-02 07:11:07 +0000803}
804
Chris Lattner24d3d422006-09-30 23:32:09 +0000805/// ReplaceUsesOfMallocWithGlobal - The Alloc pointer is stored into GV
806/// somewhere. Transform all uses of the allocation into loads from the
807/// global and uses of the resultant pointer. Further, delete the store into
808/// GV. This assumes that these value pass the
809/// 'ValueIsOnlyUsedLocallyOrStoredToOneGlobal' predicate.
810static void ReplaceUsesOfMallocWithGlobal(Instruction *Alloc,
811 GlobalVariable *GV) {
812 while (!Alloc->use_empty()) {
813 Instruction *U = Alloc->use_back();
814 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
815 // If this is the store of the allocation into the global, remove it.
816 if (SI->getOperand(1) == GV) {
817 SI->eraseFromParent();
818 continue;
819 }
820 }
821
822 // Insert a load from the global, and use it instead of the malloc.
823 Value *NL = new LoadInst(GV, GV->getName()+".val", U);
824 U->replaceUsesOfWith(Alloc, NL);
825 }
826}
827
828/// GlobalLoadUsesSimpleEnoughForHeapSRA - If all users of values loaded from
829/// GV are simple enough to perform HeapSRA, return true.
830static bool GlobalLoadUsesSimpleEnoughForHeapSRA(GlobalVariable *GV) {
831 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI != E;
832 ++UI)
833 if (LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
834 // We permit two users of the load: setcc comparing against the null
835 // pointer, and a getelementptr of a specific form.
836 for (Value::use_iterator UI = LI->use_begin(), E = LI->use_end(); UI != E;
837 ++UI) {
838 // Comparison against null is ok.
839 if (SetCondInst *SCI = dyn_cast<SetCondInst>(*UI)) {
840 if (!isa<ConstantPointerNull>(SCI->getOperand(1)))
841 return false;
842 continue;
843 }
844
845 // getelementptr is also ok, but only a simple form.
846 GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(*UI);
847 if (!GEPI) return false;
848
849 // Must index into the array and into the struct.
850 if (GEPI->getNumOperands() < 3)
851 return false;
852
853 // Otherwise the GEP is ok.
854 continue;
855 }
856 }
857 return true;
858}
859
860/// RewriteUsesOfLoadForHeapSRoA - We are performing Heap SRoA on a global. Ptr
861/// is a value loaded from the global. Eliminate all uses of Ptr, making them
862/// use FieldGlobals instead. All uses of loaded values satisfy
863/// GlobalLoadUsesSimpleEnoughForHeapSRA.
864static void RewriteUsesOfLoadForHeapSRoA(LoadInst *Ptr,
865 const std::vector<GlobalVariable*> &FieldGlobals) {
866 std::vector<Value *> InsertedLoadsForPtr;
867 //InsertedLoadsForPtr.resize(FieldGlobals.size());
868 while (!Ptr->use_empty()) {
869 Instruction *User = Ptr->use_back();
870
871 // If this is a comparison against null, handle it.
872 if (SetCondInst *SCI = dyn_cast<SetCondInst>(User)) {
873 assert(isa<ConstantPointerNull>(SCI->getOperand(1)));
874 // If we have a setcc of the loaded pointer, we can use a setcc of any
875 // field.
876 Value *NPtr;
877 if (InsertedLoadsForPtr.empty()) {
878 NPtr = new LoadInst(FieldGlobals[0], Ptr->getName()+".f0", Ptr);
879 InsertedLoadsForPtr.push_back(Ptr);
880 } else {
881 NPtr = InsertedLoadsForPtr.back();
882 }
883
884 Value *New = new SetCondInst(SCI->getOpcode(), NPtr,
885 Constant::getNullValue(NPtr->getType()),
886 SCI->getName(), SCI);
887 SCI->replaceAllUsesWith(New);
888 SCI->eraseFromParent();
889 continue;
890 }
891
892 // Otherwise, this should be: 'getelementptr Ptr, Idx, uint FieldNo ...'
893 GetElementPtrInst *GEPI = cast<GetElementPtrInst>(User);
Reid Spencere0fc4df2006-10-20 07:07:24 +0000894 assert(GEPI->getNumOperands() >= 3 && isa<ConstantInt>(GEPI->getOperand(2))
895 && GEPI->getOperand(2)->getType()->isUnsigned()
Chris Lattner24d3d422006-09-30 23:32:09 +0000896 && "Unexpected GEPI!");
897
898 // Load the pointer for this field.
Reid Spencere0fc4df2006-10-20 07:07:24 +0000899 unsigned FieldNo = cast<ConstantInt>(GEPI->getOperand(2))->getZExtValue();
Chris Lattner24d3d422006-09-30 23:32:09 +0000900 if (InsertedLoadsForPtr.size() <= FieldNo)
901 InsertedLoadsForPtr.resize(FieldNo+1);
902 if (InsertedLoadsForPtr[FieldNo] == 0)
903 InsertedLoadsForPtr[FieldNo] = new LoadInst(FieldGlobals[FieldNo],
904 Ptr->getName()+".f" +
905 utostr(FieldNo), Ptr);
906 Value *NewPtr = InsertedLoadsForPtr[FieldNo];
907
908 // Create the new GEP idx vector.
909 std::vector<Value*> GEPIdx;
910 GEPIdx.push_back(GEPI->getOperand(1));
911 GEPIdx.insert(GEPIdx.end(), GEPI->op_begin()+3, GEPI->op_end());
912
913 Value *NGEPI = new GetElementPtrInst(NewPtr, GEPIdx, GEPI->getName(), GEPI);
914 GEPI->replaceAllUsesWith(NGEPI);
915 GEPI->eraseFromParent();
916 }
917}
918
919/// PerformHeapAllocSRoA - MI is an allocation of an array of structures. Break
920/// it up into multiple allocations of arrays of the fields.
921static GlobalVariable *PerformHeapAllocSRoA(GlobalVariable *GV, MallocInst *MI){
Bill Wendling8f13b5c2006-11-26 10:02:32 +0000922 DOUT << "SROA HEAP ALLOC: " << *GV << " MALLOC = " << *MI;
Chris Lattner24d3d422006-09-30 23:32:09 +0000923 const StructType *STy = cast<StructType>(MI->getAllocatedType());
924
925 // There is guaranteed to be at least one use of the malloc (storing
926 // it into GV). If there are other uses, change them to be uses of
927 // the global to simplify later code. This also deletes the store
928 // into GV.
929 ReplaceUsesOfMallocWithGlobal(MI, GV);
930
931 // Okay, at this point, there are no users of the malloc. Insert N
932 // new mallocs at the same place as MI, and N globals.
933 std::vector<GlobalVariable*> FieldGlobals;
934 std::vector<MallocInst*> FieldMallocs;
935
936 for (unsigned FieldNo = 0, e = STy->getNumElements(); FieldNo != e;++FieldNo){
937 const Type *FieldTy = STy->getElementType(FieldNo);
938 const Type *PFieldTy = PointerType::get(FieldTy);
939
940 GlobalVariable *NGV =
941 new GlobalVariable(PFieldTy, false, GlobalValue::InternalLinkage,
942 Constant::getNullValue(PFieldTy),
943 GV->getName() + ".f" + utostr(FieldNo), GV);
944 FieldGlobals.push_back(NGV);
945
946 MallocInst *NMI = new MallocInst(FieldTy, MI->getArraySize(),
947 MI->getName() + ".f" + utostr(FieldNo),MI);
948 FieldMallocs.push_back(NMI);
949 new StoreInst(NMI, NGV, MI);
950 }
951
952 // The tricky aspect of this transformation is handling the case when malloc
953 // fails. In the original code, malloc failing would set the result pointer
954 // of malloc to null. In this case, some mallocs could succeed and others
955 // could fail. As such, we emit code that looks like this:
956 // F0 = malloc(field0)
957 // F1 = malloc(field1)
958 // F2 = malloc(field2)
959 // if (F0 == 0 || F1 == 0 || F2 == 0) {
960 // if (F0) { free(F0); F0 = 0; }
961 // if (F1) { free(F1); F1 = 0; }
962 // if (F2) { free(F2); F2 = 0; }
963 // }
964 Value *RunningOr = 0;
965 for (unsigned i = 0, e = FieldMallocs.size(); i != e; ++i) {
966 Value *Cond = new SetCondInst(Instruction::SetEQ, FieldMallocs[i],
967 Constant::getNullValue(FieldMallocs[i]->getType()),
968 "isnull", MI);
969 if (!RunningOr)
970 RunningOr = Cond; // First seteq
971 else
972 RunningOr = BinaryOperator::createOr(RunningOr, Cond, "tmp", MI);
973 }
974
975 // Split the basic block at the old malloc.
976 BasicBlock *OrigBB = MI->getParent();
977 BasicBlock *ContBB = OrigBB->splitBasicBlock(MI, "malloc_cont");
978
979 // Create the block to check the first condition. Put all these blocks at the
980 // end of the function as they are unlikely to be executed.
981 BasicBlock *NullPtrBlock = new BasicBlock("malloc_ret_null",
982 OrigBB->getParent());
983
984 // Remove the uncond branch from OrigBB to ContBB, turning it into a cond
985 // branch on RunningOr.
986 OrigBB->getTerminator()->eraseFromParent();
987 new BranchInst(NullPtrBlock, ContBB, RunningOr, OrigBB);
988
989 // Within the NullPtrBlock, we need to emit a comparison and branch for each
990 // pointer, because some may be null while others are not.
991 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
992 Value *GVVal = new LoadInst(FieldGlobals[i], "tmp", NullPtrBlock);
993 Value *Cmp = new SetCondInst(Instruction::SetNE, GVVal,
994 Constant::getNullValue(GVVal->getType()),
995 "tmp", NullPtrBlock);
996 BasicBlock *FreeBlock = new BasicBlock("free_it", OrigBB->getParent());
997 BasicBlock *NextBlock = new BasicBlock("next", OrigBB->getParent());
998 new BranchInst(FreeBlock, NextBlock, Cmp, NullPtrBlock);
999
1000 // Fill in FreeBlock.
1001 new FreeInst(GVVal, FreeBlock);
1002 new StoreInst(Constant::getNullValue(GVVal->getType()), FieldGlobals[i],
1003 FreeBlock);
1004 new BranchInst(NextBlock, FreeBlock);
1005
1006 NullPtrBlock = NextBlock;
1007 }
1008
1009 new BranchInst(ContBB, NullPtrBlock);
1010
1011
1012 // MI is no longer needed, remove it.
1013 MI->eraseFromParent();
1014
1015
1016 // Okay, the malloc site is completely handled. All of the uses of GV are now
1017 // loads, and all uses of those loads are simple. Rewrite them to use loads
1018 // of the per-field globals instead.
1019 while (!GV->use_empty()) {
1020 LoadInst *LI = cast<LoadInst>(GV->use_back());
1021 RewriteUsesOfLoadForHeapSRoA(LI, FieldGlobals);
1022 LI->eraseFromParent();
1023 }
1024
1025 // The old global is now dead, remove it.
1026 GV->eraseFromParent();
1027
1028 ++NumHeapSRA;
1029 return FieldGlobals[0];
1030}
1031
1032
Chris Lattner09a52722004-10-09 21:48:45 +00001033// OptimizeOnceStoredGlobal - Try to optimize globals based on the knowledge
1034// that only one value (besides its initializer) is ever stored to the global.
Chris Lattner004e2502004-10-11 05:54:41 +00001035static bool OptimizeOnceStoredGlobal(GlobalVariable *GV, Value *StoredOnceVal,
Chris Lattnerc2d3d312006-08-27 22:42:52 +00001036 Module::global_iterator &GVI,
1037 TargetData &TD) {
Chris Lattner09a52722004-10-09 21:48:45 +00001038 if (CastInst *CI = dyn_cast<CastInst>(StoredOnceVal))
1039 StoredOnceVal = CI->getOperand(0);
1040 else if (GetElementPtrInst *GEPI =dyn_cast<GetElementPtrInst>(StoredOnceVal)){
Chris Lattnere42eb312004-10-10 23:14:11 +00001041 // "getelementptr Ptr, 0, 0, 0" is really just a cast.
Chris Lattner09a52722004-10-09 21:48:45 +00001042 bool IsJustACast = true;
1043 for (unsigned i = 1, e = GEPI->getNumOperands(); i != e; ++i)
1044 if (!isa<Constant>(GEPI->getOperand(i)) ||
1045 !cast<Constant>(GEPI->getOperand(i))->isNullValue()) {
1046 IsJustACast = false;
1047 break;
1048 }
1049 if (IsJustACast)
1050 StoredOnceVal = GEPI->getOperand(0);
1051 }
1052
Chris Lattnere42eb312004-10-10 23:14:11 +00001053 // If we are dealing with a pointer global that is initialized to null and
1054 // only has one (non-null) value stored into it, then we can optimize any
1055 // users of the loaded value (often calls and loads) that would trap if the
1056 // value was null.
Chris Lattner09a52722004-10-09 21:48:45 +00001057 if (isa<PointerType>(GV->getInitializer()->getType()) &&
1058 GV->getInitializer()->isNullValue()) {
Chris Lattnere42eb312004-10-10 23:14:11 +00001059 if (Constant *SOVC = dyn_cast<Constant>(StoredOnceVal)) {
1060 if (GV->getInitializer()->getType() != SOVC->getType())
Reid Spencerbb65ebf2006-12-12 23:36:14 +00001061 SOVC = ConstantExpr::getBitCast(SOVC, GV->getInitializer()->getType());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001062
Chris Lattnere42eb312004-10-10 23:14:11 +00001063 // Optimize away any trapping uses of the loaded value.
1064 if (OptimizeAwayTrappingUsesOfLoads(GV, SOVC))
Chris Lattner604ed7a2004-10-10 17:07:12 +00001065 return true;
Chris Lattner004e2502004-10-11 05:54:41 +00001066 } else if (MallocInst *MI = dyn_cast<MallocInst>(StoredOnceVal)) {
Chris Lattner80a01ef2006-09-30 19:40:30 +00001067 // If this is a malloc of an abstract type, don't touch it.
1068 if (!MI->getAllocatedType()->isSized())
1069 return false;
1070
Chris Lattner24d3d422006-09-30 23:32:09 +00001071 // We can't optimize this global unless all uses of it are *known* to be
1072 // of the malloc value, not of the null initializer value (consider a use
1073 // that compares the global's value against zero to see if the malloc has
1074 // been reached). To do this, we check to see if all uses of the global
1075 // would trap if the global were null: this proves that they must all
1076 // happen after the malloc.
1077 if (!AllUsesOfLoadedValueWillTrapIfNull(GV))
1078 return false;
1079
1080 // We can't optimize this if the malloc itself is used in a complex way,
1081 // for example, being stored into multiple globals. This allows the
1082 // malloc to be stored into the specified global, loaded setcc'd, and
1083 // GEP'd. These are all things we could transform to using the global
1084 // for.
1085 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(MI, GV))
1086 return false;
1087
1088
Chris Lattner004e2502004-10-11 05:54:41 +00001089 // If we have a global that is only initialized with a fixed size malloc,
Chris Lattner24d3d422006-09-30 23:32:09 +00001090 // transform the program to use global memory instead of malloc'd memory.
1091 // This eliminates dynamic allocation, avoids an indirection accessing the
1092 // data, and exposes the resultant global to further GlobalOpt.
Chris Lattner80a01ef2006-09-30 19:40:30 +00001093 if (ConstantInt *NElements = dyn_cast<ConstantInt>(MI->getArraySize())) {
Chris Lattner24d3d422006-09-30 23:32:09 +00001094 // Restrict this transformation to only working on small allocations
1095 // (2048 bytes currently), as we don't want to introduce a 16M global or
1096 // something.
Reid Spencere0fc4df2006-10-20 07:07:24 +00001097 if (NElements->getZExtValue()*
Chris Lattner24d3d422006-09-30 23:32:09 +00001098 TD.getTypeSize(MI->getAllocatedType()) < 2048) {
Chris Lattner004e2502004-10-11 05:54:41 +00001099 GVI = OptimizeGlobalAddressOfMalloc(GV, MI);
1100 return true;
1101 }
Chris Lattner80a01ef2006-09-30 19:40:30 +00001102 }
Chris Lattner24d3d422006-09-30 23:32:09 +00001103
1104 // If the allocation is an array of structures, consider transforming this
1105 // into multiple malloc'd arrays, one for each field. This is basically
1106 // SRoA for malloc'd memory.
1107 if (const StructType *AllocTy =
1108 dyn_cast<StructType>(MI->getAllocatedType())) {
1109 // This the structure has an unreasonable number of fields, leave it
1110 // alone.
1111 if (AllocTy->getNumElements() <= 16 && AllocTy->getNumElements() > 0 &&
1112 GlobalLoadUsesSimpleEnoughForHeapSRA(GV)) {
1113 GVI = PerformHeapAllocSRoA(GV, MI);
1114 return true;
1115 }
1116 }
Chris Lattnere42eb312004-10-10 23:14:11 +00001117 }
Chris Lattner09a52722004-10-09 21:48:45 +00001118 }
Chris Lattner004e2502004-10-11 05:54:41 +00001119
Chris Lattner09a52722004-10-09 21:48:45 +00001120 return false;
1121}
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001122
Chris Lattner40e4cec2004-12-12 05:53:50 +00001123/// ShrinkGlobalToBoolean - At this point, we have learned that the only two
Misha Brukmanb1c93172005-04-21 23:48:37 +00001124/// values ever stored into GV are its initializer and OtherVal.
Chris Lattner40e4cec2004-12-12 05:53:50 +00001125static void ShrinkGlobalToBoolean(GlobalVariable *GV, Constant *OtherVal) {
1126 // Create the new global, initializing it to false.
1127 GlobalVariable *NewGV = new GlobalVariable(Type::BoolTy, false,
Chris Lattner6ab03f62006-09-28 23:35:22 +00001128 GlobalValue::InternalLinkage, ConstantBool::getFalse(),
1129 GV->getName()+".b");
Chris Lattner40e4cec2004-12-12 05:53:50 +00001130 GV->getParent()->getGlobalList().insert(GV, NewGV);
1131
1132 Constant *InitVal = GV->getInitializer();
1133 assert(InitVal->getType() != Type::BoolTy && "No reason to shrink to bool!");
1134
1135 // If initialized to zero and storing one into the global, we can use a cast
1136 // instead of a select to synthesize the desired value.
1137 bool IsOneZero = false;
1138 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal))
1139 IsOneZero = InitVal->isNullValue() && CI->equalsInt(1);
1140
1141 while (!GV->use_empty()) {
1142 Instruction *UI = cast<Instruction>(GV->use_back());
1143 if (StoreInst *SI = dyn_cast<StoreInst>(UI)) {
1144 // Change the store into a boolean store.
1145 bool StoringOther = SI->getOperand(0) == OtherVal;
1146 // Only do this if we weren't storing a loaded value.
Chris Lattner745196a2004-12-12 19:34:41 +00001147 Value *StoreVal;
Chris Lattner40e4cec2004-12-12 05:53:50 +00001148 if (StoringOther || SI->getOperand(0) == InitVal)
Chris Lattner745196a2004-12-12 19:34:41 +00001149 StoreVal = ConstantBool::get(StoringOther);
1150 else {
1151 // Otherwise, we are storing a previously loaded copy. To do this,
1152 // change the copy from copying the original value to just copying the
1153 // bool.
1154 Instruction *StoredVal = cast<Instruction>(SI->getOperand(0));
1155
1156 // If we're already replaced the input, StoredVal will be a cast or
1157 // select instruction. If not, it will be a load of the original
1158 // global.
1159 if (LoadInst *LI = dyn_cast<LoadInst>(StoredVal)) {
1160 assert(LI->getOperand(0) == GV && "Not a copy!");
1161 // Insert a new load, to preserve the saved value.
1162 StoreVal = new LoadInst(NewGV, LI->getName()+".b", LI);
1163 } else {
1164 assert((isa<CastInst>(StoredVal) || isa<SelectInst>(StoredVal)) &&
1165 "This is not a form that we understand!");
1166 StoreVal = StoredVal->getOperand(0);
1167 assert(isa<LoadInst>(StoreVal) && "Not a load of NewGV!");
1168 }
1169 }
1170 new StoreInst(StoreVal, NewGV, SI);
1171 } else if (!UI->use_empty()) {
Chris Lattner40e4cec2004-12-12 05:53:50 +00001172 // Change the load into a load of bool then a select.
1173 LoadInst *LI = cast<LoadInst>(UI);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001174
Chris Lattner40e4cec2004-12-12 05:53:50 +00001175 std::string Name = LI->getName(); LI->setName("");
1176 LoadInst *NLI = new LoadInst(NewGV, Name+".b", LI);
1177 Value *NSI;
1178 if (IsOneZero)
Chris Lattnerc8978c52006-11-30 17:35:08 +00001179 NSI = new ZExtInst(NLI, LI->getType(), Name, LI);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001180 else
Chris Lattner40e4cec2004-12-12 05:53:50 +00001181 NSI = new SelectInst(NLI, OtherVal, InitVal, Name, LI);
1182 LI->replaceAllUsesWith(NSI);
1183 }
1184 UI->eraseFromParent();
1185 }
1186
1187 GV->eraseFromParent();
1188}
1189
1190
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001191/// ProcessInternalGlobal - Analyze the specified global variable and optimize
1192/// it if possible. If we make a change, return true.
Chris Lattner004e2502004-10-11 05:54:41 +00001193bool GlobalOpt::ProcessInternalGlobal(GlobalVariable *GV,
Chris Lattner531f9e92005-03-15 04:54:21 +00001194 Module::global_iterator &GVI) {
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001195 std::set<PHINode*> PHIUsers;
1196 GlobalStatus GS;
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001197 GV->removeDeadConstantUsers();
1198
1199 if (GV->use_empty()) {
Bill Wendling8f13b5c2006-11-26 10:02:32 +00001200 DOUT << "GLOBAL DEAD: " << *GV;
Chris Lattner8e71c6a2004-10-16 18:09:00 +00001201 GV->eraseFromParent();
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001202 ++NumDeleted;
1203 return true;
1204 }
1205
1206 if (!AnalyzeGlobal(GV, GS, PHIUsers)) {
Chris Lattner80a01ef2006-09-30 19:40:30 +00001207#if 0
Bill Wendlingf3baad32006-12-07 01:30:32 +00001208 cerr << "Global: " << *GV;
1209 cerr << " isLoaded = " << GS.isLoaded << "\n";
1210 cerr << " StoredType = ";
Chris Lattner80a01ef2006-09-30 19:40:30 +00001211 switch (GS.StoredType) {
Bill Wendlingf3baad32006-12-07 01:30:32 +00001212 case GlobalStatus::NotStored: cerr << "NEVER STORED\n"; break;
1213 case GlobalStatus::isInitializerStored: cerr << "INIT STORED\n"; break;
1214 case GlobalStatus::isStoredOnce: cerr << "STORED ONCE\n"; break;
1215 case GlobalStatus::isStored: cerr << "stored\n"; break;
Chris Lattner80a01ef2006-09-30 19:40:30 +00001216 }
1217 if (GS.StoredType == GlobalStatus::isStoredOnce && GS.StoredOnceValue)
Bill Wendlingf3baad32006-12-07 01:30:32 +00001218 cerr << " StoredOnceValue = " << *GS.StoredOnceValue << "\n";
Chris Lattner80a01ef2006-09-30 19:40:30 +00001219 if (GS.AccessingFunction && !GS.HasMultipleAccessingFunctions)
Bill Wendlingf3baad32006-12-07 01:30:32 +00001220 cerr << " AccessingFunction = " << GS.AccessingFunction->getName()
Chris Lattner80a01ef2006-09-30 19:40:30 +00001221 << "\n";
Bill Wendlingf3baad32006-12-07 01:30:32 +00001222 cerr << " HasMultipleAccessingFunctions = "
Chris Lattner80a01ef2006-09-30 19:40:30 +00001223 << GS.HasMultipleAccessingFunctions << "\n";
Bill Wendlingf3baad32006-12-07 01:30:32 +00001224 cerr << " HasNonInstructionUser = " << GS.HasNonInstructionUser<<"\n";
1225 cerr << " isNotSuitableForSRA = " << GS.isNotSuitableForSRA << "\n";
1226 cerr << "\n";
Chris Lattner80a01ef2006-09-30 19:40:30 +00001227#endif
1228
Alkis Evlogimenosc4a44c62005-02-10 18:36:30 +00001229 // If this is a first class global and has only one accessing function
1230 // and this function is main (which we know is not recursive we can make
1231 // this global a local variable) we replace the global with a local alloca
1232 // in this function.
1233 //
1234 // NOTE: It doesn't make sense to promote non first class types since we
1235 // are just replacing static memory to stack memory.
1236 if (!GS.HasMultipleAccessingFunctions &&
Chris Lattner50bdfcb2005-06-15 21:11:48 +00001237 GS.AccessingFunction && !GS.HasNonInstructionUser &&
Alkis Evlogimenosc4a44c62005-02-10 18:36:30 +00001238 GV->getType()->getElementType()->isFirstClassType() &&
1239 GS.AccessingFunction->getName() == "main" &&
1240 GS.AccessingFunction->hasExternalLinkage()) {
Bill Wendling8f13b5c2006-11-26 10:02:32 +00001241 DOUT << "LOCALIZING GLOBAL: " << *GV;
Alkis Evlogimenosc4a44c62005-02-10 18:36:30 +00001242 Instruction* FirstI = GS.AccessingFunction->getEntryBlock().begin();
1243 const Type* ElemTy = GV->getType()->getElementType();
Nate Begeman848622f2005-11-05 09:21:28 +00001244 // FIXME: Pass Global's alignment when globals have alignment
Alkis Evlogimenosc4a44c62005-02-10 18:36:30 +00001245 AllocaInst* Alloca = new AllocaInst(ElemTy, NULL, GV->getName(), FirstI);
1246 if (!isa<UndefValue>(GV->getInitializer()))
1247 new StoreInst(GV->getInitializer(), Alloca, FirstI);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001248
Alkis Evlogimenosc4a44c62005-02-10 18:36:30 +00001249 GV->replaceAllUsesWith(Alloca);
1250 GV->eraseFromParent();
1251 ++NumLocalized;
1252 return true;
1253 }
Chris Lattner80a01ef2006-09-30 19:40:30 +00001254
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001255 // If the global is never loaded (but may be stored to), it is dead.
1256 // Delete it now.
1257 if (!GS.isLoaded) {
Bill Wendling8f13b5c2006-11-26 10:02:32 +00001258 DOUT << "GLOBAL NEVER LOADED: " << *GV;
Chris Lattnerf369b382004-10-09 03:32:52 +00001259
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001260 // Delete any stores we can find to the global. We may not be able to
1261 // make it completely dead though.
Chris Lattnercb9f1522004-10-10 16:43:46 +00001262 bool Changed = CleanupConstantGlobalUsers(GV, GV->getInitializer());
Chris Lattnerf369b382004-10-09 03:32:52 +00001263
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001264 // If the global is dead now, delete it.
1265 if (GV->use_empty()) {
Chris Lattner8e71c6a2004-10-16 18:09:00 +00001266 GV->eraseFromParent();
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001267 ++NumDeleted;
Chris Lattnerf369b382004-10-09 03:32:52 +00001268 Changed = true;
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001269 }
Chris Lattnerf369b382004-10-09 03:32:52 +00001270 return Changed;
Misha Brukmanb1c93172005-04-21 23:48:37 +00001271
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001272 } else if (GS.StoredType <= GlobalStatus::isInitializerStored) {
Bill Wendling8f13b5c2006-11-26 10:02:32 +00001273 DOUT << "MARKING CONSTANT: " << *GV;
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001274 GV->setConstant(true);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001275
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001276 // Clean up any obviously simplifiable users now.
1277 CleanupConstantGlobalUsers(GV, GV->getInitializer());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001278
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001279 // If the global is dead now, just nuke it.
1280 if (GV->use_empty()) {
Bill Wendling8f13b5c2006-11-26 10:02:32 +00001281 DOUT << " *** Marking constant allowed us to simplify "
1282 << "all users and delete global!\n";
Chris Lattner8e71c6a2004-10-16 18:09:00 +00001283 GV->eraseFromParent();
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001284 ++NumDeleted;
1285 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001286
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001287 ++NumMarked;
1288 return true;
1289 } else if (!GS.isNotSuitableForSRA &&
1290 !GV->getInitializer()->getType()->isFirstClassType()) {
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001291 if (GlobalVariable *FirstNewGV = SRAGlobal(GV)) {
1292 GVI = FirstNewGV; // Don't skip the newly produced globals!
1293 return true;
1294 }
Chris Lattner09a52722004-10-09 21:48:45 +00001295 } else if (GS.StoredType == GlobalStatus::isStoredOnce) {
Chris Lattner40e4cec2004-12-12 05:53:50 +00001296 // If the initial value for the global was an undef value, and if only
1297 // one other value was stored into it, we can just change the
1298 // initializer to be an undef value, then delete all stores to the
1299 // global. This allows us to mark it constant.
1300 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1301 if (isa<UndefValue>(GV->getInitializer())) {
1302 // Change the initial value here.
1303 GV->setInitializer(SOVConstant);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001304
Chris Lattner40e4cec2004-12-12 05:53:50 +00001305 // Clean up any obviously simplifiable users now.
1306 CleanupConstantGlobalUsers(GV, GV->getInitializer());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001307
Chris Lattner40e4cec2004-12-12 05:53:50 +00001308 if (GV->use_empty()) {
Bill Wendling8f13b5c2006-11-26 10:02:32 +00001309 DOUT << " *** Substituting initializer allowed us to "
1310 << "simplify all users and delete global!\n";
Chris Lattner40e4cec2004-12-12 05:53:50 +00001311 GV->eraseFromParent();
1312 ++NumDeleted;
1313 } else {
1314 GVI = GV;
1315 }
1316 ++NumSubstitute;
1317 return true;
Chris Lattner8e71c6a2004-10-16 18:09:00 +00001318 }
Chris Lattner8e71c6a2004-10-16 18:09:00 +00001319
Chris Lattner09a52722004-10-09 21:48:45 +00001320 // Try to optimize globals based on the knowledge that only one value
1321 // (besides its initializer) is ever stored to the global.
Chris Lattner004e2502004-10-11 05:54:41 +00001322 if (OptimizeOnceStoredGlobal(GV, GS.StoredOnceValue, GVI,
1323 getAnalysis<TargetData>()))
Chris Lattner09a52722004-10-09 21:48:45 +00001324 return true;
Chris Lattner40e4cec2004-12-12 05:53:50 +00001325
1326 // Otherwise, if the global was not a boolean, we can shrink it to be a
1327 // boolean.
1328 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
Chris Lattner1cbd5be2004-12-12 06:03:06 +00001329 if (GV->getType()->getElementType() != Type::BoolTy &&
Chris Lattner5a0bd612006-11-01 18:03:33 +00001330 !GV->getType()->getElementType()->isFloatingPoint() &&
1331 !GS.HasPHIUser) {
Bill Wendling8f13b5c2006-11-26 10:02:32 +00001332 DOUT << " *** SHRINKING TO BOOL: " << *GV;
Chris Lattner40e4cec2004-12-12 05:53:50 +00001333 ShrinkGlobalToBoolean(GV, SOVConstant);
1334 ++NumShrunkToBool;
1335 return true;
1336 }
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001337 }
1338 }
1339 return false;
1340}
1341
Chris Lattnera4c80222005-05-08 22:18:06 +00001342/// OnlyCalledDirectly - Return true if the specified function is only called
1343/// directly. In other words, its address is never taken.
1344static bool OnlyCalledDirectly(Function *F) {
1345 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
1346 Instruction *User = dyn_cast<Instruction>(*UI);
1347 if (!User) return false;
1348 if (!isa<CallInst>(User) && !isa<InvokeInst>(User)) return false;
1349
1350 // See if the function address is passed as an argument.
1351 for (unsigned i = 1, e = User->getNumOperands(); i != e; ++i)
1352 if (User->getOperand(i) == F) return false;
1353 }
1354 return true;
1355}
1356
1357/// ChangeCalleesToFastCall - Walk all of the direct calls of the specified
1358/// function, changing them to FastCC.
1359static void ChangeCalleesToFastCall(Function *F) {
1360 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
1361 Instruction *User = cast<Instruction>(*UI);
1362 if (CallInst *CI = dyn_cast<CallInst>(User))
1363 CI->setCallingConv(CallingConv::Fast);
1364 else
1365 cast<InvokeInst>(User)->setCallingConv(CallingConv::Fast);
1366 }
1367}
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001368
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001369bool GlobalOpt::OptimizeFunctions(Module &M) {
1370 bool Changed = false;
1371 // Optimize functions.
1372 for (Module::iterator FI = M.begin(), E = M.end(); FI != E; ) {
1373 Function *F = FI++;
1374 F->removeDeadConstantUsers();
1375 if (F->use_empty() && (F->hasInternalLinkage() ||
1376 F->hasLinkOnceLinkage())) {
1377 M.getFunctionList().erase(F);
1378 Changed = true;
1379 ++NumFnDeleted;
1380 } else if (F->hasInternalLinkage() &&
1381 F->getCallingConv() == CallingConv::C && !F->isVarArg() &&
1382 OnlyCalledDirectly(F)) {
1383 // If this function has C calling conventions, is not a varargs
1384 // function, and is only called directly, promote it to use the Fast
1385 // calling convention.
1386 F->setCallingConv(CallingConv::Fast);
1387 ChangeCalleesToFastCall(F);
1388 ++NumFastCallFns;
1389 Changed = true;
1390 }
1391 }
1392 return Changed;
1393}
1394
1395bool GlobalOpt::OptimizeGlobalVars(Module &M) {
1396 bool Changed = false;
1397 for (Module::global_iterator GVI = M.global_begin(), E = M.global_end();
1398 GVI != E; ) {
1399 GlobalVariable *GV = GVI++;
1400 if (!GV->isConstant() && GV->hasInternalLinkage() &&
1401 GV->hasInitializer())
1402 Changed |= ProcessInternalGlobal(GV, GVI);
1403 }
1404 return Changed;
1405}
1406
1407/// FindGlobalCtors - Find the llvm.globalctors list, verifying that all
1408/// initializers have an init priority of 65535.
1409GlobalVariable *GlobalOpt::FindGlobalCtors(Module &M) {
Alkis Evlogimenoscb67b652005-10-25 11:18:06 +00001410 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
1411 I != E; ++I)
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001412 if (I->getName() == "llvm.global_ctors") {
1413 // Found it, verify it's an array of { int, void()* }.
1414 const ArrayType *ATy =dyn_cast<ArrayType>(I->getType()->getElementType());
1415 if (!ATy) return 0;
1416 const StructType *STy = dyn_cast<StructType>(ATy->getElementType());
1417 if (!STy || STy->getNumElements() != 2 ||
1418 STy->getElementType(0) != Type::IntTy) return 0;
1419 const PointerType *PFTy = dyn_cast<PointerType>(STy->getElementType(1));
1420 if (!PFTy) return 0;
1421 const FunctionType *FTy = dyn_cast<FunctionType>(PFTy->getElementType());
1422 if (!FTy || FTy->getReturnType() != Type::VoidTy || FTy->isVarArg() ||
1423 FTy->getNumParams() != 0)
1424 return 0;
1425
1426 // Verify that the initializer is simple enough for us to handle.
1427 if (!I->hasInitializer()) return 0;
1428 ConstantArray *CA = dyn_cast<ConstantArray>(I->getInitializer());
1429 if (!CA) return 0;
1430 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1431 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(CA->getOperand(i))) {
Chris Lattner838bdc12005-09-26 02:19:27 +00001432 if (isa<ConstantPointerNull>(CS->getOperand(1)))
1433 continue;
1434
1435 // Must have a function or null ptr.
1436 if (!isa<Function>(CS->getOperand(1)))
1437 return 0;
1438
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001439 // Init priority must be standard.
1440 ConstantInt *CI = dyn_cast<ConstantInt>(CS->getOperand(0));
Reid Spencere0fc4df2006-10-20 07:07:24 +00001441 if (!CI || CI->getZExtValue() != 65535)
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001442 return 0;
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001443 } else {
1444 return 0;
1445 }
1446
1447 return I;
1448 }
1449 return 0;
1450}
1451
Chris Lattner696beef2005-09-26 02:31:18 +00001452/// ParseGlobalCtors - Given a llvm.global_ctors list that we can understand,
1453/// return a list of the functions and null terminator as a vector.
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001454static std::vector<Function*> ParseGlobalCtors(GlobalVariable *GV) {
1455 ConstantArray *CA = cast<ConstantArray>(GV->getInitializer());
1456 std::vector<Function*> Result;
1457 Result.reserve(CA->getNumOperands());
1458 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i) {
1459 ConstantStruct *CS = cast<ConstantStruct>(CA->getOperand(i));
1460 Result.push_back(dyn_cast<Function>(CS->getOperand(1)));
1461 }
1462 return Result;
1463}
1464
Chris Lattner696beef2005-09-26 02:31:18 +00001465/// InstallGlobalCtors - Given a specified llvm.global_ctors list, install the
1466/// specified array, returning the new global to use.
1467static GlobalVariable *InstallGlobalCtors(GlobalVariable *GCL,
1468 const std::vector<Function*> &Ctors) {
1469 // If we made a change, reassemble the initializer list.
1470 std::vector<Constant*> CSVals;
Reid Spencere0fc4df2006-10-20 07:07:24 +00001471 CSVals.push_back(ConstantInt::get(Type::IntTy, 65535));
Chris Lattner696beef2005-09-26 02:31:18 +00001472 CSVals.push_back(0);
1473
1474 // Create the new init list.
1475 std::vector<Constant*> CAList;
1476 for (unsigned i = 0, e = Ctors.size(); i != e; ++i) {
Chris Lattner99e23fa2005-09-26 04:44:35 +00001477 if (Ctors[i]) {
Chris Lattner696beef2005-09-26 02:31:18 +00001478 CSVals[1] = Ctors[i];
Chris Lattner99e23fa2005-09-26 04:44:35 +00001479 } else {
Chris Lattner696beef2005-09-26 02:31:18 +00001480 const Type *FTy = FunctionType::get(Type::VoidTy,
1481 std::vector<const Type*>(), false);
1482 const PointerType *PFTy = PointerType::get(FTy);
1483 CSVals[1] = Constant::getNullValue(PFTy);
Reid Spencere0fc4df2006-10-20 07:07:24 +00001484 CSVals[0] = ConstantInt::get(Type::IntTy, 2147483647);
Chris Lattner696beef2005-09-26 02:31:18 +00001485 }
1486 CAList.push_back(ConstantStruct::get(CSVals));
1487 }
1488
1489 // Create the array initializer.
1490 const Type *StructTy =
1491 cast<ArrayType>(GCL->getType()->getElementType())->getElementType();
1492 Constant *CA = ConstantArray::get(ArrayType::get(StructTy, CAList.size()),
1493 CAList);
1494
1495 // If we didn't change the number of elements, don't create a new GV.
1496 if (CA->getType() == GCL->getInitializer()->getType()) {
1497 GCL->setInitializer(CA);
1498 return GCL;
1499 }
1500
1501 // Create the new global and insert it next to the existing list.
1502 GlobalVariable *NGV = new GlobalVariable(CA->getType(), GCL->isConstant(),
1503 GCL->getLinkage(), CA,
1504 GCL->getName());
1505 GCL->setName("");
1506 GCL->getParent()->getGlobalList().insert(GCL, NGV);
1507
1508 // Nuke the old list, replacing any uses with the new one.
1509 if (!GCL->use_empty()) {
1510 Constant *V = NGV;
1511 if (V->getType() != GCL->getType())
Reid Spencerbb65ebf2006-12-12 23:36:14 +00001512 V = ConstantExpr::getBitCast(V, GCL->getType());
Chris Lattner696beef2005-09-26 02:31:18 +00001513 GCL->replaceAllUsesWith(V);
1514 }
1515 GCL->eraseFromParent();
1516
1517 if (Ctors.size())
1518 return NGV;
1519 else
1520 return 0;
1521}
Chris Lattner99e23fa2005-09-26 04:44:35 +00001522
1523
1524static Constant *getVal(std::map<Value*, Constant*> &ComputedValues,
1525 Value *V) {
1526 if (Constant *CV = dyn_cast<Constant>(V)) return CV;
1527 Constant *R = ComputedValues[V];
1528 assert(R && "Reference to an uncomputed value!");
1529 return R;
1530}
1531
1532/// isSimpleEnoughPointerToCommit - Return true if this constant is simple
1533/// enough for us to understand. In particular, if it is a cast of something,
1534/// we punt. We basically just support direct accesses to globals and GEP's of
1535/// globals. This should be kept up to date with CommitValueTo.
1536static bool isSimpleEnoughPointerToCommit(Constant *C) {
Chris Lattner29b27802005-09-27 04:50:03 +00001537 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C)) {
1538 if (!GV->hasExternalLinkage() && !GV->hasInternalLinkage())
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +00001539 return false; // do not allow weak/linkonce/dllimport/dllexport linkage.
Chris Lattner99e23fa2005-09-26 04:44:35 +00001540 return !GV->isExternal(); // reject external globals.
Chris Lattner29b27802005-09-27 04:50:03 +00001541 }
Chris Lattner46af55e2005-09-26 06:52:44 +00001542 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
1543 // Handle a constantexpr gep.
1544 if (CE->getOpcode() == Instruction::GetElementPtr &&
1545 isa<GlobalVariable>(CE->getOperand(0))) {
1546 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
Chris Lattner29b27802005-09-27 04:50:03 +00001547 if (!GV->hasExternalLinkage() && !GV->hasInternalLinkage())
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +00001548 return false; // do not allow weak/linkonce/dllimport/dllexport linkage.
Chris Lattner46af55e2005-09-26 06:52:44 +00001549 return GV->hasInitializer() &&
1550 ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
1551 }
Chris Lattner99e23fa2005-09-26 04:44:35 +00001552 return false;
1553}
1554
Chris Lattner46af55e2005-09-26 06:52:44 +00001555/// EvaluateStoreInto - Evaluate a piece of a constantexpr store into a global
1556/// initializer. This returns 'Init' modified to reflect 'Val' stored into it.
1557/// At this point, the GEP operands of Addr [0, OpNo) have been stepped into.
1558static Constant *EvaluateStoreInto(Constant *Init, Constant *Val,
1559 ConstantExpr *Addr, unsigned OpNo) {
1560 // Base case of the recursion.
1561 if (OpNo == Addr->getNumOperands()) {
1562 assert(Val->getType() == Init->getType() && "Type mismatch!");
1563 return Val;
1564 }
1565
1566 if (const StructType *STy = dyn_cast<StructType>(Init->getType())) {
1567 std::vector<Constant*> Elts;
1568
1569 // Break up the constant into its elements.
1570 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Init)) {
1571 for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i)
1572 Elts.push_back(CS->getOperand(i));
1573 } else if (isa<ConstantAggregateZero>(Init)) {
1574 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
1575 Elts.push_back(Constant::getNullValue(STy->getElementType(i)));
1576 } else if (isa<UndefValue>(Init)) {
1577 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
1578 Elts.push_back(UndefValue::get(STy->getElementType(i)));
1579 } else {
1580 assert(0 && "This code is out of sync with "
1581 " ConstantFoldLoadThroughGEPConstantExpr");
1582 }
1583
1584 // Replace the element that we are supposed to.
Reid Spencere0fc4df2006-10-20 07:07:24 +00001585 ConstantInt *CU = cast<ConstantInt>(Addr->getOperand(OpNo));
1586 unsigned Idx = CU->getZExtValue();
1587 assert(Idx < STy->getNumElements() && "Struct index out of range!");
Chris Lattner46af55e2005-09-26 06:52:44 +00001588 Elts[Idx] = EvaluateStoreInto(Elts[Idx], Val, Addr, OpNo+1);
1589
1590 // Return the modified struct.
1591 return ConstantStruct::get(Elts);
1592 } else {
1593 ConstantInt *CI = cast<ConstantInt>(Addr->getOperand(OpNo));
1594 const ArrayType *ATy = cast<ArrayType>(Init->getType());
1595
1596 // Break up the array into elements.
1597 std::vector<Constant*> Elts;
1598 if (ConstantArray *CA = dyn_cast<ConstantArray>(Init)) {
1599 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1600 Elts.push_back(CA->getOperand(i));
1601 } else if (isa<ConstantAggregateZero>(Init)) {
1602 Constant *Elt = Constant::getNullValue(ATy->getElementType());
1603 Elts.assign(ATy->getNumElements(), Elt);
1604 } else if (isa<UndefValue>(Init)) {
1605 Constant *Elt = UndefValue::get(ATy->getElementType());
1606 Elts.assign(ATy->getNumElements(), Elt);
1607 } else {
1608 assert(0 && "This code is out of sync with "
1609 " ConstantFoldLoadThroughGEPConstantExpr");
1610 }
1611
Reid Spencere0fc4df2006-10-20 07:07:24 +00001612 assert(CI->getZExtValue() < ATy->getNumElements());
1613 Elts[CI->getZExtValue()] =
1614 EvaluateStoreInto(Elts[CI->getZExtValue()], Val, Addr, OpNo+1);
Chris Lattner46af55e2005-09-26 06:52:44 +00001615 return ConstantArray::get(ATy, Elts);
1616 }
1617}
1618
Chris Lattner99e23fa2005-09-26 04:44:35 +00001619/// CommitValueTo - We have decided that Addr (which satisfies the predicate
1620/// isSimpleEnoughPointerToCommit) should get Val as its value. Make it happen.
1621static void CommitValueTo(Constant *Val, Constant *Addr) {
Chris Lattner46af55e2005-09-26 06:52:44 +00001622 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Addr)) {
1623 assert(GV->hasInitializer());
1624 GV->setInitializer(Val);
1625 return;
1626 }
1627
1628 ConstantExpr *CE = cast<ConstantExpr>(Addr);
1629 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
1630
1631 Constant *Init = GV->getInitializer();
1632 Init = EvaluateStoreInto(Init, Val, CE, 2);
1633 GV->setInitializer(Init);
Chris Lattner99e23fa2005-09-26 04:44:35 +00001634}
1635
Chris Lattnerb0096632005-09-26 05:16:34 +00001636/// ComputeLoadResult - Return the value that would be computed by a load from
1637/// P after the stores reflected by 'memory' have been performed. If we can't
1638/// decide, return null.
Chris Lattner4b05c322005-09-26 05:15:37 +00001639static Constant *ComputeLoadResult(Constant *P,
1640 const std::map<Constant*, Constant*> &Memory) {
1641 // If this memory location has been recently stored, use the stored value: it
1642 // is the most up-to-date.
1643 std::map<Constant*, Constant*>::const_iterator I = Memory.find(P);
1644 if (I != Memory.end()) return I->second;
1645
1646 // Access it.
1647 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(P)) {
1648 if (GV->hasInitializer())
1649 return GV->getInitializer();
1650 return 0;
Chris Lattner4b05c322005-09-26 05:15:37 +00001651 }
Chris Lattner46af55e2005-09-26 06:52:44 +00001652
1653 // Handle a constantexpr getelementptr.
1654 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(P))
1655 if (CE->getOpcode() == Instruction::GetElementPtr &&
1656 isa<GlobalVariable>(CE->getOperand(0))) {
1657 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
1658 if (GV->hasInitializer())
1659 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
1660 }
1661
1662 return 0; // don't know how to evaluate.
Chris Lattner4b05c322005-09-26 05:15:37 +00001663}
1664
Chris Lattnerda1889b2005-09-27 04:27:01 +00001665/// EvaluateFunction - Evaluate a call to function F, returning true if
1666/// successful, false if we can't evaluate it. ActualArgs contains the formal
1667/// arguments for the function.
Chris Lattner65a3a092005-09-27 04:45:34 +00001668static bool EvaluateFunction(Function *F, Constant *&RetVal,
Chris Lattnerda1889b2005-09-27 04:27:01 +00001669 const std::vector<Constant*> &ActualArgs,
1670 std::vector<Function*> &CallStack,
1671 std::map<Constant*, Constant*> &MutatedMemory,
1672 std::vector<GlobalVariable*> &AllocaTmps) {
Chris Lattner65a3a092005-09-27 04:45:34 +00001673 // Check to see if this function is already executing (recursion). If so,
1674 // bail out. TODO: we might want to accept limited recursion.
1675 if (std::find(CallStack.begin(), CallStack.end(), F) != CallStack.end())
1676 return false;
1677
1678 CallStack.push_back(F);
1679
Chris Lattner99e23fa2005-09-26 04:44:35 +00001680 /// Values - As we compute SSA register values, we store their contents here.
1681 std::map<Value*, Constant*> Values;
Chris Lattner65a3a092005-09-27 04:45:34 +00001682
1683 // Initialize arguments to the incoming values specified.
1684 unsigned ArgNo = 0;
1685 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end(); AI != E;
1686 ++AI, ++ArgNo)
1687 Values[AI] = ActualArgs[ArgNo];
Chris Lattnerda1889b2005-09-27 04:27:01 +00001688
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00001689 /// ExecutedBlocks - We only handle non-looping, non-recursive code. As such,
1690 /// we can only evaluate any one basic block at most once. This set keeps
1691 /// track of what we have executed so we can detect recursive cases etc.
1692 std::set<BasicBlock*> ExecutedBlocks;
Chris Lattner6bf2cd52005-09-26 17:07:09 +00001693
Chris Lattner99e23fa2005-09-26 04:44:35 +00001694 // CurInst - The current instruction we're evaluating.
1695 BasicBlock::iterator CurInst = F->begin()->begin();
1696
1697 // This is the main evaluation loop.
1698 while (1) {
1699 Constant *InstResult = 0;
1700
1701 if (StoreInst *SI = dyn_cast<StoreInst>(CurInst)) {
Chris Lattner65a3a092005-09-27 04:45:34 +00001702 if (SI->isVolatile()) return false; // no volatile accesses.
Chris Lattner99e23fa2005-09-26 04:44:35 +00001703 Constant *Ptr = getVal(Values, SI->getOperand(1));
1704 if (!isSimpleEnoughPointerToCommit(Ptr))
1705 // If this is too complex for us to commit, reject it.
Chris Lattner65a3a092005-09-27 04:45:34 +00001706 return false;
Chris Lattner99e23fa2005-09-26 04:44:35 +00001707 Constant *Val = getVal(Values, SI->getOperand(0));
1708 MutatedMemory[Ptr] = Val;
1709 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(CurInst)) {
1710 InstResult = ConstantExpr::get(BO->getOpcode(),
1711 getVal(Values, BO->getOperand(0)),
1712 getVal(Values, BO->getOperand(1)));
1713 } else if (ShiftInst *SI = dyn_cast<ShiftInst>(CurInst)) {
1714 InstResult = ConstantExpr::get(SI->getOpcode(),
1715 getVal(Values, SI->getOperand(0)),
1716 getVal(Values, SI->getOperand(1)));
1717 } else if (CastInst *CI = dyn_cast<CastInst>(CurInst)) {
Chris Lattner0390b9e2006-11-30 17:26:08 +00001718 InstResult = ConstantExpr::getCast(CI->getOpcode(),
1719 getVal(Values, CI->getOperand(0)),
Chris Lattner99e23fa2005-09-26 04:44:35 +00001720 CI->getType());
1721 } else if (SelectInst *SI = dyn_cast<SelectInst>(CurInst)) {
1722 InstResult = ConstantExpr::getSelect(getVal(Values, SI->getOperand(0)),
1723 getVal(Values, SI->getOperand(1)),
1724 getVal(Values, SI->getOperand(2)));
Chris Lattner4b05c322005-09-26 05:15:37 +00001725 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(CurInst)) {
1726 Constant *P = getVal(Values, GEP->getOperand(0));
1727 std::vector<Constant*> GEPOps;
1728 for (unsigned i = 1, e = GEP->getNumOperands(); i != e; ++i)
1729 GEPOps.push_back(getVal(Values, GEP->getOperand(i)));
1730 InstResult = ConstantExpr::getGetElementPtr(P, GEPOps);
1731 } else if (LoadInst *LI = dyn_cast<LoadInst>(CurInst)) {
Chris Lattner65a3a092005-09-27 04:45:34 +00001732 if (LI->isVolatile()) return false; // no volatile accesses.
Chris Lattner4b05c322005-09-26 05:15:37 +00001733 InstResult = ComputeLoadResult(getVal(Values, LI->getOperand(0)),
1734 MutatedMemory);
Chris Lattner65a3a092005-09-27 04:45:34 +00001735 if (InstResult == 0) return false; // Could not evaluate load.
Chris Lattner6bf2cd52005-09-26 17:07:09 +00001736 } else if (AllocaInst *AI = dyn_cast<AllocaInst>(CurInst)) {
Chris Lattner65a3a092005-09-27 04:45:34 +00001737 if (AI->isArrayAllocation()) return false; // Cannot handle array allocs.
Chris Lattner6bf2cd52005-09-26 17:07:09 +00001738 const Type *Ty = AI->getType()->getElementType();
1739 AllocaTmps.push_back(new GlobalVariable(Ty, false,
1740 GlobalValue::InternalLinkage,
1741 UndefValue::get(Ty),
1742 AI->getName()));
Chris Lattner65a3a092005-09-27 04:45:34 +00001743 InstResult = AllocaTmps.back();
1744 } else if (CallInst *CI = dyn_cast<CallInst>(CurInst)) {
Chris Lattnerfd2e13b2006-07-07 21:37:01 +00001745 // Cannot handle inline asm.
1746 if (isa<InlineAsm>(CI->getOperand(0))) return false;
1747
Chris Lattner65a3a092005-09-27 04:45:34 +00001748 // Resolve function pointers.
1749 Function *Callee = dyn_cast<Function>(getVal(Values, CI->getOperand(0)));
1750 if (!Callee) return false; // Cannot resolve.
Chris Lattner3d27e7f2005-09-27 05:02:43 +00001751
Chris Lattner65a3a092005-09-27 04:45:34 +00001752 std::vector<Constant*> Formals;
1753 for (unsigned i = 1, e = CI->getNumOperands(); i != e; ++i)
1754 Formals.push_back(getVal(Values, CI->getOperand(i)));
Chris Lattner65a3a092005-09-27 04:45:34 +00001755
Chris Lattner3d27e7f2005-09-27 05:02:43 +00001756 if (Callee->isExternal()) {
1757 // If this is a function we can constant fold, do it.
1758 if (Constant *C = ConstantFoldCall(Callee, Formals)) {
1759 InstResult = C;
1760 } else {
1761 return false;
1762 }
1763 } else {
1764 if (Callee->getFunctionType()->isVarArg())
1765 return false;
1766
1767 Constant *RetVal;
1768
1769 // Execute the call, if successful, use the return value.
1770 if (!EvaluateFunction(Callee, RetVal, Formals, CallStack,
1771 MutatedMemory, AllocaTmps))
1772 return false;
1773 InstResult = RetVal;
1774 }
Reid Spencerde46e482006-11-02 20:25:50 +00001775 } else if (isa<TerminatorInst>(CurInst)) {
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00001776 BasicBlock *NewBB = 0;
1777 if (BranchInst *BI = dyn_cast<BranchInst>(CurInst)) {
1778 if (BI->isUnconditional()) {
1779 NewBB = BI->getSuccessor(0);
1780 } else {
1781 ConstantBool *Cond =
1782 dyn_cast<ConstantBool>(getVal(Values, BI->getCondition()));
Chris Lattner65a3a092005-09-27 04:45:34 +00001783 if (!Cond) return false; // Cannot determine.
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00001784 NewBB = BI->getSuccessor(!Cond->getValue());
1785 }
1786 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(CurInst)) {
1787 ConstantInt *Val =
1788 dyn_cast<ConstantInt>(getVal(Values, SI->getCondition()));
Chris Lattner65a3a092005-09-27 04:45:34 +00001789 if (!Val) return false; // Cannot determine.
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00001790 NewBB = SI->getSuccessor(SI->findCaseValue(Val));
1791 } else if (ReturnInst *RI = dyn_cast<ReturnInst>(CurInst)) {
Chris Lattner65a3a092005-09-27 04:45:34 +00001792 if (RI->getNumOperands())
1793 RetVal = getVal(Values, RI->getOperand(0));
1794
1795 CallStack.pop_back(); // return from fn.
Chris Lattnerda1889b2005-09-27 04:27:01 +00001796 return true; // We succeeded at evaluating this ctor!
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00001797 } else {
Chris Lattner65a3a092005-09-27 04:45:34 +00001798 // invoke, unwind, unreachable.
1799 return false; // Cannot handle this terminator.
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00001800 }
1801
1802 // Okay, we succeeded in evaluating this control flow. See if we have
Chris Lattner65a3a092005-09-27 04:45:34 +00001803 // executed the new block before. If so, we have a looping function,
1804 // which we cannot evaluate in reasonable time.
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00001805 if (!ExecutedBlocks.insert(NewBB).second)
Chris Lattner65a3a092005-09-27 04:45:34 +00001806 return false; // looped!
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00001807
1808 // Okay, we have never been in this block before. Check to see if there
1809 // are any PHI nodes. If so, evaluate them with information about where
1810 // we came from.
1811 BasicBlock *OldBB = CurInst->getParent();
1812 CurInst = NewBB->begin();
1813 PHINode *PN;
1814 for (; (PN = dyn_cast<PHINode>(CurInst)); ++CurInst)
1815 Values[PN] = getVal(Values, PN->getIncomingValueForBlock(OldBB));
1816
1817 // Do NOT increment CurInst. We know that the terminator had no value.
1818 continue;
Chris Lattner99e23fa2005-09-26 04:44:35 +00001819 } else {
Chris Lattner99e23fa2005-09-26 04:44:35 +00001820 // Did not know how to evaluate this!
Chris Lattner65a3a092005-09-27 04:45:34 +00001821 return false;
Chris Lattner99e23fa2005-09-26 04:44:35 +00001822 }
1823
1824 if (!CurInst->use_empty())
1825 Values[CurInst] = InstResult;
1826
1827 // Advance program counter.
1828 ++CurInst;
1829 }
Chris Lattnerda1889b2005-09-27 04:27:01 +00001830}
1831
1832/// EvaluateStaticConstructor - Evaluate static constructors in the function, if
1833/// we can. Return true if we can, false otherwise.
1834static bool EvaluateStaticConstructor(Function *F) {
1835 /// MutatedMemory - For each store we execute, we update this map. Loads
1836 /// check this to get the most up-to-date value. If evaluation is successful,
1837 /// this state is committed to the process.
1838 std::map<Constant*, Constant*> MutatedMemory;
1839
1840 /// AllocaTmps - To 'execute' an alloca, we create a temporary global variable
1841 /// to represent its body. This vector is needed so we can delete the
1842 /// temporary globals when we are done.
1843 std::vector<GlobalVariable*> AllocaTmps;
1844
1845 /// CallStack - This is used to detect recursion. In pathological situations
1846 /// we could hit exponential behavior, but at least there is nothing
1847 /// unbounded.
1848 std::vector<Function*> CallStack;
1849
1850 // Call the function.
Chris Lattner65a3a092005-09-27 04:45:34 +00001851 Constant *RetValDummy;
1852 bool EvalSuccess = EvaluateFunction(F, RetValDummy, std::vector<Constant*>(),
1853 CallStack, MutatedMemory, AllocaTmps);
Chris Lattnerda1889b2005-09-27 04:27:01 +00001854 if (EvalSuccess) {
Chris Lattner6bf2cd52005-09-26 17:07:09 +00001855 // We succeeded at evaluation: commit the result.
Bill Wendling8f13b5c2006-11-26 10:02:32 +00001856 DOUT << "FULLY EVALUATED GLOBAL CTOR FUNCTION '"
1857 << F->getName() << "' to " << MutatedMemory.size()
1858 << " stores.\n";
Chris Lattner6bf2cd52005-09-26 17:07:09 +00001859 for (std::map<Constant*, Constant*>::iterator I = MutatedMemory.begin(),
1860 E = MutatedMemory.end(); I != E; ++I)
1861 CommitValueTo(I->second, I->first);
1862 }
Chris Lattner99e23fa2005-09-26 04:44:35 +00001863
Chris Lattner6bf2cd52005-09-26 17:07:09 +00001864 // At this point, we are done interpreting. If we created any 'alloca'
1865 // temporaries, release them now.
1866 while (!AllocaTmps.empty()) {
1867 GlobalVariable *Tmp = AllocaTmps.back();
1868 AllocaTmps.pop_back();
Chris Lattnerda1889b2005-09-27 04:27:01 +00001869
Chris Lattner6bf2cd52005-09-26 17:07:09 +00001870 // If there are still users of the alloca, the program is doing something
1871 // silly, e.g. storing the address of the alloca somewhere and using it
1872 // later. Since this is undefined, we'll just make it be null.
1873 if (!Tmp->use_empty())
1874 Tmp->replaceAllUsesWith(Constant::getNullValue(Tmp->getType()));
1875 delete Tmp;
1876 }
Chris Lattner46d9ff082005-09-26 07:34:35 +00001877
Chris Lattnerda1889b2005-09-27 04:27:01 +00001878 return EvalSuccess;
Chris Lattner99e23fa2005-09-26 04:44:35 +00001879}
1880
Chris Lattner696beef2005-09-26 02:31:18 +00001881
Chris Lattnerda1889b2005-09-27 04:27:01 +00001882
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001883/// OptimizeGlobalCtorsList - Simplify and evaluation global ctors if possible.
1884/// Return true if anything changed.
1885bool GlobalOpt::OptimizeGlobalCtorsList(GlobalVariable *&GCL) {
1886 std::vector<Function*> Ctors = ParseGlobalCtors(GCL);
1887 bool MadeChange = false;
1888 if (Ctors.empty()) return false;
1889
1890 // Loop over global ctors, optimizing them when we can.
1891 for (unsigned i = 0; i != Ctors.size(); ++i) {
1892 Function *F = Ctors[i];
1893 // Found a null terminator in the middle of the list, prune off the rest of
1894 // the list.
Chris Lattner838bdc12005-09-26 02:19:27 +00001895 if (F == 0) {
1896 if (i != Ctors.size()-1) {
1897 Ctors.resize(i+1);
1898 MadeChange = true;
1899 }
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001900 break;
1901 }
1902
Chris Lattner99e23fa2005-09-26 04:44:35 +00001903 // We cannot simplify external ctor functions.
1904 if (F->empty()) continue;
1905
1906 // If we can evaluate the ctor at compile time, do.
1907 if (EvaluateStaticConstructor(F)) {
1908 Ctors.erase(Ctors.begin()+i);
1909 MadeChange = true;
1910 --i;
1911 ++NumCtorsEvaluated;
1912 continue;
1913 }
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001914 }
1915
1916 if (!MadeChange) return false;
1917
Chris Lattner696beef2005-09-26 02:31:18 +00001918 GCL = InstallGlobalCtors(GCL, Ctors);
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001919 return true;
1920}
1921
1922
Chris Lattner25db5802004-10-07 04:16:33 +00001923bool GlobalOpt::runOnModule(Module &M) {
1924 bool Changed = false;
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001925
1926 // Try to find the llvm.globalctors list.
1927 GlobalVariable *GlobalCtors = FindGlobalCtors(M);
Chris Lattner25db5802004-10-07 04:16:33 +00001928
Chris Lattner25db5802004-10-07 04:16:33 +00001929 bool LocalChange = true;
1930 while (LocalChange) {
1931 LocalChange = false;
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001932
1933 // Delete functions that are trivially dead, ccc -> fastcc
1934 LocalChange |= OptimizeFunctions(M);
1935
1936 // Optimize global_ctors list.
1937 if (GlobalCtors)
1938 LocalChange |= OptimizeGlobalCtorsList(GlobalCtors);
1939
1940 // Optimize non-address-taken globals.
1941 LocalChange |= OptimizeGlobalVars(M);
Chris Lattner25db5802004-10-07 04:16:33 +00001942 Changed |= LocalChange;
1943 }
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001944
1945 // TODO: Move all global ctors functions to the end of the module for code
1946 // layout.
1947
Chris Lattner25db5802004-10-07 04:16:33 +00001948 return Changed;
1949}