blob: f39a0dc63794ff9855871113a4cb06a81271575a [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001//===- GlobalOpt.cpp - Optimize Global Variables --------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner081ce942007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00007//
8//===----------------------------------------------------------------------===//
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"
18#include "llvm/CallingConv.h"
19#include "llvm/Constants.h"
20#include "llvm/DerivedTypes.h"
21#include "llvm/Instructions.h"
22#include "llvm/IntrinsicInst.h"
23#include "llvm/Module.h"
24#include "llvm/Pass.h"
25#include "llvm/Analysis/ConstantFolding.h"
26#include "llvm/Target/TargetData.h"
Duncan Sands551ec902008-02-18 17:32:13 +000027#include "llvm/Support/CallSite.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000028#include "llvm/Support/Compiler.h"
29#include "llvm/Support/Debug.h"
Chris Lattner7bd79da2008-01-14 02:09:12 +000030#include "llvm/Support/GetElementPtrTypeIterator.h"
Chris Lattner20846272008-04-26 07:40:11 +000031#include "llvm/Support/MathExtras.h"
Chris Lattner4cd08c22008-12-16 07:34:30 +000032#include "llvm/ADT/DenseMap.h"
Chris Lattnerbdf77462007-09-13 16:30:19 +000033#include "llvm/ADT/SmallPtrSet.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000034#include "llvm/ADT/SmallVector.h"
35#include "llvm/ADT/Statistic.h"
36#include "llvm/ADT/StringExtras.h"
Chris Lattner8a2d32e2008-12-17 05:28:49 +000037#include "llvm/ADT/STLExtras.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000038#include <algorithm>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000039using namespace llvm;
40
41STATISTIC(NumMarked , "Number of globals marked constant");
42STATISTIC(NumSRA , "Number of aggregate globals broken into scalars");
43STATISTIC(NumHeapSRA , "Number of heap objects SRA'd");
44STATISTIC(NumSubstitute,"Number of globals with initializers stored into them");
45STATISTIC(NumDeleted , "Number of globals deleted");
46STATISTIC(NumFnDeleted , "Number of functions deleted");
47STATISTIC(NumGlobUses , "Number of global uses devirtualized");
48STATISTIC(NumLocalized , "Number of globals localized");
49STATISTIC(NumShrunkToBool , "Number of global vars shrunk to booleans");
50STATISTIC(NumFastCallFns , "Number of functions converted to fastcc");
51STATISTIC(NumCtorsEvaluated, "Number of static ctors evaluated");
Duncan Sandsafa10bf2008-02-16 20:56:04 +000052STATISTIC(NumNestRemoved , "Number of nest attributes removed");
Dan Gohmanf17a25c2007-07-18 16:29:46 +000053
54namespace {
55 struct VISIBILITY_HIDDEN GlobalOpt : public ModulePass {
56 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
57 AU.addRequired<TargetData>();
58 }
59 static char ID; // Pass identification, replacement for typeid
Dan Gohman26f8c272008-09-04 17:05:41 +000060 GlobalOpt() : ModulePass(&ID) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +000061
62 bool runOnModule(Module &M);
63
64 private:
65 GlobalVariable *FindGlobalCtors(Module &M);
66 bool OptimizeFunctions(Module &M);
67 bool OptimizeGlobalVars(Module &M);
Anton Korobeynikov76944bd2008-09-09 19:04:59 +000068 bool ResolveAliases(Module &M);
Dan Gohmanf17a25c2007-07-18 16:29:46 +000069 bool OptimizeGlobalCtorsList(GlobalVariable *&GCL);
70 bool ProcessInternalGlobal(GlobalVariable *GV,Module::global_iterator &GVI);
71 };
Dan Gohmanf17a25c2007-07-18 16:29:46 +000072}
73
Dan Gohman089efff2008-05-13 00:00:25 +000074char GlobalOpt::ID = 0;
75static RegisterPass<GlobalOpt> X("globalopt", "Global Variable Optimizer");
76
Dan Gohmanf17a25c2007-07-18 16:29:46 +000077ModulePass *llvm::createGlobalOptimizerPass() { return new GlobalOpt(); }
78
Dan Gohman089efff2008-05-13 00:00:25 +000079namespace {
80
Dan Gohmanf17a25c2007-07-18 16:29:46 +000081/// GlobalStatus - As we analyze each global, keep track of some information
82/// about it. If we find out that the address of the global is taken, none of
83/// this info will be accurate.
84struct VISIBILITY_HIDDEN GlobalStatus {
85 /// isLoaded - True if the global is ever loaded. If the global isn't ever
86 /// loaded it can be deleted.
87 bool isLoaded;
88
89 /// StoredType - Keep track of what stores to the global look like.
90 ///
91 enum StoredType {
92 /// NotStored - There is no store to this global. It can thus be marked
93 /// constant.
94 NotStored,
95
96 /// isInitializerStored - This global is stored to, but the only thing
97 /// stored is the constant it was initialized with. This is only tracked
98 /// for scalar globals.
99 isInitializerStored,
100
101 /// isStoredOnce - This global is stored to, but only its initializer and
102 /// one other value is ever stored to it. If this global isStoredOnce, we
103 /// track the value stored to it in StoredOnceValue below. This is only
104 /// tracked for scalar globals.
105 isStoredOnce,
106
107 /// isStored - This global is stored to by multiple values or something else
108 /// that we cannot track.
109 isStored
110 } StoredType;
111
112 /// StoredOnceValue - If only one value (besides the initializer constant) is
113 /// ever stored to this global, keep track of what value it is.
114 Value *StoredOnceValue;
115
116 /// AccessingFunction/HasMultipleAccessingFunctions - These start out
117 /// null/false. When the first accessing function is noticed, it is recorded.
118 /// When a second different accessing function is noticed,
119 /// HasMultipleAccessingFunctions is set to true.
120 Function *AccessingFunction;
121 bool HasMultipleAccessingFunctions;
122
123 /// HasNonInstructionUser - Set to true if this global has a user that is not
124 /// an instruction (e.g. a constant expr or GV initializer).
125 bool HasNonInstructionUser;
126
127 /// HasPHIUser - Set to true if this global has a user that is a PHI node.
128 bool HasPHIUser;
129
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000130 GlobalStatus() : isLoaded(false), StoredType(NotStored), StoredOnceValue(0),
131 AccessingFunction(0), HasMultipleAccessingFunctions(false),
Chris Lattnercad76212008-01-14 01:32:52 +0000132 HasNonInstructionUser(false), HasPHIUser(false) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000133};
134
Dan Gohman089efff2008-05-13 00:00:25 +0000135}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000136
137/// ConstantIsDead - Return true if the specified constant is (transitively)
138/// dead. The constant may be used by other constants (e.g. constant arrays and
139/// constant exprs) as long as they are dead, but it cannot be used by anything
140/// else.
141static bool ConstantIsDead(Constant *C) {
142 if (isa<GlobalValue>(C)) return false;
143
144 for (Value::use_iterator UI = C->use_begin(), E = C->use_end(); UI != E; ++UI)
145 if (Constant *CU = dyn_cast<Constant>(*UI)) {
146 if (!ConstantIsDead(CU)) return false;
147 } else
148 return false;
149 return true;
150}
151
152
153/// AnalyzeGlobal - Look at all uses of the global and fill in the GlobalStatus
154/// structure. If the global has its address taken, return true to indicate we
155/// can't do anything with it.
156///
157static bool AnalyzeGlobal(Value *V, GlobalStatus &GS,
Chris Lattner4cd08c22008-12-16 07:34:30 +0000158 SmallPtrSet<PHINode*, 16> &PHIUsers) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000159 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
160 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(*UI)) {
161 GS.HasNonInstructionUser = true;
162
163 if (AnalyzeGlobal(CE, GS, PHIUsers)) return true;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000164
165 } else if (Instruction *I = dyn_cast<Instruction>(*UI)) {
166 if (!GS.HasMultipleAccessingFunctions) {
167 Function *F = I->getParent()->getParent();
168 if (GS.AccessingFunction == 0)
169 GS.AccessingFunction = F;
170 else if (GS.AccessingFunction != F)
171 GS.HasMultipleAccessingFunctions = true;
172 }
Chris Lattner75a2db82008-01-29 19:01:37 +0000173 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000174 GS.isLoaded = true;
Chris Lattner75a2db82008-01-29 19:01:37 +0000175 if (LI->isVolatile()) return true; // Don't hack on volatile loads.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000176 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
177 // Don't allow a store OF the address, only stores TO the address.
178 if (SI->getOperand(0) == V) return true;
179
Chris Lattner75a2db82008-01-29 19:01:37 +0000180 if (SI->isVolatile()) return true; // Don't hack on volatile stores.
181
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000182 // If this is a direct store to the global (i.e., the global is a scalar
183 // value, not an aggregate), keep more specific information about
184 // stores.
Anton Korobeynikov8522e1c2008-02-20 11:26:25 +0000185 if (GS.StoredType != GlobalStatus::isStored) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000186 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(SI->getOperand(1))){
187 Value *StoredVal = SI->getOperand(0);
188 if (StoredVal == GV->getInitializer()) {
189 if (GS.StoredType < GlobalStatus::isInitializerStored)
190 GS.StoredType = GlobalStatus::isInitializerStored;
191 } else if (isa<LoadInst>(StoredVal) &&
192 cast<LoadInst>(StoredVal)->getOperand(0) == GV) {
193 // G = G
194 if (GS.StoredType < GlobalStatus::isInitializerStored)
195 GS.StoredType = GlobalStatus::isInitializerStored;
196 } else if (GS.StoredType < GlobalStatus::isStoredOnce) {
197 GS.StoredType = GlobalStatus::isStoredOnce;
198 GS.StoredOnceValue = StoredVal;
199 } else if (GS.StoredType == GlobalStatus::isStoredOnce &&
200 GS.StoredOnceValue == StoredVal) {
201 // noop.
202 } else {
203 GS.StoredType = GlobalStatus::isStored;
204 }
205 } else {
206 GS.StoredType = GlobalStatus::isStored;
207 }
Anton Korobeynikov8522e1c2008-02-20 11:26:25 +0000208 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000209 } else if (isa<GetElementPtrInst>(I)) {
210 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000211 } else if (isa<SelectInst>(I)) {
212 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000213 } else if (PHINode *PN = dyn_cast<PHINode>(I)) {
214 // PHI nodes we can check just like select or GEP instructions, but we
215 // have to be careful about infinite recursion.
Chris Lattner4cd08c22008-12-16 07:34:30 +0000216 if (PHIUsers.insert(PN)) // Not already visited.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000217 if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000218 GS.HasPHIUser = true;
219 } else if (isa<CmpInst>(I)) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000220 } else if (isa<MemCpyInst>(I) || isa<MemMoveInst>(I)) {
221 if (I->getOperand(1) == V)
222 GS.StoredType = GlobalStatus::isStored;
223 if (I->getOperand(2) == V)
224 GS.isLoaded = true;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000225 } else if (isa<MemSetInst>(I)) {
226 assert(I->getOperand(1) == V && "Memset only takes one pointer!");
227 GS.StoredType = GlobalStatus::isStored;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000228 } else {
229 return true; // Any other non-load instruction might take address!
230 }
231 } else if (Constant *C = dyn_cast<Constant>(*UI)) {
232 GS.HasNonInstructionUser = true;
233 // We might have a dead and dangling constant hanging off of here.
234 if (!ConstantIsDead(C))
235 return true;
236 } else {
237 GS.HasNonInstructionUser = true;
238 // Otherwise must be some other user.
239 return true;
240 }
241
242 return false;
243}
244
245static Constant *getAggregateConstantElement(Constant *Agg, Constant *Idx) {
246 ConstantInt *CI = dyn_cast<ConstantInt>(Idx);
247 if (!CI) return 0;
248 unsigned IdxV = CI->getZExtValue();
249
250 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Agg)) {
251 if (IdxV < CS->getNumOperands()) return CS->getOperand(IdxV);
252 } else if (ConstantArray *CA = dyn_cast<ConstantArray>(Agg)) {
253 if (IdxV < CA->getNumOperands()) return CA->getOperand(IdxV);
254 } else if (ConstantVector *CP = dyn_cast<ConstantVector>(Agg)) {
255 if (IdxV < CP->getNumOperands()) return CP->getOperand(IdxV);
256 } else if (isa<ConstantAggregateZero>(Agg)) {
257 if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
258 if (IdxV < STy->getNumElements())
259 return Constant::getNullValue(STy->getElementType(IdxV));
260 } else if (const SequentialType *STy =
261 dyn_cast<SequentialType>(Agg->getType())) {
262 return Constant::getNullValue(STy->getElementType());
263 }
264 } else if (isa<UndefValue>(Agg)) {
265 if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
266 if (IdxV < STy->getNumElements())
267 return UndefValue::get(STy->getElementType(IdxV));
268 } else if (const SequentialType *STy =
269 dyn_cast<SequentialType>(Agg->getType())) {
270 return UndefValue::get(STy->getElementType());
271 }
272 }
273 return 0;
274}
275
276
277/// CleanupConstantGlobalUsers - We just marked GV constant. Loop over all
278/// users of the global, cleaning up the obvious ones. This is largely just a
279/// quick scan over the use list to clean up the easy and obvious cruft. This
280/// returns true if it made a change.
281static bool CleanupConstantGlobalUsers(Value *V, Constant *Init) {
282 bool Changed = false;
283 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;) {
284 User *U = *UI++;
285
286 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
287 if (Init) {
288 // Replace the load with the initializer.
289 LI->replaceAllUsesWith(Init);
290 LI->eraseFromParent();
291 Changed = true;
292 }
293 } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
294 // Store must be unreachable or storing Init into the global.
295 SI->eraseFromParent();
296 Changed = true;
297 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
298 if (CE->getOpcode() == Instruction::GetElementPtr) {
299 Constant *SubInit = 0;
300 if (Init)
301 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
302 Changed |= CleanupConstantGlobalUsers(CE, SubInit);
303 } else if (CE->getOpcode() == Instruction::BitCast &&
304 isa<PointerType>(CE->getType())) {
305 // Pointer cast, delete any stores and memsets to the global.
306 Changed |= CleanupConstantGlobalUsers(CE, 0);
307 }
308
309 if (CE->use_empty()) {
310 CE->destroyConstant();
311 Changed = true;
312 }
313 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner7ebafca2007-11-09 17:33:02 +0000314 // Do not transform "gepinst (gep constexpr (GV))" here, because forming
315 // "gepconstexpr (gep constexpr (GV))" will cause the two gep's to fold
316 // and will invalidate our notion of what Init is.
Chris Lattner2dd9c042007-11-13 21:46:23 +0000317 Constant *SubInit = 0;
Chris Lattner7ebafca2007-11-09 17:33:02 +0000318 if (!isa<ConstantExpr>(GEP->getOperand(0))) {
319 ConstantExpr *CE =
320 dyn_cast_or_null<ConstantExpr>(ConstantFoldInstruction(GEP));
321 if (Init && CE && CE->getOpcode() == Instruction::GetElementPtr)
Chris Lattner2dd9c042007-11-13 21:46:23 +0000322 SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
Chris Lattner7ebafca2007-11-09 17:33:02 +0000323 }
Chris Lattner2dd9c042007-11-13 21:46:23 +0000324 Changed |= CleanupConstantGlobalUsers(GEP, SubInit);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000325
326 if (GEP->use_empty()) {
327 GEP->eraseFromParent();
328 Changed = true;
329 }
330 } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(U)) { // memset/cpy/mv
331 if (MI->getRawDest() == V) {
332 MI->eraseFromParent();
333 Changed = true;
334 }
335
336 } else if (Constant *C = dyn_cast<Constant>(U)) {
337 // If we have a chain of dead constantexprs or other things dangling from
338 // us, and if they are all dead, nuke them without remorse.
339 if (ConstantIsDead(C)) {
340 C->destroyConstant();
341 // This could have invalidated UI, start over from scratch.
342 CleanupConstantGlobalUsers(V, Init);
343 return true;
344 }
345 }
346 }
347 return Changed;
348}
349
Chris Lattner7bd79da2008-01-14 02:09:12 +0000350/// isSafeSROAElementUse - Return true if the specified instruction is a safe
351/// user of a derived expression from a global that we want to SROA.
352static bool isSafeSROAElementUse(Value *V) {
353 // We might have a dead and dangling constant hanging off of here.
354 if (Constant *C = dyn_cast<Constant>(V))
355 return ConstantIsDead(C);
Chris Lattner7329c662008-01-14 01:31:05 +0000356
Chris Lattner7bd79da2008-01-14 02:09:12 +0000357 Instruction *I = dyn_cast<Instruction>(V);
358 if (!I) return false;
359
360 // Loads are ok.
361 if (isa<LoadInst>(I)) return true;
362
363 // Stores *to* the pointer are ok.
364 if (StoreInst *SI = dyn_cast<StoreInst>(I))
365 return SI->getOperand(0) != V;
366
367 // Otherwise, it must be a GEP.
368 GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I);
369 if (GEPI == 0) return false;
370
371 if (GEPI->getNumOperands() < 3 || !isa<Constant>(GEPI->getOperand(1)) ||
372 !cast<Constant>(GEPI->getOperand(1))->isNullValue())
373 return false;
374
375 for (Value::use_iterator I = GEPI->use_begin(), E = GEPI->use_end();
376 I != E; ++I)
377 if (!isSafeSROAElementUse(*I))
378 return false;
Chris Lattner7329c662008-01-14 01:31:05 +0000379 return true;
380}
381
Chris Lattner7bd79da2008-01-14 02:09:12 +0000382
383/// IsUserOfGlobalSafeForSRA - U is a direct user of the specified global value.
384/// Look at it and its uses and decide whether it is safe to SROA this global.
385///
386static bool IsUserOfGlobalSafeForSRA(User *U, GlobalValue *GV) {
387 // The user of the global must be a GEP Inst or a ConstantExpr GEP.
388 if (!isa<GetElementPtrInst>(U) &&
389 (!isa<ConstantExpr>(U) ||
390 cast<ConstantExpr>(U)->getOpcode() != Instruction::GetElementPtr))
391 return false;
392
393 // Check to see if this ConstantExpr GEP is SRA'able. In particular, we
394 // don't like < 3 operand CE's, and we don't like non-constant integer
395 // indices. This enforces that all uses are 'gep GV, 0, C, ...' for some
396 // value of C.
397 if (U->getNumOperands() < 3 || !isa<Constant>(U->getOperand(1)) ||
398 !cast<Constant>(U->getOperand(1))->isNullValue() ||
399 !isa<ConstantInt>(U->getOperand(2)))
400 return false;
401
402 gep_type_iterator GEPI = gep_type_begin(U), E = gep_type_end(U);
403 ++GEPI; // Skip over the pointer index.
404
405 // If this is a use of an array allocation, do a bit more checking for sanity.
406 if (const ArrayType *AT = dyn_cast<ArrayType>(*GEPI)) {
407 uint64_t NumElements = AT->getNumElements();
408 ConstantInt *Idx = cast<ConstantInt>(U->getOperand(2));
409
410 // Check to make sure that index falls within the array. If not,
411 // something funny is going on, so we won't do the optimization.
412 //
413 if (Idx->getZExtValue() >= NumElements)
414 return false;
415
416 // We cannot scalar repl this level of the array unless any array
417 // sub-indices are in-range constants. In particular, consider:
418 // A[0][i]. We cannot know that the user isn't doing invalid things like
419 // allowing i to index an out-of-range subscript that accesses A[1].
420 //
421 // Scalar replacing *just* the outer index of the array is probably not
422 // going to be a win anyway, so just give up.
423 for (++GEPI; // Skip array index.
424 GEPI != E && (isa<ArrayType>(*GEPI) || isa<VectorType>(*GEPI));
425 ++GEPI) {
426 uint64_t NumElements;
427 if (const ArrayType *SubArrayTy = dyn_cast<ArrayType>(*GEPI))
428 NumElements = SubArrayTy->getNumElements();
429 else
430 NumElements = cast<VectorType>(*GEPI)->getNumElements();
431
432 ConstantInt *IdxVal = dyn_cast<ConstantInt>(GEPI.getOperand());
433 if (!IdxVal || IdxVal->getZExtValue() >= NumElements)
434 return false;
435 }
436 }
437
438 for (Value::use_iterator I = U->use_begin(), E = U->use_end(); I != E; ++I)
439 if (!isSafeSROAElementUse(*I))
440 return false;
441 return true;
442}
443
444/// GlobalUsersSafeToSRA - Look at all uses of the global and decide whether it
445/// is safe for us to perform this transformation.
446///
447static bool GlobalUsersSafeToSRA(GlobalValue *GV) {
448 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end();
449 UI != E; ++UI) {
450 if (!IsUserOfGlobalSafeForSRA(*UI, GV))
451 return false;
452 }
453 return true;
454}
455
456
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000457/// SRAGlobal - Perform scalar replacement of aggregates on the specified global
458/// variable. This opens the door for other optimizations by exposing the
459/// behavior of the program in a more fine-grained way. We have determined that
460/// this transformation is safe already. We return the first global variable we
461/// insert so that the caller can reprocess it.
Chris Lattner20846272008-04-26 07:40:11 +0000462static GlobalVariable *SRAGlobal(GlobalVariable *GV, const TargetData &TD) {
Chris Lattner7329c662008-01-14 01:31:05 +0000463 // Make sure this global only has simple uses that we can SRA.
Chris Lattner7bd79da2008-01-14 02:09:12 +0000464 if (!GlobalUsersSafeToSRA(GV))
Chris Lattner7329c662008-01-14 01:31:05 +0000465 return 0;
466
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000467 assert(GV->hasInternalLinkage() && !GV->isConstant());
468 Constant *Init = GV->getInitializer();
469 const Type *Ty = Init->getType();
470
471 std::vector<GlobalVariable*> NewGlobals;
472 Module::GlobalListType &Globals = GV->getParent()->getGlobalList();
473
Chris Lattner20846272008-04-26 07:40:11 +0000474 // Get the alignment of the global, either explicit or target-specific.
475 unsigned StartAlignment = GV->getAlignment();
476 if (StartAlignment == 0)
477 StartAlignment = TD.getABITypeAlignment(GV->getType());
478
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000479 if (const StructType *STy = dyn_cast<StructType>(Ty)) {
480 NewGlobals.reserve(STy->getNumElements());
Chris Lattner20846272008-04-26 07:40:11 +0000481 const StructLayout &Layout = *TD.getStructLayout(STy);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000482 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
483 Constant *In = getAggregateConstantElement(Init,
484 ConstantInt::get(Type::Int32Ty, i));
485 assert(In && "Couldn't get element of initializer?");
486 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(i), false,
487 GlobalVariable::InternalLinkage,
488 In, GV->getName()+"."+utostr(i),
489 (Module *)NULL,
Matthijs Kooijman36693bb2008-07-17 11:59:53 +0000490 GV->isThreadLocal(),
491 GV->getType()->getAddressSpace());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000492 Globals.insert(GV, NGV);
493 NewGlobals.push_back(NGV);
Chris Lattner20846272008-04-26 07:40:11 +0000494
495 // Calculate the known alignment of the field. If the original aggregate
496 // had 256 byte alignment for example, something might depend on that:
497 // propagate info to each field.
498 uint64_t FieldOffset = Layout.getElementOffset(i);
499 unsigned NewAlign = (unsigned)MinAlign(StartAlignment, FieldOffset);
500 if (NewAlign > TD.getABITypeAlignment(STy->getElementType(i)))
501 NGV->setAlignment(NewAlign);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000502 }
503 } else if (const SequentialType *STy = dyn_cast<SequentialType>(Ty)) {
504 unsigned NumElements = 0;
505 if (const ArrayType *ATy = dyn_cast<ArrayType>(STy))
506 NumElements = ATy->getNumElements();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000507 else
Chris Lattner20846272008-04-26 07:40:11 +0000508 NumElements = cast<VectorType>(STy)->getNumElements();
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000509
510 if (NumElements > 16 && GV->hasNUsesOrMore(16))
511 return 0; // It's not worth it.
512 NewGlobals.reserve(NumElements);
Chris Lattner20846272008-04-26 07:40:11 +0000513
514 uint64_t EltSize = TD.getABITypeSize(STy->getElementType());
515 unsigned EltAlign = TD.getABITypeAlignment(STy->getElementType());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000516 for (unsigned i = 0, e = NumElements; i != e; ++i) {
517 Constant *In = getAggregateConstantElement(Init,
518 ConstantInt::get(Type::Int32Ty, i));
519 assert(In && "Couldn't get element of initializer?");
520
521 GlobalVariable *NGV = new GlobalVariable(STy->getElementType(), false,
522 GlobalVariable::InternalLinkage,
523 In, GV->getName()+"."+utostr(i),
524 (Module *)NULL,
Matthijs Kooijman36693bb2008-07-17 11:59:53 +0000525 GV->isThreadLocal(),
526 GV->getType()->getAddressSpace());
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000527 Globals.insert(GV, NGV);
528 NewGlobals.push_back(NGV);
Chris Lattner20846272008-04-26 07:40:11 +0000529
530 // Calculate the known alignment of the field. If the original aggregate
531 // had 256 byte alignment for example, something might depend on that:
532 // propagate info to each field.
533 unsigned NewAlign = (unsigned)MinAlign(StartAlignment, EltSize*i);
534 if (NewAlign > EltAlign)
535 NGV->setAlignment(NewAlign);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000536 }
537 }
538
539 if (NewGlobals.empty())
540 return 0;
541
542 DOUT << "PERFORMING GLOBAL SRA ON: " << *GV;
543
544 Constant *NullInt = Constant::getNullValue(Type::Int32Ty);
545
546 // Loop over all of the uses of the global, replacing the constantexpr geps,
547 // with smaller constantexpr geps or direct references.
548 while (!GV->use_empty()) {
549 User *GEP = GV->use_back();
550 assert(((isa<ConstantExpr>(GEP) &&
551 cast<ConstantExpr>(GEP)->getOpcode()==Instruction::GetElementPtr)||
552 isa<GetElementPtrInst>(GEP)) && "NonGEP CE's are not SRAable!");
553
554 // Ignore the 1th operand, which has to be zero or else the program is quite
555 // broken (undefined). Get the 2nd operand, which is the structure or array
556 // index.
557 unsigned Val = cast<ConstantInt>(GEP->getOperand(2))->getZExtValue();
558 if (Val >= NewGlobals.size()) Val = 0; // Out of bound array access.
559
560 Value *NewPtr = NewGlobals[Val];
561
562 // Form a shorter GEP if needed.
Anton Korobeynikov8522e1c2008-02-20 11:26:25 +0000563 if (GEP->getNumOperands() > 3) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000564 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEP)) {
565 SmallVector<Constant*, 8> Idxs;
566 Idxs.push_back(NullInt);
567 for (unsigned i = 3, e = CE->getNumOperands(); i != e; ++i)
568 Idxs.push_back(CE->getOperand(i));
569 NewPtr = ConstantExpr::getGetElementPtr(cast<Constant>(NewPtr),
570 &Idxs[0], Idxs.size());
571 } else {
572 GetElementPtrInst *GEPI = cast<GetElementPtrInst>(GEP);
573 SmallVector<Value*, 8> Idxs;
574 Idxs.push_back(NullInt);
575 for (unsigned i = 3, e = GEPI->getNumOperands(); i != e; ++i)
576 Idxs.push_back(GEPI->getOperand(i));
Gabor Greifd6da1d02008-04-06 20:25:17 +0000577 NewPtr = GetElementPtrInst::Create(NewPtr, Idxs.begin(), Idxs.end(),
578 GEPI->getName()+"."+utostr(Val), GEPI);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000579 }
Anton Korobeynikov8522e1c2008-02-20 11:26:25 +0000580 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000581 GEP->replaceAllUsesWith(NewPtr);
582
583 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(GEP))
584 GEPI->eraseFromParent();
585 else
586 cast<ConstantExpr>(GEP)->destroyConstant();
587 }
588
589 // Delete the old global, now that it is dead.
590 Globals.erase(GV);
591 ++NumSRA;
592
593 // Loop over the new globals array deleting any globals that are obviously
594 // dead. This can arise due to scalarization of a structure or an array that
595 // has elements that are dead.
596 unsigned FirstGlobal = 0;
597 for (unsigned i = 0, e = NewGlobals.size(); i != e; ++i)
598 if (NewGlobals[i]->use_empty()) {
599 Globals.erase(NewGlobals[i]);
600 if (FirstGlobal == i) ++FirstGlobal;
601 }
602
603 return FirstGlobal != NewGlobals.size() ? NewGlobals[FirstGlobal] : 0;
604}
605
606/// AllUsesOfValueWillTrapIfNull - Return true if all users of the specified
Chris Lattnerbdf77462007-09-13 16:30:19 +0000607/// value will trap if the value is dynamically null. PHIs keeps track of any
608/// phi nodes we've seen to avoid reprocessing them.
609static bool AllUsesOfValueWillTrapIfNull(Value *V,
610 SmallPtrSet<PHINode*, 8> &PHIs) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000611 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
612 if (isa<LoadInst>(*UI)) {
613 // Will trap.
614 } else if (StoreInst *SI = dyn_cast<StoreInst>(*UI)) {
615 if (SI->getOperand(0) == V) {
616 //cerr << "NONTRAPPING USE: " << **UI;
617 return false; // Storing the value.
618 }
619 } else if (CallInst *CI = dyn_cast<CallInst>(*UI)) {
620 if (CI->getOperand(0) != V) {
621 //cerr << "NONTRAPPING USE: " << **UI;
622 return false; // Not calling the ptr
623 }
624 } else if (InvokeInst *II = dyn_cast<InvokeInst>(*UI)) {
625 if (II->getOperand(0) != V) {
626 //cerr << "NONTRAPPING USE: " << **UI;
627 return false; // Not calling the ptr
628 }
Chris Lattnerbdf77462007-09-13 16:30:19 +0000629 } else if (BitCastInst *CI = dyn_cast<BitCastInst>(*UI)) {
630 if (!AllUsesOfValueWillTrapIfNull(CI, PHIs)) return false;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000631 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(*UI)) {
Chris Lattnerbdf77462007-09-13 16:30:19 +0000632 if (!AllUsesOfValueWillTrapIfNull(GEPI, PHIs)) return false;
633 } else if (PHINode *PN = dyn_cast<PHINode>(*UI)) {
634 // If we've already seen this phi node, ignore it, it has already been
635 // checked.
636 if (PHIs.insert(PN))
637 return AllUsesOfValueWillTrapIfNull(PN, PHIs);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000638 } else if (isa<ICmpInst>(*UI) &&
639 isa<ConstantPointerNull>(UI->getOperand(1))) {
640 // Ignore setcc X, null
641 } else {
642 //cerr << "NONTRAPPING USE: " << **UI;
643 return false;
644 }
645 return true;
646}
647
648/// AllUsesOfLoadedValueWillTrapIfNull - Return true if all uses of any loads
649/// from GV will trap if the loaded value is null. Note that this also permits
650/// comparisons of the loaded value against null, as a special case.
651static bool AllUsesOfLoadedValueWillTrapIfNull(GlobalVariable *GV) {
652 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI!=E; ++UI)
653 if (LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
Chris Lattnerbdf77462007-09-13 16:30:19 +0000654 SmallPtrSet<PHINode*, 8> PHIs;
655 if (!AllUsesOfValueWillTrapIfNull(LI, PHIs))
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000656 return false;
657 } else if (isa<StoreInst>(*UI)) {
658 // Ignore stores to the global.
659 } else {
660 // We don't know or understand this user, bail out.
661 //cerr << "UNKNOWN USER OF GLOBAL!: " << **UI;
662 return false;
663 }
664
665 return true;
666}
667
668static bool OptimizeAwayTrappingUsesOfValue(Value *V, Constant *NewV) {
669 bool Changed = false;
670 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ) {
671 Instruction *I = cast<Instruction>(*UI++);
672 if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
673 LI->setOperand(0, NewV);
674 Changed = true;
675 } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
676 if (SI->getOperand(1) == V) {
677 SI->setOperand(1, NewV);
678 Changed = true;
679 }
680 } else if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
681 if (I->getOperand(0) == V) {
682 // Calling through the pointer! Turn into a direct call, but be careful
683 // that the pointer is not also being passed as an argument.
684 I->setOperand(0, NewV);
685 Changed = true;
686 bool PassedAsArg = false;
687 for (unsigned i = 1, e = I->getNumOperands(); i != e; ++i)
688 if (I->getOperand(i) == V) {
689 PassedAsArg = true;
690 I->setOperand(i, NewV);
691 }
692
693 if (PassedAsArg) {
694 // Being passed as an argument also. Be careful to not invalidate UI!
695 UI = V->use_begin();
696 }
697 }
698 } else if (CastInst *CI = dyn_cast<CastInst>(I)) {
699 Changed |= OptimizeAwayTrappingUsesOfValue(CI,
700 ConstantExpr::getCast(CI->getOpcode(),
701 NewV, CI->getType()));
702 if (CI->use_empty()) {
703 Changed = true;
704 CI->eraseFromParent();
705 }
706 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
707 // Should handle GEP here.
708 SmallVector<Constant*, 8> Idxs;
709 Idxs.reserve(GEPI->getNumOperands()-1);
Gabor Greif20f03f52008-05-29 01:59:18 +0000710 for (User::op_iterator i = GEPI->op_begin() + 1, e = GEPI->op_end();
711 i != e; ++i)
712 if (Constant *C = dyn_cast<Constant>(*i))
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000713 Idxs.push_back(C);
714 else
715 break;
716 if (Idxs.size() == GEPI->getNumOperands()-1)
717 Changed |= OptimizeAwayTrappingUsesOfValue(GEPI,
718 ConstantExpr::getGetElementPtr(NewV, &Idxs[0],
719 Idxs.size()));
720 if (GEPI->use_empty()) {
721 Changed = true;
722 GEPI->eraseFromParent();
723 }
724 }
725 }
726
727 return Changed;
728}
729
730
731/// OptimizeAwayTrappingUsesOfLoads - The specified global has only one non-null
732/// value stored into it. If there are uses of the loaded value that would trap
733/// if the loaded value is dynamically null, then we know that they cannot be
734/// reachable with a null optimize away the load.
735static bool OptimizeAwayTrappingUsesOfLoads(GlobalVariable *GV, Constant *LV) {
736 std::vector<LoadInst*> Loads;
737 bool Changed = false;
738
739 // Replace all uses of loads with uses of uses of the stored value.
740 for (Value::use_iterator GUI = GV->use_begin(), E = GV->use_end();
741 GUI != E; ++GUI)
742 if (LoadInst *LI = dyn_cast<LoadInst>(*GUI)) {
743 Loads.push_back(LI);
744 Changed |= OptimizeAwayTrappingUsesOfValue(LI, LV);
745 } else {
746 // If we get here we could have stores, selects, or phi nodes whose values
747 // are loaded.
748 assert((isa<StoreInst>(*GUI) || isa<PHINode>(*GUI) ||
Chris Lattnerad8665a2008-01-04 05:04:53 +0000749 isa<SelectInst>(*GUI) || isa<ConstantExpr>(*GUI)) &&
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000750 "Only expect load and stores!");
751 }
752
753 if (Changed) {
754 DOUT << "OPTIMIZED LOADS FROM STORED ONCE POINTER: " << *GV;
755 ++NumGlobUses;
756 }
757
758 // Delete all of the loads we can, keeping track of whether we nuked them all!
759 bool AllLoadsGone = true;
760 while (!Loads.empty()) {
761 LoadInst *L = Loads.back();
762 if (L->use_empty()) {
763 L->eraseFromParent();
764 Changed = true;
765 } else {
766 AllLoadsGone = false;
767 }
768 Loads.pop_back();
769 }
770
771 // If we nuked all of the loads, then none of the stores are needed either,
772 // nor is the global.
773 if (AllLoadsGone) {
774 DOUT << " *** GLOBAL NOW DEAD!\n";
775 CleanupConstantGlobalUsers(GV, 0);
776 if (GV->use_empty()) {
777 GV->eraseFromParent();
778 ++NumDeleted;
779 }
780 Changed = true;
781 }
782 return Changed;
783}
784
785/// ConstantPropUsersOf - Walk the use list of V, constant folding all of the
786/// instructions that are foldable.
787static void ConstantPropUsersOf(Value *V) {
788 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; )
789 if (Instruction *I = dyn_cast<Instruction>(*UI++))
790 if (Constant *NewC = ConstantFoldInstruction(I)) {
791 I->replaceAllUsesWith(NewC);
792
793 // Advance UI to the next non-I use to avoid invalidating it!
794 // Instructions could multiply use V.
795 while (UI != E && *UI == I)
796 ++UI;
797 I->eraseFromParent();
798 }
799}
800
801/// OptimizeGlobalAddressOfMalloc - This function takes the specified global
802/// variable, and transforms the program as if it always contained the result of
803/// the specified malloc. Because it is always the result of the specified
804/// malloc, there is no reason to actually DO the malloc. Instead, turn the
805/// malloc into a global, and any loads of GV as uses of the new global.
806static GlobalVariable *OptimizeGlobalAddressOfMalloc(GlobalVariable *GV,
807 MallocInst *MI) {
808 DOUT << "PROMOTING MALLOC GLOBAL: " << *GV << " MALLOC = " << *MI;
809 ConstantInt *NElements = cast<ConstantInt>(MI->getArraySize());
810
811 if (NElements->getZExtValue() != 1) {
812 // If we have an array allocation, transform it to a single element
813 // allocation to make the code below simpler.
814 Type *NewTy = ArrayType::get(MI->getAllocatedType(),
815 NElements->getZExtValue());
816 MallocInst *NewMI =
817 new MallocInst(NewTy, Constant::getNullValue(Type::Int32Ty),
818 MI->getAlignment(), MI->getName(), MI);
819 Value* Indices[2];
820 Indices[0] = Indices[1] = Constant::getNullValue(Type::Int32Ty);
Gabor Greifd6da1d02008-04-06 20:25:17 +0000821 Value *NewGEP = GetElementPtrInst::Create(NewMI, Indices, Indices + 2,
822 NewMI->getName()+".el0", MI);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000823 MI->replaceAllUsesWith(NewGEP);
824 MI->eraseFromParent();
825 MI = NewMI;
826 }
827
828 // Create the new global variable. The contents of the malloc'd memory is
829 // undefined, so initialize with an undef value.
830 Constant *Init = UndefValue::get(MI->getAllocatedType());
831 GlobalVariable *NewGV = new GlobalVariable(MI->getAllocatedType(), false,
832 GlobalValue::InternalLinkage, Init,
833 GV->getName()+".body",
834 (Module *)NULL,
835 GV->isThreadLocal());
Chris Lattner20846272008-04-26 07:40:11 +0000836 // FIXME: This new global should have the alignment returned by malloc. Code
837 // could depend on malloc returning large alignment (on the mac, 16 bytes) but
838 // this would only guarantee some lower alignment.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000839 GV->getParent()->getGlobalList().insert(GV, NewGV);
840
841 // Anything that used the malloc now uses the global directly.
842 MI->replaceAllUsesWith(NewGV);
843
844 Constant *RepValue = NewGV;
845 if (NewGV->getType() != GV->getType()->getElementType())
846 RepValue = ConstantExpr::getBitCast(RepValue,
847 GV->getType()->getElementType());
848
849 // If there is a comparison against null, we will insert a global bool to
850 // keep track of whether the global was initialized yet or not.
851 GlobalVariable *InitBool =
852 new GlobalVariable(Type::Int1Ty, false, GlobalValue::InternalLinkage,
853 ConstantInt::getFalse(), GV->getName()+".init",
854 (Module *)NULL, GV->isThreadLocal());
855 bool InitBoolUsed = false;
856
857 // Loop over all uses of GV, processing them in turn.
858 std::vector<StoreInst*> Stores;
859 while (!GV->use_empty())
860 if (LoadInst *LI = dyn_cast<LoadInst>(GV->use_back())) {
861 while (!LI->use_empty()) {
862 Use &LoadUse = LI->use_begin().getUse();
863 if (!isa<ICmpInst>(LoadUse.getUser()))
864 LoadUse = RepValue;
865 else {
866 ICmpInst *CI = cast<ICmpInst>(LoadUse.getUser());
867 // Replace the cmp X, 0 with a use of the bool value.
868 Value *LV = new LoadInst(InitBool, InitBool->getName()+".val", CI);
869 InitBoolUsed = true;
870 switch (CI->getPredicate()) {
871 default: assert(0 && "Unknown ICmp Predicate!");
872 case ICmpInst::ICMP_ULT:
873 case ICmpInst::ICMP_SLT:
874 LV = ConstantInt::getFalse(); // X < null -> always false
875 break;
876 case ICmpInst::ICMP_ULE:
877 case ICmpInst::ICMP_SLE:
878 case ICmpInst::ICMP_EQ:
Gabor Greifa645dd32008-05-16 19:29:10 +0000879 LV = BinaryOperator::CreateNot(LV, "notinit", CI);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000880 break;
881 case ICmpInst::ICMP_NE:
882 case ICmpInst::ICMP_UGE:
883 case ICmpInst::ICMP_SGE:
884 case ICmpInst::ICMP_UGT:
885 case ICmpInst::ICMP_SGT:
886 break; // no change.
887 }
888 CI->replaceAllUsesWith(LV);
889 CI->eraseFromParent();
890 }
891 }
892 LI->eraseFromParent();
893 } else {
894 StoreInst *SI = cast<StoreInst>(GV->use_back());
895 // The global is initialized when the store to it occurs.
896 new StoreInst(ConstantInt::getTrue(), InitBool, SI);
897 SI->eraseFromParent();
898 }
899
900 // If the initialization boolean was used, insert it, otherwise delete it.
901 if (!InitBoolUsed) {
902 while (!InitBool->use_empty()) // Delete initializations
903 cast<Instruction>(InitBool->use_back())->eraseFromParent();
904 delete InitBool;
905 } else
906 GV->getParent()->getGlobalList().insert(GV, InitBool);
907
908
909 // Now the GV is dead, nuke it and the malloc.
910 GV->eraseFromParent();
911 MI->eraseFromParent();
912
913 // To further other optimizations, loop over all users of NewGV and try to
914 // constant prop them. This will promote GEP instructions with constant
915 // indices into GEP constant-exprs, which will allow global-opt to hack on it.
916 ConstantPropUsersOf(NewGV);
917 if (RepValue != NewGV)
918 ConstantPropUsersOf(RepValue);
919
920 return NewGV;
921}
922
923/// ValueIsOnlyUsedLocallyOrStoredToOneGlobal - Scan the use-list of V checking
924/// to make sure that there are no complex uses of V. We permit simple things
925/// like dereferencing the pointer, but not storing through the address, unless
926/// it is to the specified global.
927static bool ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Instruction *V,
Chris Lattnere7606f42007-09-13 16:37:20 +0000928 GlobalVariable *GV,
929 SmallPtrSet<PHINode*, 8> &PHIs) {
Chris Lattner183b0cf2008-12-15 21:08:54 +0000930 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
931 Instruction *Inst = dyn_cast<Instruction>(*UI);
932 if (Inst == 0) return false;
933
934 if (isa<LoadInst>(Inst) || isa<CmpInst>(Inst)) {
935 continue; // Fine, ignore.
936 }
937
938 if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000939 if (SI->getOperand(0) == V && SI->getOperand(1) != GV)
940 return false; // Storing the pointer itself... bad.
Chris Lattner183b0cf2008-12-15 21:08:54 +0000941 continue; // Otherwise, storing through it, or storing into GV... fine.
942 }
943
944 if (isa<GetElementPtrInst>(Inst)) {
945 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Inst, GV, PHIs))
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000946 return false;
Chris Lattner183b0cf2008-12-15 21:08:54 +0000947 continue;
948 }
949
950 if (PHINode *PN = dyn_cast<PHINode>(Inst)) {
Chris Lattnere7606f42007-09-13 16:37:20 +0000951 // PHIs are ok if all uses are ok. Don't infinitely recurse through PHI
952 // cycles.
953 if (PHIs.insert(PN))
Chris Lattner4bde3c42007-09-14 03:41:21 +0000954 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(PN, GV, PHIs))
955 return false;
Chris Lattner183b0cf2008-12-15 21:08:54 +0000956 continue;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000957 }
Chris Lattner183b0cf2008-12-15 21:08:54 +0000958
959 if (BitCastInst *BCI = dyn_cast<BitCastInst>(Inst)) {
960 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(BCI, GV, PHIs))
961 return false;
962 continue;
963 }
964
965 return false;
966 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000967 return true;
968}
969
970/// ReplaceUsesOfMallocWithGlobal - The Alloc pointer is stored into GV
971/// somewhere. Transform all uses of the allocation into loads from the
972/// global and uses of the resultant pointer. Further, delete the store into
973/// GV. This assumes that these value pass the
974/// 'ValueIsOnlyUsedLocallyOrStoredToOneGlobal' predicate.
975static void ReplaceUsesOfMallocWithGlobal(Instruction *Alloc,
976 GlobalVariable *GV) {
977 while (!Alloc->use_empty()) {
Chris Lattner20eef0f2007-09-13 18:00:31 +0000978 Instruction *U = cast<Instruction>(*Alloc->use_begin());
979 Instruction *InsertPt = U;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000980 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
981 // If this is the store of the allocation into the global, remove it.
982 if (SI->getOperand(1) == GV) {
983 SI->eraseFromParent();
984 continue;
985 }
Chris Lattner20eef0f2007-09-13 18:00:31 +0000986 } else if (PHINode *PN = dyn_cast<PHINode>(U)) {
987 // Insert the load in the corresponding predecessor, not right before the
988 // PHI.
989 unsigned PredNo = Alloc->use_begin().getOperandNo()/2;
990 InsertPt = PN->getIncomingBlock(PredNo)->getTerminator();
Chris Lattner27ef89e2008-12-15 21:44:34 +0000991 } else if (isa<BitCastInst>(U)) {
992 // Must be bitcast between the malloc and store to initialize the global.
993 ReplaceUsesOfMallocWithGlobal(U, GV);
994 U->eraseFromParent();
995 continue;
996 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
997 // If this is a "GEP bitcast" and the user is a store to the global, then
998 // just process it as a bitcast.
999 if (GEPI->hasAllZeroIndices() && GEPI->hasOneUse())
1000 if (StoreInst *SI = dyn_cast<StoreInst>(GEPI->use_back()))
1001 if (SI->getOperand(1) == GV) {
1002 // Must be bitcast GEP between the malloc and store to initialize
1003 // the global.
1004 ReplaceUsesOfMallocWithGlobal(GEPI, GV);
1005 GEPI->eraseFromParent();
1006 continue;
1007 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001008 }
Chris Lattner27ef89e2008-12-15 21:44:34 +00001009
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001010 // Insert a load from the global, and use it instead of the malloc.
Chris Lattner20eef0f2007-09-13 18:00:31 +00001011 Value *NL = new LoadInst(GV, GV->getName()+".val", InsertPt);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001012 U->replaceUsesOfWith(Alloc, NL);
1013 }
1014}
1015
Chris Lattner7f252db2008-12-16 21:24:51 +00001016/// LoadUsesSimpleEnoughForHeapSRA - Verify that all uses of V (a load, or a phi
1017/// of a load) are simple enough to perform heap SRA on. This permits GEP's
1018/// that index through the array and struct field, icmps of null, and PHIs.
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001019static bool LoadUsesSimpleEnoughForHeapSRA(Value *V,
1020 SmallPtrSet<PHINode*, 32> &LoadUsingPHIs) {
Chris Lattner7f252db2008-12-16 21:24:51 +00001021 // We permit two users of the load: setcc comparing against the null
1022 // pointer, and a getelementptr of a specific form.
1023 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
1024 Instruction *User = cast<Instruction>(*UI);
1025
1026 // Comparison against null is ok.
1027 if (ICmpInst *ICI = dyn_cast<ICmpInst>(User)) {
1028 if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
1029 return false;
1030 continue;
1031 }
1032
1033 // getelementptr is also ok, but only a simple form.
1034 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
1035 // Must index into the array and into the struct.
1036 if (GEPI->getNumOperands() < 3)
1037 return false;
1038
1039 // Otherwise the GEP is ok.
1040 continue;
1041 }
1042
1043 if (PHINode *PN = dyn_cast<PHINode>(User)) {
1044 // If we have already recursively analyzed this PHI, then it is safe.
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001045 if (LoadUsingPHIs.insert(PN))
Chris Lattner7f252db2008-12-16 21:24:51 +00001046 continue;
1047
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001048 // Make sure all uses of the PHI are simple enough to transform.
1049 if (!LoadUsesSimpleEnoughForHeapSRA(PN, LoadUsingPHIs))
Chris Lattner7f252db2008-12-16 21:24:51 +00001050 return false;
1051
1052 continue;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001053 }
Chris Lattner7f252db2008-12-16 21:24:51 +00001054
1055 // Otherwise we don't know what this is, not ok.
1056 return false;
1057 }
1058
1059 return true;
1060}
1061
1062
1063/// AllGlobalLoadUsesSimpleEnoughForHeapSRA - If all users of values loaded from
1064/// GV are simple enough to perform HeapSRA, return true.
1065static bool AllGlobalLoadUsesSimpleEnoughForHeapSRA(GlobalVariable *GV,
1066 MallocInst *MI) {
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001067 SmallPtrSet<PHINode*, 32> LoadUsingPHIs;
Chris Lattner7f252db2008-12-16 21:24:51 +00001068 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI != E;
1069 ++UI)
1070 if (LoadInst *LI = dyn_cast<LoadInst>(*UI))
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001071 if (!LoadUsesSimpleEnoughForHeapSRA(LI, LoadUsingPHIs))
Chris Lattner7f252db2008-12-16 21:24:51 +00001072 return false;
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001073
1074 // If we reach here, we know that all uses of the loads and transitive uses
1075 // (through PHI nodes) are simple enough to transform. However, we don't know
1076 // that all inputs the to the PHI nodes are in the same equivalence sets.
1077 // Check to verify that all operands of the PHIs are either PHIS that can be
1078 // transformed, loads from GV, or MI itself.
1079 for (SmallPtrSet<PHINode*, 32>::iterator I = LoadUsingPHIs.begin(),
1080 E = LoadUsingPHIs.end(); I != E; ++I) {
1081 PHINode *PN = *I;
1082 for (unsigned op = 0, e = PN->getNumIncomingValues(); op != e; ++op) {
1083 Value *InVal = PN->getIncomingValue(op);
1084
1085 // PHI of the stored value itself is ok.
1086 if (InVal == MI) continue;
1087
1088 if (PHINode *InPN = dyn_cast<PHINode>(InVal)) {
1089 // One of the PHIs in our set is (optimistically) ok.
1090 if (LoadUsingPHIs.count(InPN))
1091 continue;
1092 return false;
1093 }
1094
1095 // Load from GV is ok.
1096 if (LoadInst *LI = dyn_cast<LoadInst>(InVal))
1097 if (LI->getOperand(0) == GV)
1098 continue;
1099
1100 // UNDEF? NULL?
1101
1102 // Anything else is rejected.
1103 return false;
1104 }
1105 }
1106
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001107 return true;
1108}
1109
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001110static Value *GetHeapSROAValue(Value *V, unsigned FieldNo,
1111 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
1112 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
1113 std::vector<Value*> &FieldVals = InsertedScalarizedValues[V];
1114
1115 if (FieldNo >= FieldVals.size())
1116 FieldVals.resize(FieldNo+1);
1117
1118 // If we already have this value, just reuse the previously scalarized
1119 // version.
1120 if (Value *FieldVal = FieldVals[FieldNo])
1121 return FieldVal;
1122
1123 // Depending on what instruction this is, we have several cases.
1124 Value *Result;
1125 if (LoadInst *LI = dyn_cast<LoadInst>(V)) {
1126 // This is a scalarized version of the load from the global. Just create
1127 // a new Load of the scalarized global.
1128 Result = new LoadInst(GetHeapSROAValue(LI->getOperand(0), FieldNo,
1129 InsertedScalarizedValues,
1130 PHIsToRewrite),
1131 LI->getName()+".f" + utostr(FieldNo), LI);
1132 } else if (PHINode *PN = dyn_cast<PHINode>(V)) {
1133 // PN's type is pointer to struct. Make a new PHI of pointer to struct
1134 // field.
1135 const StructType *ST =
1136 cast<StructType>(cast<PointerType>(PN->getType())->getElementType());
1137
1138 Result =PHINode::Create(PointerType::getUnqual(ST->getElementType(FieldNo)),
1139 PN->getName()+".f"+utostr(FieldNo), PN);
1140 PHIsToRewrite.push_back(std::make_pair(PN, FieldNo));
1141 } else {
1142 assert(0 && "Unknown usable value");
1143 Result = 0;
1144 }
1145
1146 return FieldVals[FieldNo] = Result;
Chris Lattner20eef0f2007-09-13 18:00:31 +00001147}
1148
Chris Lattneraf82fb82007-09-13 17:29:05 +00001149/// RewriteHeapSROALoadUser - Given a load instruction and a value derived from
1150/// the load, rewrite the derived value to use the HeapSRoA'd load.
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001151static void RewriteHeapSROALoadUser(Instruction *LoadUser,
1152 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
1153 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
Chris Lattneraf82fb82007-09-13 17:29:05 +00001154 // If this is a comparison against null, handle it.
1155 if (ICmpInst *SCI = dyn_cast<ICmpInst>(LoadUser)) {
1156 assert(isa<ConstantPointerNull>(SCI->getOperand(1)));
1157 // If we have a setcc of the loaded pointer, we can use a setcc of any
1158 // field.
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001159 Value *NPtr = GetHeapSROAValue(SCI->getOperand(0), 0,
1160 InsertedScalarizedValues, PHIsToRewrite);
Chris Lattneraf82fb82007-09-13 17:29:05 +00001161
1162 Value *New = new ICmpInst(SCI->getPredicate(), NPtr,
1163 Constant::getNullValue(NPtr->getType()),
1164 SCI->getName(), SCI);
1165 SCI->replaceAllUsesWith(New);
1166 SCI->eraseFromParent();
1167 return;
1168 }
1169
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001170 // Handle 'getelementptr Ptr, Idx, i32 FieldNo ...'
Chris Lattner20eef0f2007-09-13 18:00:31 +00001171 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(LoadUser)) {
1172 assert(GEPI->getNumOperands() >= 3 && isa<ConstantInt>(GEPI->getOperand(2))
1173 && "Unexpected GEPI!");
Chris Lattneraf82fb82007-09-13 17:29:05 +00001174
Chris Lattner20eef0f2007-09-13 18:00:31 +00001175 // Load the pointer for this field.
1176 unsigned FieldNo = cast<ConstantInt>(GEPI->getOperand(2))->getZExtValue();
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001177 Value *NewPtr = GetHeapSROAValue(GEPI->getOperand(0), FieldNo,
1178 InsertedScalarizedValues, PHIsToRewrite);
Chris Lattner20eef0f2007-09-13 18:00:31 +00001179
1180 // Create the new GEP idx vector.
1181 SmallVector<Value*, 8> GEPIdx;
1182 GEPIdx.push_back(GEPI->getOperand(1));
1183 GEPIdx.append(GEPI->op_begin()+3, GEPI->op_end());
1184
Gabor Greifb91ea9d2008-05-15 10:04:30 +00001185 Value *NGEPI = GetElementPtrInst::Create(NewPtr,
1186 GEPIdx.begin(), GEPIdx.end(),
Gabor Greifd6da1d02008-04-06 20:25:17 +00001187 GEPI->getName(), GEPI);
Chris Lattner20eef0f2007-09-13 18:00:31 +00001188 GEPI->replaceAllUsesWith(NGEPI);
1189 GEPI->eraseFromParent();
1190 return;
1191 }
Chris Lattnereefff982007-09-13 21:31:36 +00001192
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001193 // Recursively transform the users of PHI nodes. This will lazily create the
1194 // PHIs that are needed for individual elements. Keep track of what PHIs we
1195 // see in InsertedScalarizedValues so that we don't get infinite loops (very
1196 // antisocial). If the PHI is already in InsertedScalarizedValues, it has
1197 // already been seen first by another load, so its uses have already been
1198 // processed.
1199 PHINode *PN = cast<PHINode>(LoadUser);
1200 bool Inserted;
1201 DenseMap<Value*, std::vector<Value*> >::iterator InsertPos;
1202 tie(InsertPos, Inserted) =
1203 InsertedScalarizedValues.insert(std::make_pair(PN, std::vector<Value*>()));
1204 if (!Inserted) return;
Chris Lattnereefff982007-09-13 21:31:36 +00001205
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001206 // If this is the first time we've seen this PHI, recursively process all
1207 // users.
1208 for (Value::use_iterator UI = PN->use_begin(), E = PN->use_end(); UI != E;
1209 ++UI)
1210 RewriteHeapSROALoadUser(cast<Instruction>(*UI), InsertedScalarizedValues,
1211 PHIsToRewrite);
Chris Lattneraf82fb82007-09-13 17:29:05 +00001212}
1213
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001214/// RewriteUsesOfLoadForHeapSRoA - We are performing Heap SRoA on a global. Ptr
1215/// is a value loaded from the global. Eliminate all uses of Ptr, making them
1216/// use FieldGlobals instead. All uses of loaded values satisfy
Chris Lattner7f252db2008-12-16 21:24:51 +00001217/// AllGlobalLoadUsesSimpleEnoughForHeapSRA.
Chris Lattneraf82fb82007-09-13 17:29:05 +00001218static void RewriteUsesOfLoadForHeapSRoA(LoadInst *Load,
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001219 DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
1220 std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
1221 for (Value::use_iterator UI = Load->use_begin(), E = Load->use_end();
1222 UI != E; )
1223 RewriteHeapSROALoadUser(cast<Instruction>(*UI++), InsertedScalarizedValues,
1224 PHIsToRewrite);
1225
1226 if (Load->use_empty()) {
1227 Load->eraseFromParent();
1228 InsertedScalarizedValues.erase(Load);
1229 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001230}
1231
1232/// PerformHeapAllocSRoA - MI is an allocation of an array of structures. Break
1233/// it up into multiple allocations of arrays of the fields.
1234static GlobalVariable *PerformHeapAllocSRoA(GlobalVariable *GV, MallocInst *MI){
1235 DOUT << "SROA HEAP ALLOC: " << *GV << " MALLOC = " << *MI;
1236 const StructType *STy = cast<StructType>(MI->getAllocatedType());
1237
1238 // There is guaranteed to be at least one use of the malloc (storing
1239 // it into GV). If there are other uses, change them to be uses of
1240 // the global to simplify later code. This also deletes the store
1241 // into GV.
1242 ReplaceUsesOfMallocWithGlobal(MI, GV);
1243
1244 // Okay, at this point, there are no users of the malloc. Insert N
1245 // new mallocs at the same place as MI, and N globals.
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001246 std::vector<Value*> FieldGlobals;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001247 std::vector<MallocInst*> FieldMallocs;
1248
1249 for (unsigned FieldNo = 0, e = STy->getNumElements(); FieldNo != e;++FieldNo){
1250 const Type *FieldTy = STy->getElementType(FieldNo);
Christopher Lambbb2f2222007-12-17 01:12:55 +00001251 const Type *PFieldTy = PointerType::getUnqual(FieldTy);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001252
1253 GlobalVariable *NGV =
1254 new GlobalVariable(PFieldTy, false, GlobalValue::InternalLinkage,
1255 Constant::getNullValue(PFieldTy),
1256 GV->getName() + ".f" + utostr(FieldNo), GV,
1257 GV->isThreadLocal());
1258 FieldGlobals.push_back(NGV);
1259
1260 MallocInst *NMI = new MallocInst(FieldTy, MI->getArraySize(),
1261 MI->getName() + ".f" + utostr(FieldNo),MI);
1262 FieldMallocs.push_back(NMI);
1263 new StoreInst(NMI, NGV, MI);
1264 }
1265
1266 // The tricky aspect of this transformation is handling the case when malloc
1267 // fails. In the original code, malloc failing would set the result pointer
1268 // of malloc to null. In this case, some mallocs could succeed and others
1269 // could fail. As such, we emit code that looks like this:
1270 // F0 = malloc(field0)
1271 // F1 = malloc(field1)
1272 // F2 = malloc(field2)
1273 // if (F0 == 0 || F1 == 0 || F2 == 0) {
1274 // if (F0) { free(F0); F0 = 0; }
1275 // if (F1) { free(F1); F1 = 0; }
1276 // if (F2) { free(F2); F2 = 0; }
1277 // }
1278 Value *RunningOr = 0;
1279 for (unsigned i = 0, e = FieldMallocs.size(); i != e; ++i) {
1280 Value *Cond = new ICmpInst(ICmpInst::ICMP_EQ, FieldMallocs[i],
1281 Constant::getNullValue(FieldMallocs[i]->getType()),
1282 "isnull", MI);
1283 if (!RunningOr)
1284 RunningOr = Cond; // First seteq
1285 else
Gabor Greifa645dd32008-05-16 19:29:10 +00001286 RunningOr = BinaryOperator::CreateOr(RunningOr, Cond, "tmp", MI);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001287 }
1288
1289 // Split the basic block at the old malloc.
1290 BasicBlock *OrigBB = MI->getParent();
1291 BasicBlock *ContBB = OrigBB->splitBasicBlock(MI, "malloc_cont");
1292
1293 // Create the block to check the first condition. Put all these blocks at the
1294 // end of the function as they are unlikely to be executed.
Gabor Greifd6da1d02008-04-06 20:25:17 +00001295 BasicBlock *NullPtrBlock = BasicBlock::Create("malloc_ret_null",
1296 OrigBB->getParent());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001297
1298 // Remove the uncond branch from OrigBB to ContBB, turning it into a cond
1299 // branch on RunningOr.
1300 OrigBB->getTerminator()->eraseFromParent();
Gabor Greifd6da1d02008-04-06 20:25:17 +00001301 BranchInst::Create(NullPtrBlock, ContBB, RunningOr, OrigBB);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001302
1303 // Within the NullPtrBlock, we need to emit a comparison and branch for each
1304 // pointer, because some may be null while others are not.
1305 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1306 Value *GVVal = new LoadInst(FieldGlobals[i], "tmp", NullPtrBlock);
1307 Value *Cmp = new ICmpInst(ICmpInst::ICMP_NE, GVVal,
1308 Constant::getNullValue(GVVal->getType()),
1309 "tmp", NullPtrBlock);
Gabor Greifd6da1d02008-04-06 20:25:17 +00001310 BasicBlock *FreeBlock = BasicBlock::Create("free_it", OrigBB->getParent());
1311 BasicBlock *NextBlock = BasicBlock::Create("next", OrigBB->getParent());
1312 BranchInst::Create(FreeBlock, NextBlock, Cmp, NullPtrBlock);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001313
1314 // Fill in FreeBlock.
1315 new FreeInst(GVVal, FreeBlock);
1316 new StoreInst(Constant::getNullValue(GVVal->getType()), FieldGlobals[i],
1317 FreeBlock);
Gabor Greifd6da1d02008-04-06 20:25:17 +00001318 BranchInst::Create(NextBlock, FreeBlock);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001319
1320 NullPtrBlock = NextBlock;
1321 }
1322
Gabor Greifd6da1d02008-04-06 20:25:17 +00001323 BranchInst::Create(ContBB, NullPtrBlock);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001324
1325 // MI is no longer needed, remove it.
1326 MI->eraseFromParent();
1327
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001328 /// InsertedScalarizedLoads - As we process loads, if we can't immediately
1329 /// update all uses of the load, keep track of what scalarized loads are
1330 /// inserted for a given load.
1331 DenseMap<Value*, std::vector<Value*> > InsertedScalarizedValues;
1332 InsertedScalarizedValues[GV] = FieldGlobals;
1333
1334 std::vector<std::pair<PHINode*, unsigned> > PHIsToRewrite;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001335
1336 // Okay, the malloc site is completely handled. All of the uses of GV are now
1337 // loads, and all uses of those loads are simple. Rewrite them to use loads
1338 // of the per-field globals instead.
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001339 for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI != E;) {
1340 Instruction *User = cast<Instruction>(*UI++);
1341
1342 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
1343 RewriteUsesOfLoadForHeapSRoA(LI, InsertedScalarizedValues, PHIsToRewrite);
1344 continue;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001345 }
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001346
1347 // Must be a store of null.
1348 StoreInst *SI = cast<StoreInst>(User);
1349 assert(isa<ConstantPointerNull>(SI->getOperand(0)) &&
1350 "Unexpected heap-sra user!");
1351
1352 // Insert a store of null into each global.
1353 for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1354 const PointerType *PT = cast<PointerType>(FieldGlobals[i]->getType());
1355 Constant *Null = Constant::getNullValue(PT->getElementType());
1356 new StoreInst(Null, FieldGlobals[i], SI);
1357 }
1358 // Erase the original store.
1359 SI->eraseFromParent();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001360 }
1361
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001362 // While we have PHIs that are interesting to rewrite, do it.
1363 while (!PHIsToRewrite.empty()) {
1364 PHINode *PN = PHIsToRewrite.back().first;
1365 unsigned FieldNo = PHIsToRewrite.back().second;
1366 PHIsToRewrite.pop_back();
1367 PHINode *FieldPN = cast<PHINode>(InsertedScalarizedValues[PN][FieldNo]);
1368 assert(FieldPN->getNumIncomingValues() == 0 &&"Already processed this phi");
1369
1370 // Add all the incoming values. This can materialize more phis.
1371 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1372 Value *InVal = PN->getIncomingValue(i);
1373 InVal = GetHeapSROAValue(InVal, FieldNo, InsertedScalarizedValues,
1374 PHIsToRewrite);
1375 FieldPN->addIncoming(InVal, PN->getIncomingBlock(i));
1376 }
1377 }
1378
1379 // Drop all inter-phi links and any loads that made it this far.
1380 for (DenseMap<Value*, std::vector<Value*> >::iterator
1381 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1382 I != E; ++I) {
1383 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1384 PN->dropAllReferences();
1385 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1386 LI->dropAllReferences();
1387 }
1388
1389 // Delete all the phis and loads now that inter-references are dead.
1390 for (DenseMap<Value*, std::vector<Value*> >::iterator
1391 I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1392 I != E; ++I) {
1393 if (PHINode *PN = dyn_cast<PHINode>(I->first))
1394 PN->eraseFromParent();
1395 else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1396 LI->eraseFromParent();
1397 }
1398
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001399 // The old global is now dead, remove it.
1400 GV->eraseFromParent();
1401
1402 ++NumHeapSRA;
Chris Lattner8a2d32e2008-12-17 05:28:49 +00001403 return cast<GlobalVariable>(FieldGlobals[0]);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001404}
1405
Chris Lattner78e568b2008-12-15 21:02:25 +00001406/// TryToOptimizeStoreOfMallocToGlobal - This function is called when we see a
1407/// pointer global variable with a single value stored it that is a malloc or
1408/// cast of malloc.
1409static bool TryToOptimizeStoreOfMallocToGlobal(GlobalVariable *GV,
1410 MallocInst *MI,
1411 Module::global_iterator &GVI,
1412 TargetData &TD) {
1413 // If this is a malloc of an abstract type, don't touch it.
1414 if (!MI->getAllocatedType()->isSized())
1415 return false;
1416
1417 // We can't optimize this global unless all uses of it are *known* to be
1418 // of the malloc value, not of the null initializer value (consider a use
1419 // that compares the global's value against zero to see if the malloc has
1420 // been reached). To do this, we check to see if all uses of the global
1421 // would trap if the global were null: this proves that they must all
1422 // happen after the malloc.
1423 if (!AllUsesOfLoadedValueWillTrapIfNull(GV))
1424 return false;
1425
1426 // We can't optimize this if the malloc itself is used in a complex way,
1427 // for example, being stored into multiple globals. This allows the
1428 // malloc to be stored into the specified global, loaded setcc'd, and
1429 // GEP'd. These are all things we could transform to using the global
1430 // for.
1431 {
1432 SmallPtrSet<PHINode*, 8> PHIs;
1433 if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(MI, GV, PHIs))
1434 return false;
1435 }
1436
1437
1438 // If we have a global that is only initialized with a fixed size malloc,
1439 // transform the program to use global memory instead of malloc'd memory.
1440 // This eliminates dynamic allocation, avoids an indirection accessing the
1441 // data, and exposes the resultant global to further GlobalOpt.
1442 if (ConstantInt *NElements = dyn_cast<ConstantInt>(MI->getArraySize())) {
1443 // Restrict this transformation to only working on small allocations
1444 // (2048 bytes currently), as we don't want to introduce a 16M global or
1445 // something.
1446 if (NElements->getZExtValue()*
1447 TD.getABITypeSize(MI->getAllocatedType()) < 2048) {
1448 GVI = OptimizeGlobalAddressOfMalloc(GV, MI);
1449 return true;
1450 }
1451 }
1452
1453 // If the allocation is an array of structures, consider transforming this
1454 // into multiple malloc'd arrays, one for each field. This is basically
1455 // SRoA for malloc'd memory.
Chris Lattner27ef89e2008-12-15 21:44:34 +00001456 const Type *AllocTy = MI->getAllocatedType();
1457
1458 // If this is an allocation of a fixed size array of structs, analyze as a
1459 // variable size array. malloc [100 x struct],1 -> malloc struct, 100
1460 if (!MI->isArrayAllocation())
1461 if (const ArrayType *AT = dyn_cast<ArrayType>(AllocTy))
1462 AllocTy = AT->getElementType();
1463
1464 if (const StructType *AllocSTy = dyn_cast<StructType>(AllocTy)) {
Chris Lattner78e568b2008-12-15 21:02:25 +00001465 // This the structure has an unreasonable number of fields, leave it
1466 // alone.
Chris Lattner27ef89e2008-12-15 21:44:34 +00001467 if (AllocSTy->getNumElements() <= 16 && AllocSTy->getNumElements() != 0 &&
Chris Lattner7f252db2008-12-16 21:24:51 +00001468 AllGlobalLoadUsesSimpleEnoughForHeapSRA(GV, MI)) {
Chris Lattner27ef89e2008-12-15 21:44:34 +00001469
1470 // If this is a fixed size array, transform the Malloc to be an alloc of
1471 // structs. malloc [100 x struct],1 -> malloc struct, 100
1472 if (const ArrayType *AT = dyn_cast<ArrayType>(MI->getAllocatedType())) {
1473 MallocInst *NewMI =
1474 new MallocInst(AllocSTy,
1475 ConstantInt::get(Type::Int32Ty, AT->getNumElements()),
1476 "", MI);
1477 NewMI->takeName(MI);
1478 Value *Cast = new BitCastInst(NewMI, MI->getType(), "tmp", MI);
1479 MI->replaceAllUsesWith(Cast);
1480 MI->eraseFromParent();
1481 MI = NewMI;
1482 }
1483
Chris Lattner78e568b2008-12-15 21:02:25 +00001484 GVI = PerformHeapAllocSRoA(GV, MI);
1485 return true;
1486 }
1487 }
1488
1489 return false;
1490}
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001491
1492// OptimizeOnceStoredGlobal - Try to optimize globals based on the knowledge
1493// that only one value (besides its initializer) is ever stored to the global.
1494static bool OptimizeOnceStoredGlobal(GlobalVariable *GV, Value *StoredOnceVal,
1495 Module::global_iterator &GVI,
1496 TargetData &TD) {
Chris Lattner2e729112008-12-15 21:20:32 +00001497 // Ignore no-op GEPs and bitcasts.
1498 StoredOnceVal = StoredOnceVal->stripPointerCasts();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001499
1500 // If we are dealing with a pointer global that is initialized to null and
1501 // only has one (non-null) value stored into it, then we can optimize any
1502 // users of the loaded value (often calls and loads) that would trap if the
1503 // value was null.
1504 if (isa<PointerType>(GV->getInitializer()->getType()) &&
1505 GV->getInitializer()->isNullValue()) {
1506 if (Constant *SOVC = dyn_cast<Constant>(StoredOnceVal)) {
1507 if (GV->getInitializer()->getType() != SOVC->getType())
1508 SOVC = ConstantExpr::getBitCast(SOVC, GV->getInitializer()->getType());
1509
1510 // Optimize away any trapping uses of the loaded value.
1511 if (OptimizeAwayTrappingUsesOfLoads(GV, SOVC))
1512 return true;
1513 } else if (MallocInst *MI = dyn_cast<MallocInst>(StoredOnceVal)) {
Chris Lattner78e568b2008-12-15 21:02:25 +00001514 if (TryToOptimizeStoreOfMallocToGlobal(GV, MI, GVI, TD))
1515 return true;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001516 }
1517 }
1518
1519 return false;
1520}
1521
Chris Lattnerece46db2008-01-14 01:17:44 +00001522/// TryToShrinkGlobalToBoolean - At this point, we have learned that the only
1523/// two values ever stored into GV are its initializer and OtherVal. See if we
1524/// can shrink the global into a boolean and select between the two values
1525/// whenever it is used. This exposes the values to other scalar optimizations.
1526static bool TryToShrinkGlobalToBoolean(GlobalVariable *GV, Constant *OtherVal) {
1527 const Type *GVElType = GV->getType()->getElementType();
1528
1529 // If GVElType is already i1, it is already shrunk. If the type of the GV is
1530 // an FP value or vector, don't do this optimization because a select between
1531 // them is very expensive and unlikely to lead to later simplification.
1532 if (GVElType == Type::Int1Ty || GVElType->isFloatingPoint() ||
1533 isa<VectorType>(GVElType))
1534 return false;
1535
1536 // Walk the use list of the global seeing if all the uses are load or store.
1537 // If there is anything else, bail out.
1538 for (Value::use_iterator I = GV->use_begin(), E = GV->use_end(); I != E; ++I)
1539 if (!isa<LoadInst>(I) && !isa<StoreInst>(I))
1540 return false;
1541
1542 DOUT << " *** SHRINKING TO BOOL: " << *GV;
1543
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001544 // Create the new global, initializing it to false.
1545 GlobalVariable *NewGV = new GlobalVariable(Type::Int1Ty, false,
1546 GlobalValue::InternalLinkage, ConstantInt::getFalse(),
1547 GV->getName()+".b",
1548 (Module *)NULL,
1549 GV->isThreadLocal());
1550 GV->getParent()->getGlobalList().insert(GV, NewGV);
1551
1552 Constant *InitVal = GV->getInitializer();
1553 assert(InitVal->getType() != Type::Int1Ty && "No reason to shrink to bool!");
1554
1555 // If initialized to zero and storing one into the global, we can use a cast
1556 // instead of a select to synthesize the desired value.
1557 bool IsOneZero = false;
1558 if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal))
1559 IsOneZero = InitVal->isNullValue() && CI->isOne();
1560
1561 while (!GV->use_empty()) {
1562 Instruction *UI = cast<Instruction>(GV->use_back());
1563 if (StoreInst *SI = dyn_cast<StoreInst>(UI)) {
1564 // Change the store into a boolean store.
1565 bool StoringOther = SI->getOperand(0) == OtherVal;
1566 // Only do this if we weren't storing a loaded value.
1567 Value *StoreVal;
1568 if (StoringOther || SI->getOperand(0) == InitVal)
1569 StoreVal = ConstantInt::get(Type::Int1Ty, StoringOther);
1570 else {
1571 // Otherwise, we are storing a previously loaded copy. To do this,
1572 // change the copy from copying the original value to just copying the
1573 // bool.
1574 Instruction *StoredVal = cast<Instruction>(SI->getOperand(0));
1575
1576 // If we're already replaced the input, StoredVal will be a cast or
1577 // select instruction. If not, it will be a load of the original
1578 // global.
1579 if (LoadInst *LI = dyn_cast<LoadInst>(StoredVal)) {
1580 assert(LI->getOperand(0) == GV && "Not a copy!");
1581 // Insert a new load, to preserve the saved value.
1582 StoreVal = new LoadInst(NewGV, LI->getName()+".b", LI);
1583 } else {
1584 assert((isa<CastInst>(StoredVal) || isa<SelectInst>(StoredVal)) &&
1585 "This is not a form that we understand!");
1586 StoreVal = StoredVal->getOperand(0);
1587 assert(isa<LoadInst>(StoreVal) && "Not a load of NewGV!");
1588 }
1589 }
1590 new StoreInst(StoreVal, NewGV, SI);
Chris Lattnerece46db2008-01-14 01:17:44 +00001591 } else {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001592 // Change the load into a load of bool then a select.
1593 LoadInst *LI = cast<LoadInst>(UI);
1594 LoadInst *NLI = new LoadInst(NewGV, LI->getName()+".b", LI);
1595 Value *NSI;
1596 if (IsOneZero)
1597 NSI = new ZExtInst(NLI, LI->getType(), "", LI);
1598 else
Gabor Greifd6da1d02008-04-06 20:25:17 +00001599 NSI = SelectInst::Create(NLI, OtherVal, InitVal, "", LI);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001600 NSI->takeName(LI);
1601 LI->replaceAllUsesWith(NSI);
1602 }
1603 UI->eraseFromParent();
1604 }
1605
1606 GV->eraseFromParent();
Chris Lattnerece46db2008-01-14 01:17:44 +00001607 return true;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001608}
1609
1610
1611/// ProcessInternalGlobal - Analyze the specified global variable and optimize
1612/// it if possible. If we make a change, return true.
1613bool GlobalOpt::ProcessInternalGlobal(GlobalVariable *GV,
1614 Module::global_iterator &GVI) {
Chris Lattner4cd08c22008-12-16 07:34:30 +00001615 SmallPtrSet<PHINode*, 16> PHIUsers;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001616 GlobalStatus GS;
1617 GV->removeDeadConstantUsers();
1618
1619 if (GV->use_empty()) {
1620 DOUT << "GLOBAL DEAD: " << *GV;
1621 GV->eraseFromParent();
1622 ++NumDeleted;
1623 return true;
1624 }
1625
1626 if (!AnalyzeGlobal(GV, GS, PHIUsers)) {
1627#if 0
1628 cerr << "Global: " << *GV;
1629 cerr << " isLoaded = " << GS.isLoaded << "\n";
1630 cerr << " StoredType = ";
1631 switch (GS.StoredType) {
1632 case GlobalStatus::NotStored: cerr << "NEVER STORED\n"; break;
1633 case GlobalStatus::isInitializerStored: cerr << "INIT STORED\n"; break;
1634 case GlobalStatus::isStoredOnce: cerr << "STORED ONCE\n"; break;
1635 case GlobalStatus::isStored: cerr << "stored\n"; break;
1636 }
1637 if (GS.StoredType == GlobalStatus::isStoredOnce && GS.StoredOnceValue)
1638 cerr << " StoredOnceValue = " << *GS.StoredOnceValue << "\n";
1639 if (GS.AccessingFunction && !GS.HasMultipleAccessingFunctions)
1640 cerr << " AccessingFunction = " << GS.AccessingFunction->getName()
1641 << "\n";
1642 cerr << " HasMultipleAccessingFunctions = "
1643 << GS.HasMultipleAccessingFunctions << "\n";
1644 cerr << " HasNonInstructionUser = " << GS.HasNonInstructionUser<<"\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001645 cerr << "\n";
1646#endif
1647
1648 // If this is a first class global and has only one accessing function
1649 // and this function is main (which we know is not recursive we can make
1650 // this global a local variable) we replace the global with a local alloca
1651 // in this function.
1652 //
Dan Gohman5e8fbc22008-05-23 00:17:26 +00001653 // NOTE: It doesn't make sense to promote non single-value types since we
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001654 // are just replacing static memory to stack memory.
1655 if (!GS.HasMultipleAccessingFunctions &&
1656 GS.AccessingFunction && !GS.HasNonInstructionUser &&
Dan Gohman5e8fbc22008-05-23 00:17:26 +00001657 GV->getType()->getElementType()->isSingleValueType() &&
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001658 GS.AccessingFunction->getName() == "main" &&
1659 GS.AccessingFunction->hasExternalLinkage()) {
1660 DOUT << "LOCALIZING GLOBAL: " << *GV;
1661 Instruction* FirstI = GS.AccessingFunction->getEntryBlock().begin();
1662 const Type* ElemTy = GV->getType()->getElementType();
1663 // FIXME: Pass Global's alignment when globals have alignment
1664 AllocaInst* Alloca = new AllocaInst(ElemTy, NULL, GV->getName(), FirstI);
1665 if (!isa<UndefValue>(GV->getInitializer()))
1666 new StoreInst(GV->getInitializer(), Alloca, FirstI);
1667
1668 GV->replaceAllUsesWith(Alloca);
1669 GV->eraseFromParent();
1670 ++NumLocalized;
1671 return true;
1672 }
1673
1674 // If the global is never loaded (but may be stored to), it is dead.
1675 // Delete it now.
1676 if (!GS.isLoaded) {
1677 DOUT << "GLOBAL NEVER LOADED: " << *GV;
1678
1679 // Delete any stores we can find to the global. We may not be able to
1680 // make it completely dead though.
1681 bool Changed = CleanupConstantGlobalUsers(GV, GV->getInitializer());
1682
1683 // If the global is dead now, delete it.
1684 if (GV->use_empty()) {
1685 GV->eraseFromParent();
1686 ++NumDeleted;
1687 Changed = true;
1688 }
1689 return Changed;
1690
1691 } else if (GS.StoredType <= GlobalStatus::isInitializerStored) {
1692 DOUT << "MARKING CONSTANT: " << *GV;
1693 GV->setConstant(true);
1694
1695 // Clean up any obviously simplifiable users now.
1696 CleanupConstantGlobalUsers(GV, GV->getInitializer());
1697
1698 // If the global is dead now, just nuke it.
1699 if (GV->use_empty()) {
1700 DOUT << " *** Marking constant allowed us to simplify "
1701 << "all users and delete global!\n";
1702 GV->eraseFromParent();
1703 ++NumDeleted;
1704 }
1705
1706 ++NumMarked;
1707 return true;
Dan Gohman5e8fbc22008-05-23 00:17:26 +00001708 } else if (!GV->getInitializer()->getType()->isSingleValueType()) {
Chris Lattner20846272008-04-26 07:40:11 +00001709 if (GlobalVariable *FirstNewGV = SRAGlobal(GV,
1710 getAnalysis<TargetData>())) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001711 GVI = FirstNewGV; // Don't skip the newly produced globals!
1712 return true;
1713 }
1714 } else if (GS.StoredType == GlobalStatus::isStoredOnce) {
1715 // If the initial value for the global was an undef value, and if only
1716 // one other value was stored into it, we can just change the
1717 // initializer to be an undef value, then delete all stores to the
1718 // global. This allows us to mark it constant.
1719 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1720 if (isa<UndefValue>(GV->getInitializer())) {
1721 // Change the initial value here.
1722 GV->setInitializer(SOVConstant);
1723
1724 // Clean up any obviously simplifiable users now.
1725 CleanupConstantGlobalUsers(GV, GV->getInitializer());
1726
1727 if (GV->use_empty()) {
1728 DOUT << " *** Substituting initializer allowed us to "
1729 << "simplify all users and delete global!\n";
1730 GV->eraseFromParent();
1731 ++NumDeleted;
1732 } else {
1733 GVI = GV;
1734 }
1735 ++NumSubstitute;
1736 return true;
1737 }
1738
1739 // Try to optimize globals based on the knowledge that only one value
1740 // (besides its initializer) is ever stored to the global.
1741 if (OptimizeOnceStoredGlobal(GV, GS.StoredOnceValue, GVI,
1742 getAnalysis<TargetData>()))
1743 return true;
1744
1745 // Otherwise, if the global was not a boolean, we can shrink it to be a
1746 // boolean.
1747 if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
Chris Lattnerece46db2008-01-14 01:17:44 +00001748 if (TryToShrinkGlobalToBoolean(GV, SOVConstant)) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001749 ++NumShrunkToBool;
1750 return true;
1751 }
1752 }
1753 }
1754 return false;
1755}
1756
1757/// OnlyCalledDirectly - Return true if the specified function is only called
1758/// directly. In other words, its address is never taken.
1759static bool OnlyCalledDirectly(Function *F) {
1760 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
1761 Instruction *User = dyn_cast<Instruction>(*UI);
1762 if (!User) return false;
1763 if (!isa<CallInst>(User) && !isa<InvokeInst>(User)) return false;
1764
1765 // See if the function address is passed as an argument.
Gabor Greif20f03f52008-05-29 01:59:18 +00001766 for (User::op_iterator i = User->op_begin() + 1, e = User->op_end();
Bill Wendling3c470e22008-08-12 23:15:44 +00001767 i != e; ++i)
Gabor Greif20f03f52008-05-29 01:59:18 +00001768 if (*i == F) return false;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001769 }
1770 return true;
1771}
1772
1773/// ChangeCalleesToFastCall - Walk all of the direct calls of the specified
1774/// function, changing them to FastCC.
1775static void ChangeCalleesToFastCall(Function *F) {
1776 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
Duncan Sands551ec902008-02-18 17:32:13 +00001777 CallSite User(cast<Instruction>(*UI));
1778 User.setCallingConv(CallingConv::Fast);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001779 }
1780}
1781
Devang Pateld222f862008-09-25 21:00:45 +00001782static AttrListPtr StripNest(const AttrListPtr &Attrs) {
Chris Lattner1c8733e2008-03-12 17:45:29 +00001783 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Devang Pateld222f862008-09-25 21:00:45 +00001784 if ((Attrs.getSlot(i).Attrs & Attribute::Nest) == 0)
Duncan Sands551ec902008-02-18 17:32:13 +00001785 continue;
1786
Duncan Sands551ec902008-02-18 17:32:13 +00001787 // There can be only one.
Devang Pateld222f862008-09-25 21:00:45 +00001788 return Attrs.removeAttr(Attrs.getSlot(i).Index, Attribute::Nest);
Duncan Sandsafa10bf2008-02-16 20:56:04 +00001789 }
1790
1791 return Attrs;
1792}
1793
1794static void RemoveNestAttribute(Function *F) {
Devang Pateld222f862008-09-25 21:00:45 +00001795 F->setAttributes(StripNest(F->getAttributes()));
Duncan Sandsafa10bf2008-02-16 20:56:04 +00001796 for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
Duncan Sands551ec902008-02-18 17:32:13 +00001797 CallSite User(cast<Instruction>(*UI));
Devang Pateld222f862008-09-25 21:00:45 +00001798 User.setAttributes(StripNest(User.getAttributes()));
Duncan Sandsafa10bf2008-02-16 20:56:04 +00001799 }
1800}
1801
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001802bool GlobalOpt::OptimizeFunctions(Module &M) {
1803 bool Changed = false;
1804 // Optimize functions.
1805 for (Module::iterator FI = M.begin(), E = M.end(); FI != E; ) {
1806 Function *F = FI++;
1807 F->removeDeadConstantUsers();
1808 if (F->use_empty() && (F->hasInternalLinkage() ||
1809 F->hasLinkOnceLinkage())) {
1810 M.getFunctionList().erase(F);
1811 Changed = true;
1812 ++NumFnDeleted;
Duncan Sandsafa10bf2008-02-16 20:56:04 +00001813 } else if (F->hasInternalLinkage()) {
1814 if (F->getCallingConv() == CallingConv::C && !F->isVarArg() &&
1815 OnlyCalledDirectly(F)) {
1816 // If this function has C calling conventions, is not a varargs
1817 // function, and is only called directly, promote it to use the Fast
1818 // calling convention.
1819 F->setCallingConv(CallingConv::Fast);
1820 ChangeCalleesToFastCall(F);
1821 ++NumFastCallFns;
1822 Changed = true;
1823 }
1824
Devang Pateld222f862008-09-25 21:00:45 +00001825 if (F->getAttributes().hasAttrSomewhere(Attribute::Nest) &&
Duncan Sandsafa10bf2008-02-16 20:56:04 +00001826 OnlyCalledDirectly(F)) {
1827 // The function is not used by a trampoline intrinsic, so it is safe
1828 // to remove the 'nest' attribute.
1829 RemoveNestAttribute(F);
1830 ++NumNestRemoved;
1831 Changed = true;
1832 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001833 }
1834 }
1835 return Changed;
1836}
1837
1838bool GlobalOpt::OptimizeGlobalVars(Module &M) {
1839 bool Changed = false;
1840 for (Module::global_iterator GVI = M.global_begin(), E = M.global_end();
1841 GVI != E; ) {
1842 GlobalVariable *GV = GVI++;
1843 if (!GV->isConstant() && GV->hasInternalLinkage() &&
1844 GV->hasInitializer())
1845 Changed |= ProcessInternalGlobal(GV, GVI);
1846 }
1847 return Changed;
1848}
1849
1850/// FindGlobalCtors - Find the llvm.globalctors list, verifying that all
1851/// initializers have an init priority of 65535.
1852GlobalVariable *GlobalOpt::FindGlobalCtors(Module &M) {
1853 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
1854 I != E; ++I)
1855 if (I->getName() == "llvm.global_ctors") {
1856 // Found it, verify it's an array of { int, void()* }.
1857 const ArrayType *ATy =dyn_cast<ArrayType>(I->getType()->getElementType());
1858 if (!ATy) return 0;
1859 const StructType *STy = dyn_cast<StructType>(ATy->getElementType());
1860 if (!STy || STy->getNumElements() != 2 ||
1861 STy->getElementType(0) != Type::Int32Ty) return 0;
1862 const PointerType *PFTy = dyn_cast<PointerType>(STy->getElementType(1));
1863 if (!PFTy) return 0;
1864 const FunctionType *FTy = dyn_cast<FunctionType>(PFTy->getElementType());
1865 if (!FTy || FTy->getReturnType() != Type::VoidTy || FTy->isVarArg() ||
1866 FTy->getNumParams() != 0)
1867 return 0;
1868
1869 // Verify that the initializer is simple enough for us to handle.
1870 if (!I->hasInitializer()) return 0;
1871 ConstantArray *CA = dyn_cast<ConstantArray>(I->getInitializer());
1872 if (!CA) return 0;
Gabor Greif20f03f52008-05-29 01:59:18 +00001873 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i)
1874 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(*i)) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001875 if (isa<ConstantPointerNull>(CS->getOperand(1)))
1876 continue;
1877
1878 // Must have a function or null ptr.
1879 if (!isa<Function>(CS->getOperand(1)))
1880 return 0;
1881
1882 // Init priority must be standard.
1883 ConstantInt *CI = dyn_cast<ConstantInt>(CS->getOperand(0));
1884 if (!CI || CI->getZExtValue() != 65535)
1885 return 0;
1886 } else {
1887 return 0;
1888 }
1889
1890 return I;
1891 }
1892 return 0;
1893}
1894
1895/// ParseGlobalCtors - Given a llvm.global_ctors list that we can understand,
1896/// return a list of the functions and null terminator as a vector.
1897static std::vector<Function*> ParseGlobalCtors(GlobalVariable *GV) {
1898 ConstantArray *CA = cast<ConstantArray>(GV->getInitializer());
1899 std::vector<Function*> Result;
1900 Result.reserve(CA->getNumOperands());
Gabor Greif20f03f52008-05-29 01:59:18 +00001901 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i) {
1902 ConstantStruct *CS = cast<ConstantStruct>(*i);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001903 Result.push_back(dyn_cast<Function>(CS->getOperand(1)));
1904 }
1905 return Result;
1906}
1907
1908/// InstallGlobalCtors - Given a specified llvm.global_ctors list, install the
1909/// specified array, returning the new global to use.
1910static GlobalVariable *InstallGlobalCtors(GlobalVariable *GCL,
1911 const std::vector<Function*> &Ctors) {
1912 // If we made a change, reassemble the initializer list.
1913 std::vector<Constant*> CSVals;
1914 CSVals.push_back(ConstantInt::get(Type::Int32Ty, 65535));
1915 CSVals.push_back(0);
1916
1917 // Create the new init list.
1918 std::vector<Constant*> CAList;
1919 for (unsigned i = 0, e = Ctors.size(); i != e; ++i) {
1920 if (Ctors[i]) {
1921 CSVals[1] = Ctors[i];
1922 } else {
1923 const Type *FTy = FunctionType::get(Type::VoidTy,
1924 std::vector<const Type*>(), false);
Christopher Lambbb2f2222007-12-17 01:12:55 +00001925 const PointerType *PFTy = PointerType::getUnqual(FTy);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001926 CSVals[1] = Constant::getNullValue(PFTy);
1927 CSVals[0] = ConstantInt::get(Type::Int32Ty, 2147483647);
1928 }
1929 CAList.push_back(ConstantStruct::get(CSVals));
1930 }
1931
1932 // Create the array initializer.
1933 const Type *StructTy =
1934 cast<ArrayType>(GCL->getType()->getElementType())->getElementType();
1935 Constant *CA = ConstantArray::get(ArrayType::get(StructTy, CAList.size()),
1936 CAList);
1937
1938 // If we didn't change the number of elements, don't create a new GV.
1939 if (CA->getType() == GCL->getInitializer()->getType()) {
1940 GCL->setInitializer(CA);
1941 return GCL;
1942 }
1943
1944 // Create the new global and insert it next to the existing list.
1945 GlobalVariable *NGV = new GlobalVariable(CA->getType(), GCL->isConstant(),
1946 GCL->getLinkage(), CA, "",
1947 (Module *)NULL,
1948 GCL->isThreadLocal());
1949 GCL->getParent()->getGlobalList().insert(GCL, NGV);
1950 NGV->takeName(GCL);
1951
1952 // Nuke the old list, replacing any uses with the new one.
1953 if (!GCL->use_empty()) {
1954 Constant *V = NGV;
1955 if (V->getType() != GCL->getType())
1956 V = ConstantExpr::getBitCast(V, GCL->getType());
1957 GCL->replaceAllUsesWith(V);
1958 }
1959 GCL->eraseFromParent();
1960
1961 if (Ctors.size())
1962 return NGV;
1963 else
1964 return 0;
1965}
1966
1967
Chris Lattner4cd08c22008-12-16 07:34:30 +00001968static Constant *getVal(DenseMap<Value*, Constant*> &ComputedValues,
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001969 Value *V) {
1970 if (Constant *CV = dyn_cast<Constant>(V)) return CV;
1971 Constant *R = ComputedValues[V];
1972 assert(R && "Reference to an uncomputed value!");
1973 return R;
1974}
1975
1976/// isSimpleEnoughPointerToCommit - Return true if this constant is simple
1977/// enough for us to understand. In particular, if it is a cast of something,
1978/// we punt. We basically just support direct accesses to globals and GEP's of
1979/// globals. This should be kept up to date with CommitValueTo.
1980static bool isSimpleEnoughPointerToCommit(Constant *C) {
1981 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C)) {
1982 if (!GV->hasExternalLinkage() && !GV->hasInternalLinkage())
1983 return false; // do not allow weak/linkonce/dllimport/dllexport linkage.
1984 return !GV->isDeclaration(); // reject external globals.
1985 }
1986 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
1987 // Handle a constantexpr gep.
1988 if (CE->getOpcode() == Instruction::GetElementPtr &&
1989 isa<GlobalVariable>(CE->getOperand(0))) {
1990 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
1991 if (!GV->hasExternalLinkage() && !GV->hasInternalLinkage())
1992 return false; // do not allow weak/linkonce/dllimport/dllexport linkage.
1993 return GV->hasInitializer() &&
1994 ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
1995 }
1996 return false;
1997}
1998
1999/// EvaluateStoreInto - Evaluate a piece of a constantexpr store into a global
2000/// initializer. This returns 'Init' modified to reflect 'Val' stored into it.
2001/// At this point, the GEP operands of Addr [0, OpNo) have been stepped into.
2002static Constant *EvaluateStoreInto(Constant *Init, Constant *Val,
2003 ConstantExpr *Addr, unsigned OpNo) {
2004 // Base case of the recursion.
2005 if (OpNo == Addr->getNumOperands()) {
2006 assert(Val->getType() == Init->getType() && "Type mismatch!");
2007 return Val;
2008 }
2009
2010 if (const StructType *STy = dyn_cast<StructType>(Init->getType())) {
2011 std::vector<Constant*> Elts;
2012
2013 // Break up the constant into its elements.
2014 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Init)) {
Gabor Greif20f03f52008-05-29 01:59:18 +00002015 for (User::op_iterator i = CS->op_begin(), e = CS->op_end(); i != e; ++i)
2016 Elts.push_back(cast<Constant>(*i));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002017 } else if (isa<ConstantAggregateZero>(Init)) {
2018 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
2019 Elts.push_back(Constant::getNullValue(STy->getElementType(i)));
2020 } else if (isa<UndefValue>(Init)) {
2021 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
2022 Elts.push_back(UndefValue::get(STy->getElementType(i)));
2023 } else {
2024 assert(0 && "This code is out of sync with "
2025 " ConstantFoldLoadThroughGEPConstantExpr");
2026 }
2027
2028 // Replace the element that we are supposed to.
2029 ConstantInt *CU = cast<ConstantInt>(Addr->getOperand(OpNo));
2030 unsigned Idx = CU->getZExtValue();
2031 assert(Idx < STy->getNumElements() && "Struct index out of range!");
2032 Elts[Idx] = EvaluateStoreInto(Elts[Idx], Val, Addr, OpNo+1);
2033
2034 // Return the modified struct.
2035 return ConstantStruct::get(&Elts[0], Elts.size(), STy->isPacked());
2036 } else {
2037 ConstantInt *CI = cast<ConstantInt>(Addr->getOperand(OpNo));
2038 const ArrayType *ATy = cast<ArrayType>(Init->getType());
2039
2040 // Break up the array into elements.
2041 std::vector<Constant*> Elts;
2042 if (ConstantArray *CA = dyn_cast<ConstantArray>(Init)) {
Gabor Greif20f03f52008-05-29 01:59:18 +00002043 for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i)
2044 Elts.push_back(cast<Constant>(*i));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002045 } else if (isa<ConstantAggregateZero>(Init)) {
2046 Constant *Elt = Constant::getNullValue(ATy->getElementType());
2047 Elts.assign(ATy->getNumElements(), Elt);
2048 } else if (isa<UndefValue>(Init)) {
2049 Constant *Elt = UndefValue::get(ATy->getElementType());
2050 Elts.assign(ATy->getNumElements(), Elt);
2051 } else {
2052 assert(0 && "This code is out of sync with "
2053 " ConstantFoldLoadThroughGEPConstantExpr");
2054 }
2055
2056 assert(CI->getZExtValue() < ATy->getNumElements());
2057 Elts[CI->getZExtValue()] =
2058 EvaluateStoreInto(Elts[CI->getZExtValue()], Val, Addr, OpNo+1);
2059 return ConstantArray::get(ATy, Elts);
2060 }
2061}
2062
2063/// CommitValueTo - We have decided that Addr (which satisfies the predicate
2064/// isSimpleEnoughPointerToCommit) should get Val as its value. Make it happen.
2065static void CommitValueTo(Constant *Val, Constant *Addr) {
2066 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Addr)) {
2067 assert(GV->hasInitializer());
2068 GV->setInitializer(Val);
2069 return;
2070 }
2071
2072 ConstantExpr *CE = cast<ConstantExpr>(Addr);
2073 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
2074
2075 Constant *Init = GV->getInitializer();
2076 Init = EvaluateStoreInto(Init, Val, CE, 2);
2077 GV->setInitializer(Init);
2078}
2079
2080/// ComputeLoadResult - Return the value that would be computed by a load from
2081/// P after the stores reflected by 'memory' have been performed. If we can't
2082/// decide, return null.
2083static Constant *ComputeLoadResult(Constant *P,
Chris Lattner4cd08c22008-12-16 07:34:30 +00002084 const DenseMap<Constant*, Constant*> &Memory) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002085 // If this memory location has been recently stored, use the stored value: it
2086 // is the most up-to-date.
Chris Lattner4cd08c22008-12-16 07:34:30 +00002087 DenseMap<Constant*, Constant*>::const_iterator I = Memory.find(P);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002088 if (I != Memory.end()) return I->second;
2089
2090 // Access it.
2091 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(P)) {
2092 if (GV->hasInitializer())
2093 return GV->getInitializer();
2094 return 0;
2095 }
2096
2097 // Handle a constantexpr getelementptr.
2098 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(P))
2099 if (CE->getOpcode() == Instruction::GetElementPtr &&
2100 isa<GlobalVariable>(CE->getOperand(0))) {
2101 GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
2102 if (GV->hasInitializer())
2103 return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
2104 }
2105
2106 return 0; // don't know how to evaluate.
2107}
2108
2109/// EvaluateFunction - Evaluate a call to function F, returning true if
2110/// successful, false if we can't evaluate it. ActualArgs contains the formal
2111/// arguments for the function.
2112static bool EvaluateFunction(Function *F, Constant *&RetVal,
2113 const std::vector<Constant*> &ActualArgs,
2114 std::vector<Function*> &CallStack,
Chris Lattner4cd08c22008-12-16 07:34:30 +00002115 DenseMap<Constant*, Constant*> &MutatedMemory,
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002116 std::vector<GlobalVariable*> &AllocaTmps) {
2117 // Check to see if this function is already executing (recursion). If so,
2118 // bail out. TODO: we might want to accept limited recursion.
2119 if (std::find(CallStack.begin(), CallStack.end(), F) != CallStack.end())
2120 return false;
2121
2122 CallStack.push_back(F);
2123
2124 /// Values - As we compute SSA register values, we store their contents here.
Chris Lattner4cd08c22008-12-16 07:34:30 +00002125 DenseMap<Value*, Constant*> Values;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002126
2127 // Initialize arguments to the incoming values specified.
2128 unsigned ArgNo = 0;
2129 for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end(); AI != E;
2130 ++AI, ++ArgNo)
2131 Values[AI] = ActualArgs[ArgNo];
2132
2133 /// ExecutedBlocks - We only handle non-looping, non-recursive code. As such,
2134 /// we can only evaluate any one basic block at most once. This set keeps
2135 /// track of what we have executed so we can detect recursive cases etc.
Chris Lattner4cd08c22008-12-16 07:34:30 +00002136 SmallPtrSet<BasicBlock*, 32> ExecutedBlocks;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002137
2138 // CurInst - The current instruction we're evaluating.
2139 BasicBlock::iterator CurInst = F->begin()->begin();
2140
2141 // This is the main evaluation loop.
2142 while (1) {
2143 Constant *InstResult = 0;
2144
2145 if (StoreInst *SI = dyn_cast<StoreInst>(CurInst)) {
2146 if (SI->isVolatile()) return false; // no volatile accesses.
2147 Constant *Ptr = getVal(Values, SI->getOperand(1));
2148 if (!isSimpleEnoughPointerToCommit(Ptr))
2149 // If this is too complex for us to commit, reject it.
2150 return false;
2151 Constant *Val = getVal(Values, SI->getOperand(0));
2152 MutatedMemory[Ptr] = Val;
2153 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(CurInst)) {
2154 InstResult = ConstantExpr::get(BO->getOpcode(),
2155 getVal(Values, BO->getOperand(0)),
2156 getVal(Values, BO->getOperand(1)));
2157 } else if (CmpInst *CI = dyn_cast<CmpInst>(CurInst)) {
2158 InstResult = ConstantExpr::getCompare(CI->getPredicate(),
2159 getVal(Values, CI->getOperand(0)),
2160 getVal(Values, CI->getOperand(1)));
2161 } else if (CastInst *CI = dyn_cast<CastInst>(CurInst)) {
2162 InstResult = ConstantExpr::getCast(CI->getOpcode(),
2163 getVal(Values, CI->getOperand(0)),
2164 CI->getType());
2165 } else if (SelectInst *SI = dyn_cast<SelectInst>(CurInst)) {
2166 InstResult = ConstantExpr::getSelect(getVal(Values, SI->getOperand(0)),
2167 getVal(Values, SI->getOperand(1)),
2168 getVal(Values, SI->getOperand(2)));
2169 } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(CurInst)) {
2170 Constant *P = getVal(Values, GEP->getOperand(0));
2171 SmallVector<Constant*, 8> GEPOps;
Gabor Greif20f03f52008-05-29 01:59:18 +00002172 for (User::op_iterator i = GEP->op_begin() + 1, e = GEP->op_end();
2173 i != e; ++i)
2174 GEPOps.push_back(getVal(Values, *i));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002175 InstResult = ConstantExpr::getGetElementPtr(P, &GEPOps[0], GEPOps.size());
2176 } else if (LoadInst *LI = dyn_cast<LoadInst>(CurInst)) {
2177 if (LI->isVolatile()) return false; // no volatile accesses.
2178 InstResult = ComputeLoadResult(getVal(Values, LI->getOperand(0)),
2179 MutatedMemory);
2180 if (InstResult == 0) return false; // Could not evaluate load.
2181 } else if (AllocaInst *AI = dyn_cast<AllocaInst>(CurInst)) {
2182 if (AI->isArrayAllocation()) return false; // Cannot handle array allocs.
2183 const Type *Ty = AI->getType()->getElementType();
2184 AllocaTmps.push_back(new GlobalVariable(Ty, false,
2185 GlobalValue::InternalLinkage,
2186 UndefValue::get(Ty),
2187 AI->getName()));
2188 InstResult = AllocaTmps.back();
2189 } else if (CallInst *CI = dyn_cast<CallInst>(CurInst)) {
2190 // Cannot handle inline asm.
2191 if (isa<InlineAsm>(CI->getOperand(0))) return false;
2192
2193 // Resolve function pointers.
2194 Function *Callee = dyn_cast<Function>(getVal(Values, CI->getOperand(0)));
2195 if (!Callee) return false; // Cannot resolve.
2196
2197 std::vector<Constant*> Formals;
Gabor Greif20f03f52008-05-29 01:59:18 +00002198 for (User::op_iterator i = CI->op_begin() + 1, e = CI->op_end();
2199 i != e; ++i)
2200 Formals.push_back(getVal(Values, *i));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002201
2202 if (Callee->isDeclaration()) {
2203 // If this is a function we can constant fold, do it.
2204 if (Constant *C = ConstantFoldCall(Callee, &Formals[0],
2205 Formals.size())) {
2206 InstResult = C;
2207 } else {
2208 return false;
2209 }
2210 } else {
2211 if (Callee->getFunctionType()->isVarArg())
2212 return false;
2213
2214 Constant *RetVal;
2215
2216 // Execute the call, if successful, use the return value.
2217 if (!EvaluateFunction(Callee, RetVal, Formals, CallStack,
2218 MutatedMemory, AllocaTmps))
2219 return false;
2220 InstResult = RetVal;
2221 }
2222 } else if (isa<TerminatorInst>(CurInst)) {
2223 BasicBlock *NewBB = 0;
2224 if (BranchInst *BI = dyn_cast<BranchInst>(CurInst)) {
2225 if (BI->isUnconditional()) {
2226 NewBB = BI->getSuccessor(0);
2227 } else {
2228 ConstantInt *Cond =
2229 dyn_cast<ConstantInt>(getVal(Values, BI->getCondition()));
2230 if (!Cond) return false; // Cannot determine.
2231
2232 NewBB = BI->getSuccessor(!Cond->getZExtValue());
2233 }
2234 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(CurInst)) {
2235 ConstantInt *Val =
2236 dyn_cast<ConstantInt>(getVal(Values, SI->getCondition()));
2237 if (!Val) return false; // Cannot determine.
2238 NewBB = SI->getSuccessor(SI->findCaseValue(Val));
2239 } else if (ReturnInst *RI = dyn_cast<ReturnInst>(CurInst)) {
2240 if (RI->getNumOperands())
2241 RetVal = getVal(Values, RI->getOperand(0));
2242
2243 CallStack.pop_back(); // return from fn.
2244 return true; // We succeeded at evaluating this ctor!
2245 } else {
2246 // invoke, unwind, unreachable.
2247 return false; // Cannot handle this terminator.
2248 }
2249
2250 // Okay, we succeeded in evaluating this control flow. See if we have
2251 // executed the new block before. If so, we have a looping function,
2252 // which we cannot evaluate in reasonable time.
Chris Lattner4cd08c22008-12-16 07:34:30 +00002253 if (!ExecutedBlocks.insert(NewBB))
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002254 return false; // looped!
2255
2256 // Okay, we have never been in this block before. Check to see if there
2257 // are any PHI nodes. If so, evaluate them with information about where
2258 // we came from.
2259 BasicBlock *OldBB = CurInst->getParent();
2260 CurInst = NewBB->begin();
2261 PHINode *PN;
2262 for (; (PN = dyn_cast<PHINode>(CurInst)); ++CurInst)
2263 Values[PN] = getVal(Values, PN->getIncomingValueForBlock(OldBB));
2264
2265 // Do NOT increment CurInst. We know that the terminator had no value.
2266 continue;
2267 } else {
2268 // Did not know how to evaluate this!
2269 return false;
2270 }
2271
2272 if (!CurInst->use_empty())
2273 Values[CurInst] = InstResult;
2274
2275 // Advance program counter.
2276 ++CurInst;
2277 }
2278}
2279
2280/// EvaluateStaticConstructor - Evaluate static constructors in the function, if
2281/// we can. Return true if we can, false otherwise.
2282static bool EvaluateStaticConstructor(Function *F) {
2283 /// MutatedMemory - For each store we execute, we update this map. Loads
2284 /// check this to get the most up-to-date value. If evaluation is successful,
2285 /// this state is committed to the process.
Chris Lattner4cd08c22008-12-16 07:34:30 +00002286 DenseMap<Constant*, Constant*> MutatedMemory;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002287
2288 /// AllocaTmps - To 'execute' an alloca, we create a temporary global variable
2289 /// to represent its body. This vector is needed so we can delete the
2290 /// temporary globals when we are done.
2291 std::vector<GlobalVariable*> AllocaTmps;
2292
2293 /// CallStack - This is used to detect recursion. In pathological situations
2294 /// we could hit exponential behavior, but at least there is nothing
2295 /// unbounded.
2296 std::vector<Function*> CallStack;
2297
2298 // Call the function.
2299 Constant *RetValDummy;
2300 bool EvalSuccess = EvaluateFunction(F, RetValDummy, std::vector<Constant*>(),
2301 CallStack, MutatedMemory, AllocaTmps);
2302 if (EvalSuccess) {
2303 // We succeeded at evaluation: commit the result.
2304 DOUT << "FULLY EVALUATED GLOBAL CTOR FUNCTION '"
2305 << F->getName() << "' to " << MutatedMemory.size()
2306 << " stores.\n";
Chris Lattner4cd08c22008-12-16 07:34:30 +00002307 for (DenseMap<Constant*, Constant*>::iterator I = MutatedMemory.begin(),
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002308 E = MutatedMemory.end(); I != E; ++I)
2309 CommitValueTo(I->second, I->first);
2310 }
2311
2312 // At this point, we are done interpreting. If we created any 'alloca'
2313 // temporaries, release them now.
2314 while (!AllocaTmps.empty()) {
2315 GlobalVariable *Tmp = AllocaTmps.back();
2316 AllocaTmps.pop_back();
2317
2318 // If there are still users of the alloca, the program is doing something
2319 // silly, e.g. storing the address of the alloca somewhere and using it
2320 // later. Since this is undefined, we'll just make it be null.
2321 if (!Tmp->use_empty())
2322 Tmp->replaceAllUsesWith(Constant::getNullValue(Tmp->getType()));
2323 delete Tmp;
2324 }
2325
2326 return EvalSuccess;
2327}
2328
2329
2330
2331/// OptimizeGlobalCtorsList - Simplify and evaluation global ctors if possible.
2332/// Return true if anything changed.
2333bool GlobalOpt::OptimizeGlobalCtorsList(GlobalVariable *&GCL) {
2334 std::vector<Function*> Ctors = ParseGlobalCtors(GCL);
2335 bool MadeChange = false;
2336 if (Ctors.empty()) return false;
2337
2338 // Loop over global ctors, optimizing them when we can.
2339 for (unsigned i = 0; i != Ctors.size(); ++i) {
2340 Function *F = Ctors[i];
2341 // Found a null terminator in the middle of the list, prune off the rest of
2342 // the list.
2343 if (F == 0) {
2344 if (i != Ctors.size()-1) {
2345 Ctors.resize(i+1);
2346 MadeChange = true;
2347 }
2348 break;
2349 }
2350
2351 // We cannot simplify external ctor functions.
2352 if (F->empty()) continue;
2353
2354 // If we can evaluate the ctor at compile time, do.
2355 if (EvaluateStaticConstructor(F)) {
2356 Ctors.erase(Ctors.begin()+i);
2357 MadeChange = true;
2358 --i;
2359 ++NumCtorsEvaluated;
2360 continue;
2361 }
2362 }
2363
2364 if (!MadeChange) return false;
2365
2366 GCL = InstallGlobalCtors(GCL, Ctors);
2367 return true;
2368}
2369
Anton Korobeynikov76944bd2008-09-09 19:04:59 +00002370bool GlobalOpt::ResolveAliases(Module &M) {
2371 bool Changed = false;
2372
2373 for (Module::alias_iterator I = M.alias_begin(),
2374 E = M.alias_end(); I != E; ++I) {
2375 if (I->use_empty())
2376 continue;
2377
Anton Korobeynikovc7b90912008-09-09 20:05:04 +00002378 if (const GlobalValue *GV = I->resolveAliasedGlobal())
Anton Korobeynikov76944bd2008-09-09 19:04:59 +00002379 if (GV != I) {
2380 I->replaceAllUsesWith(const_cast<GlobalValue*>(GV));
2381 Changed = true;
2382 }
2383 }
2384
2385 return Changed;
2386}
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002387
2388bool GlobalOpt::runOnModule(Module &M) {
2389 bool Changed = false;
2390
2391 // Try to find the llvm.globalctors list.
2392 GlobalVariable *GlobalCtors = FindGlobalCtors(M);
2393
2394 bool LocalChange = true;
2395 while (LocalChange) {
2396 LocalChange = false;
2397
2398 // Delete functions that are trivially dead, ccc -> fastcc
2399 LocalChange |= OptimizeFunctions(M);
2400
2401 // Optimize global_ctors list.
2402 if (GlobalCtors)
2403 LocalChange |= OptimizeGlobalCtorsList(GlobalCtors);
2404
2405 // Optimize non-address-taken globals.
2406 LocalChange |= OptimizeGlobalVars(M);
Anton Korobeynikov76944bd2008-09-09 19:04:59 +00002407
2408 // Resolve aliases, when possible.
2409 LocalChange |= ResolveAliases(M);
2410 Changed |= LocalChange;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002411 }
2412
2413 // TODO: Move all global ctors functions to the end of the module for code
2414 // layout.
2415
2416 return Changed;
2417}