blob: 4e081dd20571ec3c9b9ba6148a26a1b7016e44df [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 <set>
31#include <algorithm>
32using namespace llvm;
33
34namespace {
Chris Lattnerabab0712004-10-08 17:32:09 +000035 Statistic<> NumMarked ("globalopt", "Number of globals marked constant");
36 Statistic<> NumSRA ("globalopt", "Number of aggregate globals broken "
37 "into scalars");
Chris Lattner8e71c6a2004-10-16 18:09:00 +000038 Statistic<> NumSubstitute("globalopt",
39 "Number of globals with initializers stored into them");
Chris Lattnerabab0712004-10-08 17:32:09 +000040 Statistic<> NumDeleted ("globalopt", "Number of globals deleted");
Chris Lattner25db5802004-10-07 04:16:33 +000041 Statistic<> NumFnDeleted("globalopt", "Number of functions deleted");
Chris Lattnere42eb312004-10-10 23:14:11 +000042 Statistic<> NumGlobUses ("globalopt", "Number of global uses devirtualized");
Alkis Evlogimenosc4a44c62005-02-10 18:36:30 +000043 Statistic<> NumLocalized("globalopt", "Number of globals localized");
Chris Lattner40e4cec2004-12-12 05:53:50 +000044 Statistic<> NumShrunkToBool("globalopt",
45 "Number of global vars shrunk to booleans");
Chris Lattnera4c80222005-05-08 22:18:06 +000046 Statistic<> NumFastCallFns("globalopt",
47 "Number of functions converted to fastcc");
Chris Lattner41b6a5a2005-09-26 01:43:45 +000048 Statistic<> NumEmptyCtor ("globalopt", "Number of empty ctors removed");
Chris Lattner99e23fa2005-09-26 04:44:35 +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 Lattner531f9e92005-03-15 04:54:21 +000063 bool ProcessInternalGlobal(GlobalVariable *GV, Module::global_iterator &GVI);
Chris Lattner25db5802004-10-07 04:16:33 +000064 };
65
66 RegisterOpt<GlobalOpt> X("globalopt", "Global Variable Optimizer");
67}
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
Alkis Evlogimenosc4a44c62005-02-10 18:36:30 +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.
110 Function *AccessingFunction;
111 bool HasMultipleAccessingFunctions;
112
Chris Lattner50bdfcb2005-06-15 21:11:48 +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).
115 bool HasNonInstructionUser;
116
Chris Lattner617f1a32004-10-07 21:30:30 +0000117 /// isNotSuitableForSRA - Keep track of whether any SRA preventing users of
118 /// the global exist. Such users include GEP instruction with variable
119 /// indexes, and non-gep/load/store users like constant expr casts.
Chris Lattner25db5802004-10-07 04:16:33 +0000120 bool isNotSuitableForSRA;
121
Chris Lattner617f1a32004-10-07 21:30:30 +0000122 GlobalStatus() : isLoaded(false), StoredType(NotStored), StoredOnceValue(0),
Alkis Evlogimenosc4a44c62005-02-10 18:36:30 +0000123 AccessingFunction(0), HasMultipleAccessingFunctions(false),
Chris Lattner50bdfcb2005-06-15 21:11:48 +0000124 HasNonInstructionUser(false), isNotSuitableForSRA(false) {}
Chris Lattner25db5802004-10-07 04:16:33 +0000125};
126
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000127
128
129/// ConstantIsDead - Return true if the specified constant is (transitively)
130/// dead. The constant may be used by other constants (e.g. constant arrays and
131/// constant exprs) as long as they are dead, but it cannot be used by anything
132/// else.
133static bool ConstantIsDead(Constant *C) {
134 if (isa<GlobalValue>(C)) return false;
135
136 for (Value::use_iterator UI = C->use_begin(), E = C->use_end(); UI != E; ++UI)
137 if (Constant *CU = dyn_cast<Constant>(*UI)) {
138 if (!ConstantIsDead(CU)) return false;
139 } else
140 return false;
141 return true;
142}
143
144
Chris Lattner25db5802004-10-07 04:16:33 +0000145/// AnalyzeGlobal - Look at all uses of the global and fill in the GlobalStatus
146/// structure. If the global has its address taken, return true to indicate we
147/// can't do anything with it.
148///
149static bool AnalyzeGlobal(Value *V, GlobalStatus &GS,
150 std::set<PHINode*> &PHIUsers) {
151 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
152 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(*UI)) {
Chris Lattner50bdfcb2005-06-15 21:11:48 +0000153 GS.HasNonInstructionUser = true;
154
Chris Lattner25db5802004-10-07 04:16:33 +0000155 if (AnalyzeGlobal(CE, GS, PHIUsers)) return true;
156 if (CE->getOpcode() != Instruction::GetElementPtr)
157 GS.isNotSuitableForSRA = true;
Chris Lattnerabab0712004-10-08 17:32:09 +0000158 else if (!GS.isNotSuitableForSRA) {
159 // Check to see if this ConstantExpr GEP is SRA'able. In particular, we
160 // don't like < 3 operand CE's, and we don't like non-constant integer
161 // indices.
162 if (CE->getNumOperands() < 3 || !CE->getOperand(1)->isNullValue())
163 GS.isNotSuitableForSRA = true;
164 else {
165 for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
166 if (!isa<ConstantInt>(CE->getOperand(i))) {
167 GS.isNotSuitableForSRA = true;
168 break;
169 }
170 }
171 }
172
Chris Lattner25db5802004-10-07 04:16:33 +0000173 } else if (Instruction *I = dyn_cast<Instruction>(*UI)) {
Alkis Evlogimenosc4a44c62005-02-10 18:36:30 +0000174 if (!GS.HasMultipleAccessingFunctions) {
175 Function *F = I->getParent()->getParent();
176 if (GS.AccessingFunction == 0)
177 GS.AccessingFunction = F;
178 else if (GS.AccessingFunction != F)
179 GS.HasMultipleAccessingFunctions = true;
180 }
Chris Lattner25db5802004-10-07 04:16:33 +0000181 if (isa<LoadInst>(I)) {
182 GS.isLoaded = true;
183 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
Chris Lattner02b6c912004-10-07 06:01:25 +0000184 // Don't allow a store OF the address, only stores TO the address.
185 if (SI->getOperand(0) == V) return true;
186
Chris Lattner617f1a32004-10-07 21:30:30 +0000187 // If this is a direct store to the global (i.e., the global is a scalar
188 // value, not an aggregate), keep more specific information about
189 // stores.
190 if (GS.StoredType != GlobalStatus::isStored)
191 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(SI->getOperand(1))){
Chris Lattner28eeb732004-11-14 20:50:30 +0000192 Value *StoredVal = SI->getOperand(0);
193 if (StoredVal == GV->getInitializer()) {
194 if (GS.StoredType < GlobalStatus::isInitializerStored)
195 GS.StoredType = GlobalStatus::isInitializerStored;
196 } else if (isa<LoadInst>(StoredVal) &&
197 cast<LoadInst>(StoredVal)->getOperand(0) == GV) {
198 // G = G
Chris Lattner617f1a32004-10-07 21:30:30 +0000199 if (GS.StoredType < GlobalStatus::isInitializerStored)
200 GS.StoredType = GlobalStatus::isInitializerStored;
201 } else if (GS.StoredType < GlobalStatus::isStoredOnce) {
202 GS.StoredType = GlobalStatus::isStoredOnce;
Chris Lattner28eeb732004-11-14 20:50:30 +0000203 GS.StoredOnceValue = StoredVal;
Chris Lattner617f1a32004-10-07 21:30:30 +0000204 } else if (GS.StoredType == GlobalStatus::isStoredOnce &&
Chris Lattner28eeb732004-11-14 20:50:30 +0000205 GS.StoredOnceValue == StoredVal) {
Chris Lattner617f1a32004-10-07 21:30:30 +0000206 // noop.
207 } else {
208 GS.StoredType = GlobalStatus::isStored;
209 }
210 } else {
Chris Lattner25db5802004-10-07 04:16:33 +0000211 GS.StoredType = GlobalStatus::isStored;
Chris Lattner617f1a32004-10-07 21:30:30 +0000212 }
Chris Lattner7561ca12005-02-27 18:58:52 +0000213 } else if (isa<GetElementPtrInst>(I)) {
Chris Lattner25db5802004-10-07 04:16:33 +0000214 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
Chris Lattner004e2502004-10-11 05:54:41 +0000215
216 // If the first two indices are constants, this can be SRA'd.
217 if (isa<GlobalVariable>(I->getOperand(0))) {
218 if (I->getNumOperands() < 3 || !isa<Constant>(I->getOperand(1)) ||
Misha Brukmanb1c93172005-04-21 23:48:37 +0000219 !cast<Constant>(I->getOperand(1))->isNullValue() ||
Chris Lattner004e2502004-10-11 05:54:41 +0000220 !isa<ConstantInt>(I->getOperand(2)))
221 GS.isNotSuitableForSRA = true;
222 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I->getOperand(0))){
223 if (CE->getOpcode() != Instruction::GetElementPtr ||
224 CE->getNumOperands() < 3 || I->getNumOperands() < 2 ||
225 !isa<Constant>(I->getOperand(0)) ||
226 !cast<Constant>(I->getOperand(0))->isNullValue())
227 GS.isNotSuitableForSRA = true;
228 } else {
229 GS.isNotSuitableForSRA = true;
230 }
Chris Lattner7561ca12005-02-27 18:58:52 +0000231 } else if (isa<SelectInst>(I)) {
Chris Lattner25db5802004-10-07 04:16:33 +0000232 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
233 GS.isNotSuitableForSRA = true;
234 } else if (PHINode *PN = dyn_cast<PHINode>(I)) {
235 // PHI nodes we can check just like select or GEP instructions, but we
236 // have to be careful about infinite recursion.
237 if (PHIUsers.insert(PN).second) // Not already visited.
238 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
239 GS.isNotSuitableForSRA = true;
240 } else if (isa<SetCondInst>(I)) {
241 GS.isNotSuitableForSRA = true;
Chris Lattner7561ca12005-02-27 18:58:52 +0000242 } else if (isa<MemCpyInst>(I) || isa<MemMoveInst>(I)) {
243 if (I->getOperand(1) == V)
244 GS.StoredType = GlobalStatus::isStored;
245 if (I->getOperand(2) == V)
246 GS.isLoaded = true;
247 GS.isNotSuitableForSRA = true;
248 } else if (isa<MemSetInst>(I)) {
249 assert(I->getOperand(1) == V && "Memset only takes one pointer!");
250 GS.StoredType = GlobalStatus::isStored;
251 GS.isNotSuitableForSRA = true;
Chris Lattner25db5802004-10-07 04:16:33 +0000252 } else {
253 return true; // Any other non-load instruction might take address!
254 }
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000255 } else if (Constant *C = dyn_cast<Constant>(*UI)) {
Chris Lattner50bdfcb2005-06-15 21:11:48 +0000256 GS.HasNonInstructionUser = true;
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000257 // We might have a dead and dangling constant hanging off of here.
258 if (!ConstantIsDead(C))
259 return true;
Chris Lattner25db5802004-10-07 04:16:33 +0000260 } else {
Chris Lattner50bdfcb2005-06-15 21:11:48 +0000261 GS.HasNonInstructionUser = true;
262 // Otherwise must be some other user.
Chris Lattner25db5802004-10-07 04:16:33 +0000263 return true;
264 }
265
266 return false;
267}
268
Chris Lattnerabab0712004-10-08 17:32:09 +0000269static Constant *getAggregateConstantElement(Constant *Agg, Constant *Idx) {
270 ConstantInt *CI = dyn_cast<ConstantInt>(Idx);
271 if (!CI) return 0;
Chris Lattner46fa04b2005-01-08 19:45:31 +0000272 unsigned IdxV = (unsigned)CI->getRawValue();
Chris Lattner25db5802004-10-07 04:16:33 +0000273
Chris Lattnerabab0712004-10-08 17:32:09 +0000274 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Agg)) {
275 if (IdxV < CS->getNumOperands()) return CS->getOperand(IdxV);
276 } else if (ConstantArray *CA = dyn_cast<ConstantArray>(Agg)) {
277 if (IdxV < CA->getNumOperands()) return CA->getOperand(IdxV);
278 } else if (ConstantPacked *CP = dyn_cast<ConstantPacked>(Agg)) {
279 if (IdxV < CP->getNumOperands()) return CP->getOperand(IdxV);
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000280 } else if (isa<ConstantAggregateZero>(Agg)) {
Chris Lattnerabab0712004-10-08 17:32:09 +0000281 if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
282 if (IdxV < STy->getNumElements())
283 return Constant::getNullValue(STy->getElementType(IdxV));
284 } else if (const SequentialType *STy =
285 dyn_cast<SequentialType>(Agg->getType())) {
286 return Constant::getNullValue(STy->getElementType());
287 }
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000288 } else if (isa<UndefValue>(Agg)) {
289 if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
290 if (IdxV < STy->getNumElements())
291 return UndefValue::get(STy->getElementType(IdxV));
292 } else if (const SequentialType *STy =
293 dyn_cast<SequentialType>(Agg->getType())) {
294 return UndefValue::get(STy->getElementType());
295 }
Chris Lattnerabab0712004-10-08 17:32:09 +0000296 }
297 return 0;
298}
Chris Lattner25db5802004-10-07 04:16:33 +0000299
Chris Lattner25db5802004-10-07 04:16:33 +0000300
301/// CleanupConstantGlobalUsers - We just marked GV constant. Loop over all
302/// users of the global, cleaning up the obvious ones. This is largely just a
Chris Lattnercb9f1522004-10-10 16:43:46 +0000303/// quick scan over the use list to clean up the easy and obvious cruft. This
304/// returns true if it made a change.
305static bool CleanupConstantGlobalUsers(Value *V, Constant *Init) {
306 bool Changed = false;
Chris Lattner25db5802004-10-07 04:16:33 +0000307 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;) {
308 User *U = *UI++;
Misha Brukmanb1c93172005-04-21 23:48:37 +0000309
Chris Lattner25db5802004-10-07 04:16:33 +0000310 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattner7561ca12005-02-27 18:58:52 +0000311 if (Init) {
312 // Replace the load with the initializer.
313 LI->replaceAllUsesWith(Init);
314 LI->eraseFromParent();
315 Changed = true;
316 }
Chris Lattner25db5802004-10-07 04:16:33 +0000317 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
318 // Store must be unreachable or storing Init into the global.
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000319 SI->eraseFromParent();
Chris Lattnercb9f1522004-10-10 16:43:46 +0000320 Changed = true;
Chris Lattner25db5802004-10-07 04:16:33 +0000321 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
322 if (CE->getOpcode() == Instruction::GetElementPtr) {
Chris Lattner61ff32c2005-09-26 05:34:07 +0000323 Constant *SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
Chris Lattner7561ca12005-02-27 18:58:52 +0000324 Changed |= CleanupConstantGlobalUsers(CE, SubInit);
325 } else if (CE->getOpcode() == Instruction::Cast &&
326 isa<PointerType>(CE->getType())) {
327 // Pointer cast, delete any stores and memsets to the global.
328 Changed |= CleanupConstantGlobalUsers(CE, 0);
329 }
330
331 if (CE->use_empty()) {
332 CE->destroyConstant();
333 Changed = true;
Chris Lattner25db5802004-10-07 04:16:33 +0000334 }
335 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner61ff32c2005-09-26 05:34:07 +0000336 Constant *SubInit = 0;
337 ConstantExpr *CE = dyn_cast<ConstantExpr>(ConstantFoldInstruction(GEP));
338 if (CE && CE->getOpcode() == Instruction::GetElementPtr)
339 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
Chris Lattner7561ca12005-02-27 18:58:52 +0000340 Changed |= CleanupConstantGlobalUsers(GEP, SubInit);
Chris Lattnera0e769c2004-10-10 16:47:33 +0000341
Chris Lattnercb9f1522004-10-10 16:43:46 +0000342 if (GEP->use_empty()) {
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000343 GEP->eraseFromParent();
Chris Lattnercb9f1522004-10-10 16:43:46 +0000344 Changed = true;
345 }
Chris Lattner7561ca12005-02-27 18:58:52 +0000346 } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(U)) { // memset/cpy/mv
347 if (MI->getRawDest() == V) {
348 MI->eraseFromParent();
349 Changed = true;
350 }
351
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000352 } else if (Constant *C = dyn_cast<Constant>(U)) {
353 // If we have a chain of dead constantexprs or other things dangling from
354 // us, and if they are all dead, nuke them without remorse.
355 if (ConstantIsDead(C)) {
356 C->destroyConstant();
Chris Lattner7561ca12005-02-27 18:58:52 +0000357 // This could have invalidated UI, start over from scratch.
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000358 CleanupConstantGlobalUsers(V, Init);
Chris Lattnercb9f1522004-10-10 16:43:46 +0000359 return true;
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000360 }
Chris Lattner25db5802004-10-07 04:16:33 +0000361 }
362 }
Chris Lattnercb9f1522004-10-10 16:43:46 +0000363 return Changed;
Chris Lattner25db5802004-10-07 04:16:33 +0000364}
365
Chris Lattnerabab0712004-10-08 17:32:09 +0000366/// SRAGlobal - Perform scalar replacement of aggregates on the specified global
367/// variable. This opens the door for other optimizations by exposing the
368/// behavior of the program in a more fine-grained way. We have determined that
369/// this transformation is safe already. We return the first global variable we
370/// insert so that the caller can reprocess it.
371static GlobalVariable *SRAGlobal(GlobalVariable *GV) {
372 assert(GV->hasInternalLinkage() && !GV->isConstant());
373 Constant *Init = GV->getInitializer();
374 const Type *Ty = Init->getType();
Misha Brukmanb1c93172005-04-21 23:48:37 +0000375
Chris Lattnerabab0712004-10-08 17:32:09 +0000376 std::vector<GlobalVariable*> NewGlobals;
377 Module::GlobalListType &Globals = GV->getParent()->getGlobalList();
378
379 if (const StructType *STy = dyn_cast<StructType>(Ty)) {
380 NewGlobals.reserve(STy->getNumElements());
381 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
382 Constant *In = getAggregateConstantElement(Init,
383 ConstantUInt::get(Type::UIntTy, i));
384 assert(In && "Couldn't get element of initializer?");
385 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(i), false,
386 GlobalVariable::InternalLinkage,
387 In, GV->getName()+"."+utostr(i));
388 Globals.insert(GV, NGV);
389 NewGlobals.push_back(NGV);
390 }
391 } else if (const SequentialType *STy = dyn_cast<SequentialType>(Ty)) {
392 unsigned NumElements = 0;
393 if (const ArrayType *ATy = dyn_cast<ArrayType>(STy))
394 NumElements = ATy->getNumElements();
395 else if (const PackedType *PTy = dyn_cast<PackedType>(STy))
396 NumElements = PTy->getNumElements();
397 else
398 assert(0 && "Unknown aggregate sequential type!");
399
Chris Lattner25169ca2005-02-23 16:53:04 +0000400 if (NumElements > 16 && GV->hasNUsesOrMore(16))
Chris Lattnerd6a44922005-02-01 01:23:31 +0000401 return 0; // It's not worth it.
Chris Lattnerabab0712004-10-08 17:32:09 +0000402 NewGlobals.reserve(NumElements);
403 for (unsigned i = 0, e = NumElements; i != e; ++i) {
404 Constant *In = getAggregateConstantElement(Init,
405 ConstantUInt::get(Type::UIntTy, i));
406 assert(In && "Couldn't get element of initializer?");
407
408 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(), false,
409 GlobalVariable::InternalLinkage,
410 In, GV->getName()+"."+utostr(i));
411 Globals.insert(GV, NGV);
412 NewGlobals.push_back(NGV);
413 }
414 }
415
416 if (NewGlobals.empty())
417 return 0;
418
Chris Lattner004e2502004-10-11 05:54:41 +0000419 DEBUG(std::cerr << "PERFORMING GLOBAL SRA ON: " << *GV);
420
Chris Lattnerabab0712004-10-08 17:32:09 +0000421 Constant *NullInt = Constant::getNullValue(Type::IntTy);
422
423 // Loop over all of the uses of the global, replacing the constantexpr geps,
424 // with smaller constantexpr geps or direct references.
425 while (!GV->use_empty()) {
Chris Lattner004e2502004-10-11 05:54:41 +0000426 User *GEP = GV->use_back();
427 assert(((isa<ConstantExpr>(GEP) &&
428 cast<ConstantExpr>(GEP)->getOpcode()==Instruction::GetElementPtr)||
429 isa<GetElementPtrInst>(GEP)) && "NonGEP CE's are not SRAable!");
Misha Brukmanb1c93172005-04-21 23:48:37 +0000430
Chris Lattnerabab0712004-10-08 17:32:09 +0000431 // Ignore the 1th operand, which has to be zero or else the program is quite
432 // broken (undefined). Get the 2nd operand, which is the structure or array
433 // index.
Chris Lattner46fa04b2005-01-08 19:45:31 +0000434 unsigned Val =
435 (unsigned)cast<ConstantInt>(GEP->getOperand(2))->getRawValue();
Chris Lattnerabab0712004-10-08 17:32:09 +0000436 if (Val >= NewGlobals.size()) Val = 0; // Out of bound array access.
437
Chris Lattner004e2502004-10-11 05:54:41 +0000438 Value *NewPtr = NewGlobals[Val];
Chris Lattnerabab0712004-10-08 17:32:09 +0000439
440 // Form a shorter GEP if needed.
Chris Lattner004e2502004-10-11 05:54:41 +0000441 if (GEP->getNumOperands() > 3)
442 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEP)) {
443 std::vector<Constant*> Idxs;
444 Idxs.push_back(NullInt);
445 for (unsigned i = 3, e = CE->getNumOperands(); i != e; ++i)
446 Idxs.push_back(CE->getOperand(i));
447 NewPtr = ConstantExpr::getGetElementPtr(cast<Constant>(NewPtr), Idxs);
448 } else {
449 GetElementPtrInst *GEPI = cast<GetElementPtrInst>(GEP);
450 std::vector<Value*> Idxs;
451 Idxs.push_back(NullInt);
452 for (unsigned i = 3, e = GEPI->getNumOperands(); i != e; ++i)
453 Idxs.push_back(GEPI->getOperand(i));
454 NewPtr = new GetElementPtrInst(NewPtr, Idxs,
455 GEPI->getName()+"."+utostr(Val), GEPI);
456 }
457 GEP->replaceAllUsesWith(NewPtr);
458
459 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(GEP))
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000460 GEPI->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000461 else
462 cast<ConstantExpr>(GEP)->destroyConstant();
Chris Lattnerabab0712004-10-08 17:32:09 +0000463 }
464
Chris Lattner73ad73e2004-10-08 20:25:55 +0000465 // Delete the old global, now that it is dead.
466 Globals.erase(GV);
Chris Lattnerabab0712004-10-08 17:32:09 +0000467 ++NumSRA;
Chris Lattner004e2502004-10-11 05:54:41 +0000468
469 // Loop over the new globals array deleting any globals that are obviously
470 // dead. This can arise due to scalarization of a structure or an array that
471 // has elements that are dead.
472 unsigned FirstGlobal = 0;
473 for (unsigned i = 0, e = NewGlobals.size(); i != e; ++i)
474 if (NewGlobals[i]->use_empty()) {
475 Globals.erase(NewGlobals[i]);
476 if (FirstGlobal == i) ++FirstGlobal;
477 }
478
479 return FirstGlobal != NewGlobals.size() ? NewGlobals[FirstGlobal] : 0;
Chris Lattnerabab0712004-10-08 17:32:09 +0000480}
481
Chris Lattner09a52722004-10-09 21:48:45 +0000482/// AllUsesOfValueWillTrapIfNull - Return true if all users of the specified
483/// value will trap if the value is dynamically null.
484static bool AllUsesOfValueWillTrapIfNull(Value *V) {
485 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
486 if (isa<LoadInst>(*UI)) {
487 // Will trap.
488 } else if (StoreInst *SI = dyn_cast<StoreInst>(*UI)) {
489 if (SI->getOperand(0) == V) {
490 //std::cerr << "NONTRAPPING USE: " << **UI;
491 return false; // Storing the value.
492 }
493 } else if (CallInst *CI = dyn_cast<CallInst>(*UI)) {
494 if (CI->getOperand(0) != V) {
495 //std::cerr << "NONTRAPPING USE: " << **UI;
496 return false; // Not calling the ptr
497 }
498 } else if (InvokeInst *II = dyn_cast<InvokeInst>(*UI)) {
499 if (II->getOperand(0) != V) {
500 //std::cerr << "NONTRAPPING USE: " << **UI;
501 return false; // Not calling the ptr
502 }
503 } else if (CastInst *CI = dyn_cast<CastInst>(*UI)) {
504 if (!AllUsesOfValueWillTrapIfNull(CI)) return false;
505 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(*UI)) {
506 if (!AllUsesOfValueWillTrapIfNull(GEPI)) return false;
Misha Brukmanb1c93172005-04-21 23:48:37 +0000507 } else if (isa<SetCondInst>(*UI) &&
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000508 isa<ConstantPointerNull>(UI->getOperand(1))) {
509 // Ignore setcc X, null
Chris Lattner09a52722004-10-09 21:48:45 +0000510 } else {
511 //std::cerr << "NONTRAPPING USE: " << **UI;
512 return false;
513 }
514 return true;
515}
516
517/// AllUsesOfLoadedValueWillTrapIfNull - Return true if all uses of any loads
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000518/// from GV will trap if the loaded value is null. Note that this also permits
519/// comparisons of the loaded value against null, as a special case.
Chris Lattner09a52722004-10-09 21:48:45 +0000520static bool AllUsesOfLoadedValueWillTrapIfNull(GlobalVariable *GV) {
521 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI!=E; ++UI)
522 if (LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
523 if (!AllUsesOfValueWillTrapIfNull(LI))
524 return false;
525 } else if (isa<StoreInst>(*UI)) {
526 // Ignore stores to the global.
527 } else {
528 // We don't know or understand this user, bail out.
529 //std::cerr << "UNKNOWN USER OF GLOBAL!: " << **UI;
530 return false;
531 }
532
533 return true;
534}
535
Chris Lattnere42eb312004-10-10 23:14:11 +0000536static bool OptimizeAwayTrappingUsesOfValue(Value *V, Constant *NewV) {
537 bool Changed = false;
538 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ) {
539 Instruction *I = cast<Instruction>(*UI++);
540 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
541 LI->setOperand(0, NewV);
542 Changed = true;
543 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
544 if (SI->getOperand(1) == V) {
545 SI->setOperand(1, NewV);
546 Changed = true;
547 }
548 } else if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
549 if (I->getOperand(0) == V) {
550 // Calling through the pointer! Turn into a direct call, but be careful
551 // that the pointer is not also being passed as an argument.
552 I->setOperand(0, NewV);
553 Changed = true;
554 bool PassedAsArg = false;
555 for (unsigned i = 1, e = I->getNumOperands(); i != e; ++i)
556 if (I->getOperand(i) == V) {
557 PassedAsArg = true;
558 I->setOperand(i, NewV);
559 }
560
561 if (PassedAsArg) {
562 // Being passed as an argument also. Be careful to not invalidate UI!
563 UI = V->use_begin();
564 }
565 }
566 } else if (CastInst *CI = dyn_cast<CastInst>(I)) {
567 Changed |= OptimizeAwayTrappingUsesOfValue(CI,
568 ConstantExpr::getCast(NewV, CI->getType()));
569 if (CI->use_empty()) {
570 Changed = true;
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000571 CI->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000572 }
573 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
574 // Should handle GEP here.
575 std::vector<Constant*> Indices;
576 Indices.reserve(GEPI->getNumOperands()-1);
577 for (unsigned i = 1, e = GEPI->getNumOperands(); i != e; ++i)
578 if (Constant *C = dyn_cast<Constant>(GEPI->getOperand(i)))
579 Indices.push_back(C);
580 else
581 break;
582 if (Indices.size() == GEPI->getNumOperands()-1)
583 Changed |= OptimizeAwayTrappingUsesOfValue(GEPI,
584 ConstantExpr::getGetElementPtr(NewV, Indices));
585 if (GEPI->use_empty()) {
586 Changed = true;
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000587 GEPI->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000588 }
589 }
590 }
591
592 return Changed;
593}
594
595
596/// OptimizeAwayTrappingUsesOfLoads - The specified global has only one non-null
597/// value stored into it. If there are uses of the loaded value that would trap
598/// if the loaded value is dynamically null, then we know that they cannot be
599/// reachable with a null optimize away the load.
600static bool OptimizeAwayTrappingUsesOfLoads(GlobalVariable *GV, Constant *LV) {
601 std::vector<LoadInst*> Loads;
602 bool Changed = false;
603
604 // Replace all uses of loads with uses of uses of the stored value.
605 for (Value::use_iterator GUI = GV->use_begin(), E = GV->use_end();
606 GUI != E; ++GUI)
607 if (LoadInst *LI = dyn_cast<LoadInst>(*GUI)) {
608 Loads.push_back(LI);
609 Changed |= OptimizeAwayTrappingUsesOfValue(LI, LV);
610 } else {
611 assert(isa<StoreInst>(*GUI) && "Only expect load and stores!");
612 }
613
614 if (Changed) {
615 DEBUG(std::cerr << "OPTIMIZED LOADS FROM STORED ONCE POINTER: " << *GV);
616 ++NumGlobUses;
617 }
618
619 // Delete all of the loads we can, keeping track of whether we nuked them all!
620 bool AllLoadsGone = true;
621 while (!Loads.empty()) {
622 LoadInst *L = Loads.back();
623 if (L->use_empty()) {
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000624 L->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000625 Changed = true;
626 } else {
627 AllLoadsGone = false;
628 }
629 Loads.pop_back();
630 }
631
632 // If we nuked all of the loads, then none of the stores are needed either,
633 // nor is the global.
634 if (AllLoadsGone) {
635 DEBUG(std::cerr << " *** GLOBAL NOW DEAD!\n");
636 CleanupConstantGlobalUsers(GV, 0);
637 if (GV->use_empty()) {
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000638 GV->eraseFromParent();
Chris Lattnere42eb312004-10-10 23:14:11 +0000639 ++NumDeleted;
640 }
641 Changed = true;
642 }
643 return Changed;
644}
645
Chris Lattner004e2502004-10-11 05:54:41 +0000646/// ConstantPropUsersOf - Walk the use list of V, constant folding all of the
647/// instructions that are foldable.
648static void ConstantPropUsersOf(Value *V) {
649 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; )
650 if (Instruction *I = dyn_cast<Instruction>(*UI++))
651 if (Constant *NewC = ConstantFoldInstruction(I)) {
652 I->replaceAllUsesWith(NewC);
653
Chris Lattnerd6a44922005-02-01 01:23:31 +0000654 // Advance UI to the next non-I use to avoid invalidating it!
655 // Instructions could multiply use V.
656 while (UI != E && *UI == I)
Chris Lattner004e2502004-10-11 05:54:41 +0000657 ++UI;
Chris Lattnerd6a44922005-02-01 01:23:31 +0000658 I->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000659 }
660}
661
662/// OptimizeGlobalAddressOfMalloc - This function takes the specified global
663/// variable, and transforms the program as if it always contained the result of
664/// the specified malloc. Because it is always the result of the specified
665/// malloc, there is no reason to actually DO the malloc. Instead, turn the
666/// malloc into a global, and any laods of GV as uses of the new global.
667static GlobalVariable *OptimizeGlobalAddressOfMalloc(GlobalVariable *GV,
668 MallocInst *MI) {
669 DEBUG(std::cerr << "PROMOTING MALLOC GLOBAL: " << *GV << " MALLOC = " <<*MI);
670 ConstantInt *NElements = cast<ConstantInt>(MI->getArraySize());
671
672 if (NElements->getRawValue() != 1) {
673 // If we have an array allocation, transform it to a single element
674 // allocation to make the code below simpler.
675 Type *NewTy = ArrayType::get(MI->getAllocatedType(),
Chris Lattner46fa04b2005-01-08 19:45:31 +0000676 (unsigned)NElements->getRawValue());
Chris Lattner004e2502004-10-11 05:54:41 +0000677 MallocInst *NewMI =
678 new MallocInst(NewTy, Constant::getNullValue(Type::UIntTy),
679 MI->getName(), MI);
680 std::vector<Value*> Indices;
681 Indices.push_back(Constant::getNullValue(Type::IntTy));
682 Indices.push_back(Indices[0]);
683 Value *NewGEP = new GetElementPtrInst(NewMI, Indices,
684 NewMI->getName()+".el0", MI);
685 MI->replaceAllUsesWith(NewGEP);
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000686 MI->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000687 MI = NewMI;
688 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000689
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000690 // Create the new global variable. The contents of the malloc'd memory is
691 // undefined, so initialize with an undef value.
692 Constant *Init = UndefValue::get(MI->getAllocatedType());
Chris Lattner004e2502004-10-11 05:54:41 +0000693 GlobalVariable *NewGV = new GlobalVariable(MI->getAllocatedType(), false,
694 GlobalValue::InternalLinkage, Init,
695 GV->getName()+".body");
696 GV->getParent()->getGlobalList().insert(GV, NewGV);
Misha Brukmanb1c93172005-04-21 23:48:37 +0000697
Chris Lattner004e2502004-10-11 05:54:41 +0000698 // Anything that used the malloc now uses the global directly.
699 MI->replaceAllUsesWith(NewGV);
Chris Lattner004e2502004-10-11 05:54:41 +0000700
701 Constant *RepValue = NewGV;
702 if (NewGV->getType() != GV->getType()->getElementType())
703 RepValue = ConstantExpr::getCast(RepValue, GV->getType()->getElementType());
704
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000705 // If there is a comparison against null, we will insert a global bool to
706 // keep track of whether the global was initialized yet or not.
Misha Brukmanb1c93172005-04-21 23:48:37 +0000707 GlobalVariable *InitBool =
708 new GlobalVariable(Type::BoolTy, false, GlobalValue::InternalLinkage,
Chris Lattner3b181392004-12-02 06:25:58 +0000709 ConstantBool::False, GV->getName()+".init");
710 bool InitBoolUsed = false;
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000711
Chris Lattner004e2502004-10-11 05:54:41 +0000712 // Loop over all uses of GV, processing them in turn.
Chris Lattner3b181392004-12-02 06:25:58 +0000713 std::vector<StoreInst*> Stores;
Chris Lattner004e2502004-10-11 05:54:41 +0000714 while (!GV->use_empty())
715 if (LoadInst *LI = dyn_cast<LoadInst>(GV->use_back())) {
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000716 while (!LI->use_empty()) {
Chris Lattnerd6a44922005-02-01 01:23:31 +0000717 Use &LoadUse = LI->use_begin().getUse();
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000718 if (!isa<SetCondInst>(LoadUse.getUser()))
719 LoadUse = RepValue;
720 else {
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000721 // Replace the setcc X, 0 with a use of the bool value.
722 SetCondInst *SCI = cast<SetCondInst>(LoadUse.getUser());
723 Value *LV = new LoadInst(InitBool, InitBool->getName()+".val", SCI);
Chris Lattner3b181392004-12-02 06:25:58 +0000724 InitBoolUsed = true;
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000725 switch (SCI->getOpcode()) {
726 default: assert(0 && "Unknown opcode!");
727 case Instruction::SetLT:
728 LV = ConstantBool::False; // X < null -> always false
729 break;
730 case Instruction::SetEQ:
731 case Instruction::SetLE:
732 LV = BinaryOperator::createNot(LV, "notinit", SCI);
733 break;
734 case Instruction::SetNE:
735 case Instruction::SetGE:
736 case Instruction::SetGT:
737 break; // no change.
738 }
739 SCI->replaceAllUsesWith(LV);
740 SCI->eraseFromParent();
741 }
742 }
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000743 LI->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000744 } else {
745 StoreInst *SI = cast<StoreInst>(GV->use_back());
Chris Lattner3b181392004-12-02 06:25:58 +0000746 // The global is initialized when the store to it occurs.
747 new StoreInst(ConstantBool::True, InitBool, SI);
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000748 SI->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000749 }
750
Chris Lattner3b181392004-12-02 06:25:58 +0000751 // If the initialization boolean was used, insert it, otherwise delete it.
752 if (!InitBoolUsed) {
753 while (!InitBool->use_empty()) // Delete initializations
754 cast<Instruction>(InitBool->use_back())->eraseFromParent();
755 delete InitBool;
756 } else
757 GV->getParent()->getGlobalList().insert(GV, InitBool);
758
759
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000760 // Now the GV is dead, nuke it and the malloc.
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000761 GV->eraseFromParent();
Chris Lattnerfe9abf92004-10-22 06:43:28 +0000762 MI->eraseFromParent();
Chris Lattner004e2502004-10-11 05:54:41 +0000763
764 // To further other optimizations, loop over all users of NewGV and try to
765 // constant prop them. This will promote GEP instructions with constant
766 // indices into GEP constant-exprs, which will allow global-opt to hack on it.
767 ConstantPropUsersOf(NewGV);
768 if (RepValue != NewGV)
769 ConstantPropUsersOf(RepValue);
770
771 return NewGV;
772}
Chris Lattnere42eb312004-10-10 23:14:11 +0000773
Chris Lattnerc0677c02004-12-02 07:11:07 +0000774/// ValueIsOnlyUsedLocallyOrStoredToOneGlobal - Scan the use-list of V checking
775/// to make sure that there are no complex uses of V. We permit simple things
776/// like dereferencing the pointer, but not storing through the address, unless
777/// it is to the specified global.
778static bool ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Instruction *V,
779 GlobalVariable *GV) {
780 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI)
781 if (isa<LoadInst>(*UI) || isa<SetCondInst>(*UI)) {
782 // Fine, ignore.
783 } else if (StoreInst *SI = dyn_cast<StoreInst>(*UI)) {
784 if (SI->getOperand(0) == V && SI->getOperand(1) != GV)
785 return false; // Storing the pointer itself... bad.
786 // Otherwise, storing through it, or storing into GV... fine.
787 } else if (isa<GetElementPtrInst>(*UI) || isa<SelectInst>(*UI)) {
788 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(cast<Instruction>(*UI),GV))
789 return false;
790 } else {
791 return false;
792 }
793 return true;
794
795}
796
Chris Lattner09a52722004-10-09 21:48:45 +0000797// OptimizeOnceStoredGlobal - Try to optimize globals based on the knowledge
798// that only one value (besides its initializer) is ever stored to the global.
Chris Lattner004e2502004-10-11 05:54:41 +0000799static bool OptimizeOnceStoredGlobal(GlobalVariable *GV, Value *StoredOnceVal,
Chris Lattner531f9e92005-03-15 04:54:21 +0000800 Module::global_iterator &GVI, TargetData &TD) {
Chris Lattner09a52722004-10-09 21:48:45 +0000801 if (CastInst *CI = dyn_cast<CastInst>(StoredOnceVal))
802 StoredOnceVal = CI->getOperand(0);
803 else if (GetElementPtrInst *GEPI =dyn_cast<GetElementPtrInst>(StoredOnceVal)){
Chris Lattnere42eb312004-10-10 23:14:11 +0000804 // "getelementptr Ptr, 0, 0, 0" is really just a cast.
Chris Lattner09a52722004-10-09 21:48:45 +0000805 bool IsJustACast = true;
806 for (unsigned i = 1, e = GEPI->getNumOperands(); i != e; ++i)
807 if (!isa<Constant>(GEPI->getOperand(i)) ||
808 !cast<Constant>(GEPI->getOperand(i))->isNullValue()) {
809 IsJustACast = false;
810 break;
811 }
812 if (IsJustACast)
813 StoredOnceVal = GEPI->getOperand(0);
814 }
815
Chris Lattnere42eb312004-10-10 23:14:11 +0000816 // If we are dealing with a pointer global that is initialized to null and
817 // only has one (non-null) value stored into it, then we can optimize any
818 // users of the loaded value (often calls and loads) that would trap if the
819 // value was null.
Chris Lattner09a52722004-10-09 21:48:45 +0000820 if (isa<PointerType>(GV->getInitializer()->getType()) &&
821 GV->getInitializer()->isNullValue()) {
Chris Lattnere42eb312004-10-10 23:14:11 +0000822 if (Constant *SOVC = dyn_cast<Constant>(StoredOnceVal)) {
823 if (GV->getInitializer()->getType() != SOVC->getType())
824 SOVC = ConstantExpr::getCast(SOVC, GV->getInitializer()->getType());
Misha Brukmanb1c93172005-04-21 23:48:37 +0000825
Chris Lattnere42eb312004-10-10 23:14:11 +0000826 // Optimize away any trapping uses of the loaded value.
827 if (OptimizeAwayTrappingUsesOfLoads(GV, SOVC))
Chris Lattner604ed7a2004-10-10 17:07:12 +0000828 return true;
Chris Lattner004e2502004-10-11 05:54:41 +0000829 } else if (MallocInst *MI = dyn_cast<MallocInst>(StoredOnceVal)) {
830 // If we have a global that is only initialized with a fixed size malloc,
831 // and if all users of the malloc trap, and if the malloc'd address is not
832 // put anywhere else, transform the program to use global memory instead
833 // of malloc'd memory. This eliminates dynamic allocation (good) and
834 // exposes the resultant global to further GlobalOpt (even better). Note
835 // that we restrict this transformation to only working on small
836 // allocations (2048 bytes currently), as we don't want to introduce a 16M
837 // global or something.
838 if (ConstantInt *NElements = dyn_cast<ConstantInt>(MI->getArraySize()))
839 if (MI->getAllocatedType()->isSized() &&
840 NElements->getRawValue()*
841 TD.getTypeSize(MI->getAllocatedType()) < 2048 &&
Chris Lattnerc0677c02004-12-02 07:11:07 +0000842 AllUsesOfLoadedValueWillTrapIfNull(GV) &&
843 ValueIsOnlyUsedLocallyOrStoredToOneGlobal(MI, GV)) {
Chris Lattner004e2502004-10-11 05:54:41 +0000844 GVI = OptimizeGlobalAddressOfMalloc(GV, MI);
845 return true;
846 }
Chris Lattnere42eb312004-10-10 23:14:11 +0000847 }
Chris Lattner09a52722004-10-09 21:48:45 +0000848 }
Chris Lattner004e2502004-10-11 05:54:41 +0000849
Chris Lattner09a52722004-10-09 21:48:45 +0000850 return false;
851}
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000852
Chris Lattner40e4cec2004-12-12 05:53:50 +0000853/// ShrinkGlobalToBoolean - At this point, we have learned that the only two
Misha Brukmanb1c93172005-04-21 23:48:37 +0000854/// values ever stored into GV are its initializer and OtherVal.
Chris Lattner40e4cec2004-12-12 05:53:50 +0000855static void ShrinkGlobalToBoolean(GlobalVariable *GV, Constant *OtherVal) {
856 // Create the new global, initializing it to false.
857 GlobalVariable *NewGV = new GlobalVariable(Type::BoolTy, false,
858 GlobalValue::InternalLinkage, ConstantBool::False, GV->getName()+".b");
859 GV->getParent()->getGlobalList().insert(GV, NewGV);
860
861 Constant *InitVal = GV->getInitializer();
862 assert(InitVal->getType() != Type::BoolTy && "No reason to shrink to bool!");
863
864 // If initialized to zero and storing one into the global, we can use a cast
865 // instead of a select to synthesize the desired value.
866 bool IsOneZero = false;
867 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal))
868 IsOneZero = InitVal->isNullValue() && CI->equalsInt(1);
869
870 while (!GV->use_empty()) {
871 Instruction *UI = cast<Instruction>(GV->use_back());
872 if (StoreInst *SI = dyn_cast<StoreInst>(UI)) {
873 // Change the store into a boolean store.
874 bool StoringOther = SI->getOperand(0) == OtherVal;
875 // Only do this if we weren't storing a loaded value.
Chris Lattner745196a2004-12-12 19:34:41 +0000876 Value *StoreVal;
Chris Lattner40e4cec2004-12-12 05:53:50 +0000877 if (StoringOther || SI->getOperand(0) == InitVal)
Chris Lattner745196a2004-12-12 19:34:41 +0000878 StoreVal = ConstantBool::get(StoringOther);
879 else {
880 // Otherwise, we are storing a previously loaded copy. To do this,
881 // change the copy from copying the original value to just copying the
882 // bool.
883 Instruction *StoredVal = cast<Instruction>(SI->getOperand(0));
884
885 // If we're already replaced the input, StoredVal will be a cast or
886 // select instruction. If not, it will be a load of the original
887 // global.
888 if (LoadInst *LI = dyn_cast<LoadInst>(StoredVal)) {
889 assert(LI->getOperand(0) == GV && "Not a copy!");
890 // Insert a new load, to preserve the saved value.
891 StoreVal = new LoadInst(NewGV, LI->getName()+".b", LI);
892 } else {
893 assert((isa<CastInst>(StoredVal) || isa<SelectInst>(StoredVal)) &&
894 "This is not a form that we understand!");
895 StoreVal = StoredVal->getOperand(0);
896 assert(isa<LoadInst>(StoreVal) && "Not a load of NewGV!");
897 }
898 }
899 new StoreInst(StoreVal, NewGV, SI);
900 } else if (!UI->use_empty()) {
Chris Lattner40e4cec2004-12-12 05:53:50 +0000901 // Change the load into a load of bool then a select.
902 LoadInst *LI = cast<LoadInst>(UI);
Misha Brukmanb1c93172005-04-21 23:48:37 +0000903
Chris Lattner40e4cec2004-12-12 05:53:50 +0000904 std::string Name = LI->getName(); LI->setName("");
905 LoadInst *NLI = new LoadInst(NewGV, Name+".b", LI);
906 Value *NSI;
907 if (IsOneZero)
908 NSI = new CastInst(NLI, LI->getType(), Name, LI);
Misha Brukmanb1c93172005-04-21 23:48:37 +0000909 else
Chris Lattner40e4cec2004-12-12 05:53:50 +0000910 NSI = new SelectInst(NLI, OtherVal, InitVal, Name, LI);
911 LI->replaceAllUsesWith(NSI);
912 }
913 UI->eraseFromParent();
914 }
915
916 GV->eraseFromParent();
917}
918
919
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000920/// ProcessInternalGlobal - Analyze the specified global variable and optimize
921/// it if possible. If we make a change, return true.
Chris Lattner004e2502004-10-11 05:54:41 +0000922bool GlobalOpt::ProcessInternalGlobal(GlobalVariable *GV,
Chris Lattner531f9e92005-03-15 04:54:21 +0000923 Module::global_iterator &GVI) {
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000924 std::set<PHINode*> PHIUsers;
925 GlobalStatus GS;
926 PHIUsers.clear();
927 GV->removeDeadConstantUsers();
928
929 if (GV->use_empty()) {
930 DEBUG(std::cerr << "GLOBAL DEAD: " << *GV);
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000931 GV->eraseFromParent();
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000932 ++NumDeleted;
933 return true;
934 }
935
936 if (!AnalyzeGlobal(GV, GS, PHIUsers)) {
Alkis Evlogimenosc4a44c62005-02-10 18:36:30 +0000937 // If this is a first class global and has only one accessing function
938 // and this function is main (which we know is not recursive we can make
939 // this global a local variable) we replace the global with a local alloca
940 // in this function.
941 //
942 // NOTE: It doesn't make sense to promote non first class types since we
943 // are just replacing static memory to stack memory.
944 if (!GS.HasMultipleAccessingFunctions &&
Chris Lattner50bdfcb2005-06-15 21:11:48 +0000945 GS.AccessingFunction && !GS.HasNonInstructionUser &&
Alkis Evlogimenosc4a44c62005-02-10 18:36:30 +0000946 GV->getType()->getElementType()->isFirstClassType() &&
947 GS.AccessingFunction->getName() == "main" &&
948 GS.AccessingFunction->hasExternalLinkage()) {
949 DEBUG(std::cerr << "LOCALIZING GLOBAL: " << *GV);
950 Instruction* FirstI = GS.AccessingFunction->getEntryBlock().begin();
951 const Type* ElemTy = GV->getType()->getElementType();
952 AllocaInst* Alloca = new AllocaInst(ElemTy, NULL, GV->getName(), FirstI);
953 if (!isa<UndefValue>(GV->getInitializer()))
954 new StoreInst(GV->getInitializer(), Alloca, FirstI);
Misha Brukmanb1c93172005-04-21 23:48:37 +0000955
Alkis Evlogimenosc4a44c62005-02-10 18:36:30 +0000956 GV->replaceAllUsesWith(Alloca);
957 GV->eraseFromParent();
958 ++NumLocalized;
959 return true;
960 }
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000961 // If the global is never loaded (but may be stored to), it is dead.
962 // Delete it now.
963 if (!GS.isLoaded) {
964 DEBUG(std::cerr << "GLOBAL NEVER LOADED: " << *GV);
Chris Lattnerf369b382004-10-09 03:32:52 +0000965
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000966 // Delete any stores we can find to the global. We may not be able to
967 // make it completely dead though.
Chris Lattnercb9f1522004-10-10 16:43:46 +0000968 bool Changed = CleanupConstantGlobalUsers(GV, GV->getInitializer());
Chris Lattnerf369b382004-10-09 03:32:52 +0000969
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000970 // If the global is dead now, delete it.
971 if (GV->use_empty()) {
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000972 GV->eraseFromParent();
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000973 ++NumDeleted;
Chris Lattnerf369b382004-10-09 03:32:52 +0000974 Changed = true;
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000975 }
Chris Lattnerf369b382004-10-09 03:32:52 +0000976 return Changed;
Misha Brukmanb1c93172005-04-21 23:48:37 +0000977
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000978 } else if (GS.StoredType <= GlobalStatus::isInitializerStored) {
979 DEBUG(std::cerr << "MARKING CONSTANT: " << *GV);
980 GV->setConstant(true);
Misha Brukmanb1c93172005-04-21 23:48:37 +0000981
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000982 // Clean up any obviously simplifiable users now.
983 CleanupConstantGlobalUsers(GV, GV->getInitializer());
Misha Brukmanb1c93172005-04-21 23:48:37 +0000984
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000985 // If the global is dead now, just nuke it.
986 if (GV->use_empty()) {
987 DEBUG(std::cerr << " *** Marking constant allowed us to simplify "
988 "all users and delete global!\n");
Chris Lattner8e71c6a2004-10-16 18:09:00 +0000989 GV->eraseFromParent();
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000990 ++NumDeleted;
991 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000992
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000993 ++NumMarked;
994 return true;
995 } else if (!GS.isNotSuitableForSRA &&
996 !GV->getInitializer()->getType()->isFirstClassType()) {
Chris Lattner1c4bddc2004-10-08 20:59:28 +0000997 if (GlobalVariable *FirstNewGV = SRAGlobal(GV)) {
998 GVI = FirstNewGV; // Don't skip the newly produced globals!
999 return true;
1000 }
Chris Lattner09a52722004-10-09 21:48:45 +00001001 } else if (GS.StoredType == GlobalStatus::isStoredOnce) {
Chris Lattner40e4cec2004-12-12 05:53:50 +00001002 // If the initial value for the global was an undef value, and if only
1003 // one other value was stored into it, we can just change the
1004 // initializer to be an undef value, then delete all stores to the
1005 // global. This allows us to mark it constant.
1006 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1007 if (isa<UndefValue>(GV->getInitializer())) {
1008 // Change the initial value here.
1009 GV->setInitializer(SOVConstant);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001010
Chris Lattner40e4cec2004-12-12 05:53:50 +00001011 // Clean up any obviously simplifiable users now.
1012 CleanupConstantGlobalUsers(GV, GV->getInitializer());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001013
Chris Lattner40e4cec2004-12-12 05:53:50 +00001014 if (GV->use_empty()) {
1015 DEBUG(std::cerr << " *** Substituting initializer allowed us to "
1016 "simplify all users and delete global!\n");
1017 GV->eraseFromParent();
1018 ++NumDeleted;
1019 } else {
1020 GVI = GV;
1021 }
1022 ++NumSubstitute;
1023 return true;
Chris Lattner8e71c6a2004-10-16 18:09:00 +00001024 }
Chris Lattner8e71c6a2004-10-16 18:09:00 +00001025
Chris Lattner09a52722004-10-09 21:48:45 +00001026 // Try to optimize globals based on the knowledge that only one value
1027 // (besides its initializer) is ever stored to the global.
Chris Lattner004e2502004-10-11 05:54:41 +00001028 if (OptimizeOnceStoredGlobal(GV, GS.StoredOnceValue, GVI,
1029 getAnalysis<TargetData>()))
Chris Lattner09a52722004-10-09 21:48:45 +00001030 return true;
Chris Lattner40e4cec2004-12-12 05:53:50 +00001031
1032 // Otherwise, if the global was not a boolean, we can shrink it to be a
1033 // boolean.
1034 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
Chris Lattner1cbd5be2004-12-12 06:03:06 +00001035 if (GV->getType()->getElementType() != Type::BoolTy &&
1036 !GV->getType()->getElementType()->isFloatingPoint()) {
Chris Lattner40e4cec2004-12-12 05:53:50 +00001037 DEBUG(std::cerr << " *** SHRINKING TO BOOL: " << *GV);
1038 ShrinkGlobalToBoolean(GV, SOVConstant);
1039 ++NumShrunkToBool;
1040 return true;
1041 }
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001042 }
1043 }
1044 return false;
1045}
1046
Chris Lattnera4c80222005-05-08 22:18:06 +00001047/// OnlyCalledDirectly - Return true if the specified function is only called
1048/// directly. In other words, its address is never taken.
1049static bool OnlyCalledDirectly(Function *F) {
1050 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
1051 Instruction *User = dyn_cast<Instruction>(*UI);
1052 if (!User) return false;
1053 if (!isa<CallInst>(User) && !isa<InvokeInst>(User)) return false;
1054
1055 // See if the function address is passed as an argument.
1056 for (unsigned i = 1, e = User->getNumOperands(); i != e; ++i)
1057 if (User->getOperand(i) == F) return false;
1058 }
1059 return true;
1060}
1061
1062/// ChangeCalleesToFastCall - Walk all of the direct calls of the specified
1063/// function, changing them to FastCC.
1064static void ChangeCalleesToFastCall(Function *F) {
1065 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
1066 Instruction *User = cast<Instruction>(*UI);
1067 if (CallInst *CI = dyn_cast<CallInst>(User))
1068 CI->setCallingConv(CallingConv::Fast);
1069 else
1070 cast<InvokeInst>(User)->setCallingConv(CallingConv::Fast);
1071 }
1072}
Chris Lattner1c4bddc2004-10-08 20:59:28 +00001073
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001074bool GlobalOpt::OptimizeFunctions(Module &M) {
1075 bool Changed = false;
1076 // Optimize functions.
1077 for (Module::iterator FI = M.begin(), E = M.end(); FI != E; ) {
1078 Function *F = FI++;
1079 F->removeDeadConstantUsers();
1080 if (F->use_empty() && (F->hasInternalLinkage() ||
1081 F->hasLinkOnceLinkage())) {
1082 M.getFunctionList().erase(F);
1083 Changed = true;
1084 ++NumFnDeleted;
1085 } else if (F->hasInternalLinkage() &&
1086 F->getCallingConv() == CallingConv::C && !F->isVarArg() &&
1087 OnlyCalledDirectly(F)) {
1088 // If this function has C calling conventions, is not a varargs
1089 // function, and is only called directly, promote it to use the Fast
1090 // calling convention.
1091 F->setCallingConv(CallingConv::Fast);
1092 ChangeCalleesToFastCall(F);
1093 ++NumFastCallFns;
1094 Changed = true;
1095 }
1096 }
1097 return Changed;
1098}
1099
1100bool GlobalOpt::OptimizeGlobalVars(Module &M) {
1101 bool Changed = false;
1102 for (Module::global_iterator GVI = M.global_begin(), E = M.global_end();
1103 GVI != E; ) {
1104 GlobalVariable *GV = GVI++;
1105 if (!GV->isConstant() && GV->hasInternalLinkage() &&
1106 GV->hasInitializer())
1107 Changed |= ProcessInternalGlobal(GV, GVI);
1108 }
1109 return Changed;
1110}
1111
1112/// FindGlobalCtors - Find the llvm.globalctors list, verifying that all
1113/// initializers have an init priority of 65535.
1114GlobalVariable *GlobalOpt::FindGlobalCtors(Module &M) {
1115 for (Module::giterator I = M.global_begin(), E = M.global_end(); I != E; ++I)
1116 if (I->getName() == "llvm.global_ctors") {
1117 // Found it, verify it's an array of { int, void()* }.
1118 const ArrayType *ATy =dyn_cast<ArrayType>(I->getType()->getElementType());
1119 if (!ATy) return 0;
1120 const StructType *STy = dyn_cast<StructType>(ATy->getElementType());
1121 if (!STy || STy->getNumElements() != 2 ||
1122 STy->getElementType(0) != Type::IntTy) return 0;
1123 const PointerType *PFTy = dyn_cast<PointerType>(STy->getElementType(1));
1124 if (!PFTy) return 0;
1125 const FunctionType *FTy = dyn_cast<FunctionType>(PFTy->getElementType());
1126 if (!FTy || FTy->getReturnType() != Type::VoidTy || FTy->isVarArg() ||
1127 FTy->getNumParams() != 0)
1128 return 0;
1129
1130 // Verify that the initializer is simple enough for us to handle.
1131 if (!I->hasInitializer()) return 0;
1132 ConstantArray *CA = dyn_cast<ConstantArray>(I->getInitializer());
1133 if (!CA) return 0;
1134 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1135 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(CA->getOperand(i))) {
Chris Lattner838bdc12005-09-26 02:19:27 +00001136 if (isa<ConstantPointerNull>(CS->getOperand(1)))
1137 continue;
1138
1139 // Must have a function or null ptr.
1140 if (!isa<Function>(CS->getOperand(1)))
1141 return 0;
1142
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001143 // Init priority must be standard.
1144 ConstantInt *CI = dyn_cast<ConstantInt>(CS->getOperand(0));
1145 if (!CI || CI->getRawValue() != 65535)
1146 return 0;
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001147 } else {
1148 return 0;
1149 }
1150
1151 return I;
1152 }
1153 return 0;
1154}
1155
Chris Lattner696beef2005-09-26 02:31:18 +00001156/// ParseGlobalCtors - Given a llvm.global_ctors list that we can understand,
1157/// return a list of the functions and null terminator as a vector.
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001158static std::vector<Function*> ParseGlobalCtors(GlobalVariable *GV) {
1159 ConstantArray *CA = cast<ConstantArray>(GV->getInitializer());
1160 std::vector<Function*> Result;
1161 Result.reserve(CA->getNumOperands());
1162 for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i) {
1163 ConstantStruct *CS = cast<ConstantStruct>(CA->getOperand(i));
1164 Result.push_back(dyn_cast<Function>(CS->getOperand(1)));
1165 }
1166 return Result;
1167}
1168
Chris Lattner696beef2005-09-26 02:31:18 +00001169/// InstallGlobalCtors - Given a specified llvm.global_ctors list, install the
1170/// specified array, returning the new global to use.
1171static GlobalVariable *InstallGlobalCtors(GlobalVariable *GCL,
1172 const std::vector<Function*> &Ctors) {
1173 // If we made a change, reassemble the initializer list.
1174 std::vector<Constant*> CSVals;
1175 CSVals.push_back(ConstantSInt::get(Type::IntTy, 65535));
1176 CSVals.push_back(0);
1177
1178 // Create the new init list.
1179 std::vector<Constant*> CAList;
1180 for (unsigned i = 0, e = Ctors.size(); i != e; ++i) {
Chris Lattner99e23fa2005-09-26 04:44:35 +00001181 if (Ctors[i]) {
Chris Lattner696beef2005-09-26 02:31:18 +00001182 CSVals[1] = Ctors[i];
Chris Lattner99e23fa2005-09-26 04:44:35 +00001183 } else {
Chris Lattner696beef2005-09-26 02:31:18 +00001184 const Type *FTy = FunctionType::get(Type::VoidTy,
1185 std::vector<const Type*>(), false);
1186 const PointerType *PFTy = PointerType::get(FTy);
1187 CSVals[1] = Constant::getNullValue(PFTy);
1188 CSVals[0] = ConstantSInt::get(Type::IntTy, 2147483647);
1189 }
1190 CAList.push_back(ConstantStruct::get(CSVals));
1191 }
1192
1193 // Create the array initializer.
1194 const Type *StructTy =
1195 cast<ArrayType>(GCL->getType()->getElementType())->getElementType();
1196 Constant *CA = ConstantArray::get(ArrayType::get(StructTy, CAList.size()),
1197 CAList);
1198
1199 // If we didn't change the number of elements, don't create a new GV.
1200 if (CA->getType() == GCL->getInitializer()->getType()) {
1201 GCL->setInitializer(CA);
1202 return GCL;
1203 }
1204
1205 // Create the new global and insert it next to the existing list.
1206 GlobalVariable *NGV = new GlobalVariable(CA->getType(), GCL->isConstant(),
1207 GCL->getLinkage(), CA,
1208 GCL->getName());
1209 GCL->setName("");
1210 GCL->getParent()->getGlobalList().insert(GCL, NGV);
1211
1212 // Nuke the old list, replacing any uses with the new one.
1213 if (!GCL->use_empty()) {
1214 Constant *V = NGV;
1215 if (V->getType() != GCL->getType())
1216 V = ConstantExpr::getCast(V, GCL->getType());
1217 GCL->replaceAllUsesWith(V);
1218 }
1219 GCL->eraseFromParent();
1220
1221 if (Ctors.size())
1222 return NGV;
1223 else
1224 return 0;
1225}
Chris Lattner99e23fa2005-09-26 04:44:35 +00001226
1227
1228static Constant *getVal(std::map<Value*, Constant*> &ComputedValues,
1229 Value *V) {
1230 if (Constant *CV = dyn_cast<Constant>(V)) return CV;
1231 Constant *R = ComputedValues[V];
1232 assert(R && "Reference to an uncomputed value!");
1233 return R;
1234}
1235
1236/// isSimpleEnoughPointerToCommit - Return true if this constant is simple
1237/// enough for us to understand. In particular, if it is a cast of something,
1238/// we punt. We basically just support direct accesses to globals and GEP's of
1239/// globals. This should be kept up to date with CommitValueTo.
1240static bool isSimpleEnoughPointerToCommit(Constant *C) {
1241 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C))
1242 return !GV->isExternal(); // reject external globals.
1243 return false;
1244}
1245
1246/// CommitValueTo - We have decided that Addr (which satisfies the predicate
1247/// isSimpleEnoughPointerToCommit) should get Val as its value. Make it happen.
1248static void CommitValueTo(Constant *Val, Constant *Addr) {
1249 GlobalVariable *GV = cast<GlobalVariable>(Addr);
1250 assert(GV->hasInitializer());
1251 GV->setInitializer(Val);
1252}
1253
Chris Lattnerb0096632005-09-26 05:16:34 +00001254/// ComputeLoadResult - Return the value that would be computed by a load from
1255/// P after the stores reflected by 'memory' have been performed. If we can't
1256/// decide, return null.
Chris Lattner4b05c322005-09-26 05:15:37 +00001257static Constant *ComputeLoadResult(Constant *P,
1258 const std::map<Constant*, Constant*> &Memory) {
1259 // If this memory location has been recently stored, use the stored value: it
1260 // is the most up-to-date.
1261 std::map<Constant*, Constant*>::const_iterator I = Memory.find(P);
1262 if (I != Memory.end()) return I->second;
1263
1264 // Access it.
1265 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(P)) {
1266 if (GV->hasInitializer())
1267 return GV->getInitializer();
1268 return 0;
1269 } else {
1270 return 0; // don't know how to evaluate.
1271 }
1272}
1273
Chris Lattner99e23fa2005-09-26 04:44:35 +00001274/// EvaluateStaticConstructor - Evaluate static constructors in the function, if
1275/// we can. Return true if we can, false otherwise.
1276static bool EvaluateStaticConstructor(Function *F) {
1277 /// Values - As we compute SSA register values, we store their contents here.
1278 std::map<Value*, Constant*> Values;
1279
1280 /// MutatedMemory - For each store we execute, we update this map. Loads
1281 /// check this to get the most up-to-date value. If evaluation is successful,
1282 /// this state is committed to the process.
1283 std::map<Constant*, Constant*> MutatedMemory;
1284
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00001285 /// ExecutedBlocks - We only handle non-looping, non-recursive code. As such,
1286 /// we can only evaluate any one basic block at most once. This set keeps
1287 /// track of what we have executed so we can detect recursive cases etc.
1288 std::set<BasicBlock*> ExecutedBlocks;
1289
Chris Lattner99e23fa2005-09-26 04:44:35 +00001290 // CurInst - The current instruction we're evaluating.
1291 BasicBlock::iterator CurInst = F->begin()->begin();
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00001292 ExecutedBlocks.insert(F->begin());
Chris Lattner99e23fa2005-09-26 04:44:35 +00001293
1294 // This is the main evaluation loop.
1295 while (1) {
1296 Constant *InstResult = 0;
1297
1298 if (StoreInst *SI = dyn_cast<StoreInst>(CurInst)) {
Chris Lattner4b05c322005-09-26 05:15:37 +00001299 if (SI->isVolatile()) return false; // no volatile accesses.
Chris Lattner99e23fa2005-09-26 04:44:35 +00001300 Constant *Ptr = getVal(Values, SI->getOperand(1));
1301 if (!isSimpleEnoughPointerToCommit(Ptr))
1302 // If this is too complex for us to commit, reject it.
1303 return false;
1304 Constant *Val = getVal(Values, SI->getOperand(0));
1305 MutatedMemory[Ptr] = Val;
1306 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(CurInst)) {
1307 InstResult = ConstantExpr::get(BO->getOpcode(),
1308 getVal(Values, BO->getOperand(0)),
1309 getVal(Values, BO->getOperand(1)));
1310 } else if (ShiftInst *SI = dyn_cast<ShiftInst>(CurInst)) {
1311 InstResult = ConstantExpr::get(SI->getOpcode(),
1312 getVal(Values, SI->getOperand(0)),
1313 getVal(Values, SI->getOperand(1)));
1314 } else if (CastInst *CI = dyn_cast<CastInst>(CurInst)) {
1315 InstResult = ConstantExpr::getCast(getVal(Values, CI->getOperand(0)),
1316 CI->getType());
1317 } else if (SelectInst *SI = dyn_cast<SelectInst>(CurInst)) {
1318 InstResult = ConstantExpr::getSelect(getVal(Values, SI->getOperand(0)),
1319 getVal(Values, SI->getOperand(1)),
1320 getVal(Values, SI->getOperand(2)));
Chris Lattner4b05c322005-09-26 05:15:37 +00001321 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(CurInst)) {
1322 Constant *P = getVal(Values, GEP->getOperand(0));
1323 std::vector<Constant*> GEPOps;
1324 for (unsigned i = 1, e = GEP->getNumOperands(); i != e; ++i)
1325 GEPOps.push_back(getVal(Values, GEP->getOperand(i)));
1326 InstResult = ConstantExpr::getGetElementPtr(P, GEPOps);
1327 } else if (LoadInst *LI = dyn_cast<LoadInst>(CurInst)) {
1328 if (LI->isVolatile()) return false; // no volatile accesses.
1329 InstResult = ComputeLoadResult(getVal(Values, LI->getOperand(0)),
1330 MutatedMemory);
1331 if (InstResult == 0) return false; // Could not evaluate load.
Chris Lattner3e9ea5f2005-09-26 04:57:38 +00001332 } else if (TerminatorInst *TI = dyn_cast<TerminatorInst>(CurInst)) {
1333 BasicBlock *NewBB = 0;
1334 if (BranchInst *BI = dyn_cast<BranchInst>(CurInst)) {
1335 if (BI->isUnconditional()) {
1336 NewBB = BI->getSuccessor(0);
1337 } else {
1338 ConstantBool *Cond =
1339 dyn_cast<ConstantBool>(getVal(Values, BI->getCondition()));
1340 if (!Cond) return false; // Cannot determine.
1341 NewBB = BI->getSuccessor(!Cond->getValue());
1342 }
1343 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(CurInst)) {
1344 ConstantInt *Val =
1345 dyn_cast<ConstantInt>(getVal(Values, SI->getCondition()));
1346 if (!Val) return false; // Cannot determine.
1347 NewBB = SI->getSuccessor(SI->findCaseValue(Val));
1348 } else if (ReturnInst *RI = dyn_cast<ReturnInst>(CurInst)) {
1349 assert(RI->getNumOperands() == 0);
1350 break; // We succeeded at evaluating this ctor!
1351 } else {
1352 // unwind, unreachable.
1353 return false; // Cannot handle this terminator.
1354 }
1355
1356 // Okay, we succeeded in evaluating this control flow. See if we have
1357 // executed the new block before. If so, we have a looping or recursive
1358 // function, which we cannot evaluate in reasonable time.
1359 if (!ExecutedBlocks.insert(NewBB).second)
1360 return false; // Recursed!
1361
1362 // Okay, we have never been in this block before. Check to see if there
1363 // are any PHI nodes. If so, evaluate them with information about where
1364 // we came from.
1365 BasicBlock *OldBB = CurInst->getParent();
1366 CurInst = NewBB->begin();
1367 PHINode *PN;
1368 for (; (PN = dyn_cast<PHINode>(CurInst)); ++CurInst)
1369 Values[PN] = getVal(Values, PN->getIncomingValueForBlock(OldBB));
1370
1371 // Do NOT increment CurInst. We know that the terminator had no value.
1372 continue;
Chris Lattner99e23fa2005-09-26 04:44:35 +00001373 } else {
1374 // TODO: use ConstantFoldCall for function calls.
1375
1376 // Did not know how to evaluate this!
1377 return false;
1378 }
1379
1380 if (!CurInst->use_empty())
1381 Values[CurInst] = InstResult;
1382
1383 // Advance program counter.
1384 ++CurInst;
1385 }
1386
1387 // If we get here, we know that we succeeded at evaluation: commit the result.
1388 //
1389 for (std::map<Constant*, Constant*>::iterator I = MutatedMemory.begin(),
1390 E = MutatedMemory.end(); I != E; ++I)
1391 CommitValueTo(I->second, I->first);
1392 return true;
1393}
1394
Chris Lattner696beef2005-09-26 02:31:18 +00001395
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001396/// OptimizeGlobalCtorsList - Simplify and evaluation global ctors if possible.
1397/// Return true if anything changed.
1398bool GlobalOpt::OptimizeGlobalCtorsList(GlobalVariable *&GCL) {
1399 std::vector<Function*> Ctors = ParseGlobalCtors(GCL);
1400 bool MadeChange = false;
1401 if (Ctors.empty()) return false;
1402
1403 // Loop over global ctors, optimizing them when we can.
1404 for (unsigned i = 0; i != Ctors.size(); ++i) {
1405 Function *F = Ctors[i];
1406 // Found a null terminator in the middle of the list, prune off the rest of
1407 // the list.
Chris Lattner838bdc12005-09-26 02:19:27 +00001408 if (F == 0) {
1409 if (i != Ctors.size()-1) {
1410 Ctors.resize(i+1);
1411 MadeChange = true;
1412 }
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001413 break;
1414 }
1415
Chris Lattner99e23fa2005-09-26 04:44:35 +00001416 // We cannot simplify external ctor functions.
1417 if (F->empty()) continue;
1418
1419 // If we can evaluate the ctor at compile time, do.
1420 if (EvaluateStaticConstructor(F)) {
1421 Ctors.erase(Ctors.begin()+i);
1422 MadeChange = true;
1423 --i;
1424 ++NumCtorsEvaluated;
1425 continue;
1426 }
1427
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001428 // If the function is empty, just remove it from the ctor list.
Chris Lattner99e23fa2005-09-26 04:44:35 +00001429 if (isa<ReturnInst>(F->begin()->getTerminator()) &&
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001430 &F->begin()->front() == F->begin()->getTerminator()) {
1431 Ctors.erase(Ctors.begin()+i);
1432 MadeChange = true;
1433 --i;
1434 ++NumEmptyCtor;
Chris Lattner99e23fa2005-09-26 04:44:35 +00001435 continue;
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001436 }
1437 }
1438
1439 if (!MadeChange) return false;
1440
Chris Lattner696beef2005-09-26 02:31:18 +00001441 GCL = InstallGlobalCtors(GCL, Ctors);
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001442 return true;
1443}
1444
1445
Chris Lattner25db5802004-10-07 04:16:33 +00001446bool GlobalOpt::runOnModule(Module &M) {
1447 bool Changed = false;
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001448
1449 // Try to find the llvm.globalctors list.
1450 GlobalVariable *GlobalCtors = FindGlobalCtors(M);
Chris Lattner25db5802004-10-07 04:16:33 +00001451
Chris Lattner25db5802004-10-07 04:16:33 +00001452 bool LocalChange = true;
1453 while (LocalChange) {
1454 LocalChange = false;
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001455
1456 // Delete functions that are trivially dead, ccc -> fastcc
1457 LocalChange |= OptimizeFunctions(M);
1458
1459 // Optimize global_ctors list.
1460 if (GlobalCtors)
1461 LocalChange |= OptimizeGlobalCtorsList(GlobalCtors);
1462
1463 // Optimize non-address-taken globals.
1464 LocalChange |= OptimizeGlobalVars(M);
Chris Lattner25db5802004-10-07 04:16:33 +00001465 Changed |= LocalChange;
1466 }
Chris Lattner41b6a5a2005-09-26 01:43:45 +00001467
1468 // TODO: Move all global ctors functions to the end of the module for code
1469 // layout.
1470
Chris Lattner25db5802004-10-07 04:16:33 +00001471 return Changed;
1472}