Re-commit r86077 now that r86290 fixes the 179.art and 175.vpr ARM regressions.
[oota-llvm.git] / lib / Transforms / IPO / GlobalOpt.cpp
1 //===- GlobalOpt.cpp - Optimize Global Variables --------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
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/Analysis/MemoryBuiltins.h"
27 #include "llvm/Target/TargetData.h"
28 #include "llvm/Support/CallSite.h"
29 #include "llvm/Support/Debug.h"
30 #include "llvm/Support/ErrorHandling.h"
31 #include "llvm/Support/GetElementPtrTypeIterator.h"
32 #include "llvm/Support/MathExtras.h"
33 #include "llvm/Support/raw_ostream.h"
34 #include "llvm/ADT/DenseMap.h"
35 #include "llvm/ADT/SmallPtrSet.h"
36 #include "llvm/ADT/SmallVector.h"
37 #include "llvm/ADT/Statistic.h"
38 #include "llvm/ADT/STLExtras.h"
39 #include <algorithm>
40 using namespace llvm;
41
42 STATISTIC(NumMarked    , "Number of globals marked constant");
43 STATISTIC(NumSRA       , "Number of aggregate globals broken into scalars");
44 STATISTIC(NumHeapSRA   , "Number of heap objects SRA'd");
45 STATISTIC(NumSubstitute,"Number of globals with initializers stored into them");
46 STATISTIC(NumDeleted   , "Number of globals deleted");
47 STATISTIC(NumFnDeleted , "Number of functions deleted");
48 STATISTIC(NumGlobUses  , "Number of global uses devirtualized");
49 STATISTIC(NumLocalized , "Number of globals localized");
50 STATISTIC(NumShrunkToBool  , "Number of global vars shrunk to booleans");
51 STATISTIC(NumFastCallFns   , "Number of functions converted to fastcc");
52 STATISTIC(NumCtorsEvaluated, "Number of static ctors evaluated");
53 STATISTIC(NumNestRemoved   , "Number of nest attributes removed");
54 STATISTIC(NumAliasesResolved, "Number of global aliases resolved");
55 STATISTIC(NumAliasesRemoved, "Number of global aliases eliminated");
56
57 namespace {
58   struct GlobalOpt : public ModulePass {
59     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
60     }
61     static char ID; // Pass identification, replacement for typeid
62     GlobalOpt() : ModulePass(&ID) {}
63
64     bool runOnModule(Module &M);
65
66   private:
67     GlobalVariable *FindGlobalCtors(Module &M);
68     bool OptimizeFunctions(Module &M);
69     bool OptimizeGlobalVars(Module &M);
70     bool OptimizeGlobalAliases(Module &M);
71     bool OptimizeGlobalCtorsList(GlobalVariable *&GCL);
72     bool ProcessInternalGlobal(GlobalVariable *GV,Module::global_iterator &GVI);
73   };
74 }
75
76 char GlobalOpt::ID = 0;
77 static RegisterPass<GlobalOpt> X("globalopt", "Global Variable Optimizer");
78
79 ModulePass *llvm::createGlobalOptimizerPass() { return new GlobalOpt(); }
80
81 namespace {
82
83 /// GlobalStatus - As we analyze each global, keep track of some information
84 /// about it.  If we find out that the address of the global is taken, none of
85 /// this info will be accurate.
86 struct GlobalStatus {
87   /// isLoaded - True if the global is ever loaded.  If the global isn't ever
88   /// loaded it can be deleted.
89   bool isLoaded;
90
91   /// StoredType - Keep track of what stores to the global look like.
92   ///
93   enum StoredType {
94     /// NotStored - There is no store to this global.  It can thus be marked
95     /// constant.
96     NotStored,
97
98     /// isInitializerStored - This global is stored to, but the only thing
99     /// stored is the constant it was initialized with.  This is only tracked
100     /// for scalar globals.
101     isInitializerStored,
102
103     /// isStoredOnce - This global is stored to, but only its initializer and
104     /// one other value is ever stored to it.  If this global isStoredOnce, we
105     /// track the value stored to it in StoredOnceValue below.  This is only
106     /// tracked for scalar globals.
107     isStoredOnce,
108
109     /// isStored - This global is stored to by multiple values or something else
110     /// that we cannot track.
111     isStored
112   } StoredType;
113
114   /// StoredOnceValue - If only one value (besides the initializer constant) is
115   /// ever stored to this global, keep track of what value it is.
116   Value *StoredOnceValue;
117
118   /// AccessingFunction/HasMultipleAccessingFunctions - These start out
119   /// null/false.  When the first accessing function is noticed, it is recorded.
120   /// When a second different accessing function is noticed,
121   /// HasMultipleAccessingFunctions is set to true.
122   Function *AccessingFunction;
123   bool HasMultipleAccessingFunctions;
124
125   /// HasNonInstructionUser - Set to true if this global has a user that is not
126   /// an instruction (e.g. a constant expr or GV initializer).
127   bool HasNonInstructionUser;
128
129   /// HasPHIUser - Set to true if this global has a user that is a PHI node.
130   bool HasPHIUser;
131   
132   GlobalStatus() : isLoaded(false), StoredType(NotStored), StoredOnceValue(0),
133                    AccessingFunction(0), HasMultipleAccessingFunctions(false),
134                    HasNonInstructionUser(false), HasPHIUser(false) {}
135 };
136
137 }
138
139 // SafeToDestroyConstant - It is safe to destroy a constant iff it is only used
140 // by constants itself.  Note that constants cannot be cyclic, so this test is
141 // pretty easy to implement recursively.
142 //
143 static bool SafeToDestroyConstant(Constant *C) {
144   if (isa<GlobalValue>(C)) return false;
145
146   for (Value::use_iterator UI = C->use_begin(), E = C->use_end(); UI != E; ++UI)
147     if (Constant *CU = dyn_cast<Constant>(*UI)) {
148       if (!SafeToDestroyConstant(CU)) return false;
149     } else
150       return false;
151   return true;
152 }
153
154
155 /// AnalyzeGlobal - Look at all uses of the global and fill in the GlobalStatus
156 /// structure.  If the global has its address taken, return true to indicate we
157 /// can't do anything with it.
158 ///
159 static bool AnalyzeGlobal(Value *V, GlobalStatus &GS,
160                           SmallPtrSet<PHINode*, 16> &PHIUsers) {
161   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
162     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(*UI)) {
163       GS.HasNonInstructionUser = true;
164
165       if (AnalyzeGlobal(CE, GS, PHIUsers)) return true;
166
167     } else if (Instruction *I = dyn_cast<Instruction>(*UI)) {
168       if (!GS.HasMultipleAccessingFunctions) {
169         Function *F = I->getParent()->getParent();
170         if (GS.AccessingFunction == 0)
171           GS.AccessingFunction = F;
172         else if (GS.AccessingFunction != F)
173           GS.HasMultipleAccessingFunctions = true;
174       }
175       if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
176         GS.isLoaded = true;
177         if (LI->isVolatile()) return true;  // Don't hack on volatile loads.
178       } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
179         // Don't allow a store OF the address, only stores TO the address.
180         if (SI->getOperand(0) == V) return true;
181
182         if (SI->isVolatile()) return true;  // Don't hack on volatile stores.
183
184         // If this is a direct store to the global (i.e., the global is a scalar
185         // value, not an aggregate), keep more specific information about
186         // stores.
187         if (GS.StoredType != GlobalStatus::isStored) {
188           if (GlobalVariable *GV = dyn_cast<GlobalVariable>(SI->getOperand(1))){
189             Value *StoredVal = SI->getOperand(0);
190             if (StoredVal == GV->getInitializer()) {
191               if (GS.StoredType < GlobalStatus::isInitializerStored)
192                 GS.StoredType = GlobalStatus::isInitializerStored;
193             } else if (isa<LoadInst>(StoredVal) &&
194                        cast<LoadInst>(StoredVal)->getOperand(0) == GV) {
195               // G = G
196               if (GS.StoredType < GlobalStatus::isInitializerStored)
197                 GS.StoredType = GlobalStatus::isInitializerStored;
198             } else if (GS.StoredType < GlobalStatus::isStoredOnce) {
199               GS.StoredType = GlobalStatus::isStoredOnce;
200               GS.StoredOnceValue = StoredVal;
201             } else if (GS.StoredType == GlobalStatus::isStoredOnce &&
202                        GS.StoredOnceValue == StoredVal) {
203               // noop.
204             } else {
205               GS.StoredType = GlobalStatus::isStored;
206             }
207           } else {
208             GS.StoredType = GlobalStatus::isStored;
209           }
210         }
211       } else if (isa<GetElementPtrInst>(I)) {
212         if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
213       } else if (isa<SelectInst>(I)) {
214         if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
215       } else if (PHINode *PN = dyn_cast<PHINode>(I)) {
216         // PHI nodes we can check just like select or GEP instructions, but we
217         // have to be careful about infinite recursion.
218         if (PHIUsers.insert(PN))  // Not already visited.
219           if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
220         GS.HasPHIUser = true;
221       } else if (isa<CmpInst>(I)) {
222       } else if (isa<MemTransferInst>(I)) {
223         if (I->getOperand(1) == V)
224           GS.StoredType = GlobalStatus::isStored;
225         if (I->getOperand(2) == V)
226           GS.isLoaded = true;
227       } else if (isa<MemSetInst>(I)) {
228         assert(I->getOperand(1) == V && "Memset only takes one pointer!");
229         GS.StoredType = GlobalStatus::isStored;
230       } else {
231         return true;  // Any other non-load instruction might take address!
232       }
233     } else if (Constant *C = dyn_cast<Constant>(*UI)) {
234       GS.HasNonInstructionUser = true;
235       // We might have a dead and dangling constant hanging off of here.
236       if (!SafeToDestroyConstant(C))
237         return true;
238     } else {
239       GS.HasNonInstructionUser = true;
240       // Otherwise must be some other user.
241       return true;
242     }
243
244   return false;
245 }
246
247 static Constant *getAggregateConstantElement(Constant *Agg, Constant *Idx) {
248   ConstantInt *CI = dyn_cast<ConstantInt>(Idx);
249   if (!CI) return 0;
250   unsigned IdxV = CI->getZExtValue();
251
252   if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Agg)) {
253     if (IdxV < CS->getNumOperands()) return CS->getOperand(IdxV);
254   } else if (ConstantArray *CA = dyn_cast<ConstantArray>(Agg)) {
255     if (IdxV < CA->getNumOperands()) return CA->getOperand(IdxV);
256   } else if (ConstantVector *CP = dyn_cast<ConstantVector>(Agg)) {
257     if (IdxV < CP->getNumOperands()) return CP->getOperand(IdxV);
258   } else if (isa<ConstantAggregateZero>(Agg)) {
259     if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
260       if (IdxV < STy->getNumElements())
261         return Constant::getNullValue(STy->getElementType(IdxV));
262     } else if (const SequentialType *STy =
263                dyn_cast<SequentialType>(Agg->getType())) {
264       return Constant::getNullValue(STy->getElementType());
265     }
266   } else if (isa<UndefValue>(Agg)) {
267     if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
268       if (IdxV < STy->getNumElements())
269         return UndefValue::get(STy->getElementType(IdxV));
270     } else if (const SequentialType *STy =
271                dyn_cast<SequentialType>(Agg->getType())) {
272       return UndefValue::get(STy->getElementType());
273     }
274   }
275   return 0;
276 }
277
278
279 /// CleanupConstantGlobalUsers - We just marked GV constant.  Loop over all
280 /// users of the global, cleaning up the obvious ones.  This is largely just a
281 /// quick scan over the use list to clean up the easy and obvious cruft.  This
282 /// returns true if it made a change.
283 static bool CleanupConstantGlobalUsers(Value *V, Constant *Init) {
284   bool Changed = false;
285   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;) {
286     User *U = *UI++;
287
288     if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
289       if (Init) {
290         // Replace the load with the initializer.
291         LI->replaceAllUsesWith(Init);
292         LI->eraseFromParent();
293         Changed = true;
294       }
295     } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
296       // Store must be unreachable or storing Init into the global.
297       SI->eraseFromParent();
298       Changed = true;
299     } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
300       if (CE->getOpcode() == Instruction::GetElementPtr) {
301         Constant *SubInit = 0;
302         if (Init)
303           SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
304         Changed |= CleanupConstantGlobalUsers(CE, SubInit);
305       } else if (CE->getOpcode() == Instruction::BitCast && 
306                  isa<PointerType>(CE->getType())) {
307         // Pointer cast, delete any stores and memsets to the global.
308         Changed |= CleanupConstantGlobalUsers(CE, 0);
309       }
310
311       if (CE->use_empty()) {
312         CE->destroyConstant();
313         Changed = true;
314       }
315     } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
316       // Do not transform "gepinst (gep constexpr (GV))" here, because forming
317       // "gepconstexpr (gep constexpr (GV))" will cause the two gep's to fold
318       // and will invalidate our notion of what Init is.
319       Constant *SubInit = 0;
320       if (!isa<ConstantExpr>(GEP->getOperand(0))) {
321         ConstantExpr *CE = 
322           dyn_cast_or_null<ConstantExpr>(ConstantFoldInstruction(GEP));
323         if (Init && CE && CE->getOpcode() == Instruction::GetElementPtr)
324           SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
325       }
326       Changed |= CleanupConstantGlobalUsers(GEP, SubInit);
327
328       if (GEP->use_empty()) {
329         GEP->eraseFromParent();
330         Changed = true;
331       }
332     } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(U)) { // memset/cpy/mv
333       if (MI->getRawDest() == V) {
334         MI->eraseFromParent();
335         Changed = true;
336       }
337
338     } else if (Constant *C = dyn_cast<Constant>(U)) {
339       // If we have a chain of dead constantexprs or other things dangling from
340       // us, and if they are all dead, nuke them without remorse.
341       if (SafeToDestroyConstant(C)) {
342         C->destroyConstant();
343         // This could have invalidated UI, start over from scratch.
344         CleanupConstantGlobalUsers(V, Init);
345         return true;
346       }
347     }
348   }
349   return Changed;
350 }
351
352 /// isSafeSROAElementUse - Return true if the specified instruction is a safe
353 /// user of a derived expression from a global that we want to SROA.
354 static bool isSafeSROAElementUse(Value *V) {
355   // We might have a dead and dangling constant hanging off of here.
356   if (Constant *C = dyn_cast<Constant>(V))
357     return SafeToDestroyConstant(C);
358   
359   Instruction *I = dyn_cast<Instruction>(V);
360   if (!I) return false;
361
362   // Loads are ok.
363   if (isa<LoadInst>(I)) return true;
364
365   // Stores *to* the pointer are ok.
366   if (StoreInst *SI = dyn_cast<StoreInst>(I))
367     return SI->getOperand(0) != V;
368     
369   // Otherwise, it must be a GEP.
370   GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I);
371   if (GEPI == 0) return false;
372   
373   if (GEPI->getNumOperands() < 3 || !isa<Constant>(GEPI->getOperand(1)) ||
374       !cast<Constant>(GEPI->getOperand(1))->isNullValue())
375     return false;
376   
377   for (Value::use_iterator I = GEPI->use_begin(), E = GEPI->use_end();
378        I != E; ++I)
379     if (!isSafeSROAElementUse(*I))
380       return false;
381   return true;
382 }
383
384
385 /// IsUserOfGlobalSafeForSRA - U is a direct user of the specified global value.
386 /// Look at it and its uses and decide whether it is safe to SROA this global.
387 ///
388 static bool IsUserOfGlobalSafeForSRA(User *U, GlobalValue *GV) {
389   // The user of the global must be a GEP Inst or a ConstantExpr GEP.
390   if (!isa<GetElementPtrInst>(U) && 
391       (!isa<ConstantExpr>(U) || 
392        cast<ConstantExpr>(U)->getOpcode() != Instruction::GetElementPtr))
393     return false;
394   
395   // Check to see if this ConstantExpr GEP is SRA'able.  In particular, we
396   // don't like < 3 operand CE's, and we don't like non-constant integer
397   // indices.  This enforces that all uses are 'gep GV, 0, C, ...' for some
398   // value of C.
399   if (U->getNumOperands() < 3 || !isa<Constant>(U->getOperand(1)) ||
400       !cast<Constant>(U->getOperand(1))->isNullValue() ||
401       !isa<ConstantInt>(U->getOperand(2)))
402     return false;
403
404   gep_type_iterator GEPI = gep_type_begin(U), E = gep_type_end(U);
405   ++GEPI;  // Skip over the pointer index.
406   
407   // If this is a use of an array allocation, do a bit more checking for sanity.
408   if (const ArrayType *AT = dyn_cast<ArrayType>(*GEPI)) {
409     uint64_t NumElements = AT->getNumElements();
410     ConstantInt *Idx = cast<ConstantInt>(U->getOperand(2));
411     
412     // Check to make sure that index falls within the array.  If not,
413     // something funny is going on, so we won't do the optimization.
414     //
415     if (Idx->getZExtValue() >= NumElements)
416       return false;
417       
418     // We cannot scalar repl this level of the array unless any array
419     // sub-indices are in-range constants.  In particular, consider:
420     // A[0][i].  We cannot know that the user isn't doing invalid things like
421     // allowing i to index an out-of-range subscript that accesses A[1].
422     //
423     // Scalar replacing *just* the outer index of the array is probably not
424     // going to be a win anyway, so just give up.
425     for (++GEPI; // Skip array index.
426          GEPI != E;
427          ++GEPI) {
428       uint64_t NumElements;
429       if (const ArrayType *SubArrayTy = dyn_cast<ArrayType>(*GEPI))
430         NumElements = SubArrayTy->getNumElements();
431       else if (const VectorType *SubVectorTy = dyn_cast<VectorType>(*GEPI))
432         NumElements = SubVectorTy->getNumElements();
433       else {
434         assert(isa<StructType>(*GEPI) &&
435                "Indexed GEP type is not array, vector, or struct!");
436         continue;
437       }
438       
439       ConstantInt *IdxVal = dyn_cast<ConstantInt>(GEPI.getOperand());
440       if (!IdxVal || IdxVal->getZExtValue() >= NumElements)
441         return false;
442     }
443   }
444
445   for (Value::use_iterator I = U->use_begin(), E = U->use_end(); I != E; ++I)
446     if (!isSafeSROAElementUse(*I))
447       return false;
448   return true;
449 }
450
451 /// GlobalUsersSafeToSRA - Look at all uses of the global and decide whether it
452 /// is safe for us to perform this transformation.
453 ///
454 static bool GlobalUsersSafeToSRA(GlobalValue *GV) {
455   for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end();
456        UI != E; ++UI) {
457     if (!IsUserOfGlobalSafeForSRA(*UI, GV))
458       return false;
459   }
460   return true;
461 }
462  
463
464 /// SRAGlobal - Perform scalar replacement of aggregates on the specified global
465 /// variable.  This opens the door for other optimizations by exposing the
466 /// behavior of the program in a more fine-grained way.  We have determined that
467 /// this transformation is safe already.  We return the first global variable we
468 /// insert so that the caller can reprocess it.
469 static GlobalVariable *SRAGlobal(GlobalVariable *GV, const TargetData &TD) {
470   // Make sure this global only has simple uses that we can SRA.
471   if (!GlobalUsersSafeToSRA(GV))
472     return 0;
473   
474   assert(GV->hasLocalLinkage() && !GV->isConstant());
475   Constant *Init = GV->getInitializer();
476   const Type *Ty = Init->getType();
477
478   std::vector<GlobalVariable*> NewGlobals;
479   Module::GlobalListType &Globals = GV->getParent()->getGlobalList();
480
481   // Get the alignment of the global, either explicit or target-specific.
482   unsigned StartAlignment = GV->getAlignment();
483   if (StartAlignment == 0)
484     StartAlignment = TD.getABITypeAlignment(GV->getType());
485    
486   if (const StructType *STy = dyn_cast<StructType>(Ty)) {
487     NewGlobals.reserve(STy->getNumElements());
488     const StructLayout &Layout = *TD.getStructLayout(STy);
489     for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
490       Constant *In = getAggregateConstantElement(Init,
491                     ConstantInt::get(Type::getInt32Ty(STy->getContext()), i));
492       assert(In && "Couldn't get element of initializer?");
493       GlobalVariable *NGV = new GlobalVariable(STy->getElementType(i), false,
494                                                GlobalVariable::InternalLinkage,
495                                                In, GV->getName()+"."+Twine(i),
496                                                GV->isThreadLocal(),
497                                               GV->getType()->getAddressSpace());
498       Globals.insert(GV, NGV);
499       NewGlobals.push_back(NGV);
500       
501       // Calculate the known alignment of the field.  If the original aggregate
502       // had 256 byte alignment for example, something might depend on that:
503       // propagate info to each field.
504       uint64_t FieldOffset = Layout.getElementOffset(i);
505       unsigned NewAlign = (unsigned)MinAlign(StartAlignment, FieldOffset);
506       if (NewAlign > TD.getABITypeAlignment(STy->getElementType(i)))
507         NGV->setAlignment(NewAlign);
508     }
509   } else if (const SequentialType *STy = dyn_cast<SequentialType>(Ty)) {
510     unsigned NumElements = 0;
511     if (const ArrayType *ATy = dyn_cast<ArrayType>(STy))
512       NumElements = ATy->getNumElements();
513     else
514       NumElements = cast<VectorType>(STy)->getNumElements();
515
516     if (NumElements > 16 && GV->hasNUsesOrMore(16))
517       return 0; // It's not worth it.
518     NewGlobals.reserve(NumElements);
519     
520     uint64_t EltSize = TD.getTypeAllocSize(STy->getElementType());
521     unsigned EltAlign = TD.getABITypeAlignment(STy->getElementType());
522     for (unsigned i = 0, e = NumElements; i != e; ++i) {
523       Constant *In = getAggregateConstantElement(Init,
524                     ConstantInt::get(Type::getInt32Ty(Init->getContext()), i));
525       assert(In && "Couldn't get element of initializer?");
526
527       GlobalVariable *NGV = new GlobalVariable(STy->getElementType(), false,
528                                                GlobalVariable::InternalLinkage,
529                                                In, GV->getName()+"."+Twine(i),
530                                                GV->isThreadLocal(),
531                                               GV->getType()->getAddressSpace());
532       Globals.insert(GV, NGV);
533       NewGlobals.push_back(NGV);
534       
535       // Calculate the known alignment of the field.  If the original aggregate
536       // had 256 byte alignment for example, something might depend on that:
537       // propagate info to each field.
538       unsigned NewAlign = (unsigned)MinAlign(StartAlignment, EltSize*i);
539       if (NewAlign > EltAlign)
540         NGV->setAlignment(NewAlign);
541     }
542   }
543
544   if (NewGlobals.empty())
545     return 0;
546
547   DEBUG(errs() << "PERFORMING GLOBAL SRA ON: " << *GV);
548
549   Constant *NullInt =Constant::getNullValue(Type::getInt32Ty(GV->getContext()));
550
551   // Loop over all of the uses of the global, replacing the constantexpr geps,
552   // with smaller constantexpr geps or direct references.
553   while (!GV->use_empty()) {
554     User *GEP = GV->use_back();
555     assert(((isa<ConstantExpr>(GEP) &&
556              cast<ConstantExpr>(GEP)->getOpcode()==Instruction::GetElementPtr)||
557             isa<GetElementPtrInst>(GEP)) && "NonGEP CE's are not SRAable!");
558
559     // Ignore the 1th operand, which has to be zero or else the program is quite
560     // broken (undefined).  Get the 2nd operand, which is the structure or array
561     // index.
562     unsigned Val = cast<ConstantInt>(GEP->getOperand(2))->getZExtValue();
563     if (Val >= NewGlobals.size()) Val = 0; // Out of bound array access.
564
565     Value *NewPtr = NewGlobals[Val];
566
567     // Form a shorter GEP if needed.
568     if (GEP->getNumOperands() > 3) {
569       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEP)) {
570         SmallVector<Constant*, 8> Idxs;
571         Idxs.push_back(NullInt);
572         for (unsigned i = 3, e = CE->getNumOperands(); i != e; ++i)
573           Idxs.push_back(CE->getOperand(i));
574         NewPtr = ConstantExpr::getGetElementPtr(cast<Constant>(NewPtr),
575                                                 &Idxs[0], Idxs.size());
576       } else {
577         GetElementPtrInst *GEPI = cast<GetElementPtrInst>(GEP);
578         SmallVector<Value*, 8> Idxs;
579         Idxs.push_back(NullInt);
580         for (unsigned i = 3, e = GEPI->getNumOperands(); i != e; ++i)
581           Idxs.push_back(GEPI->getOperand(i));
582         NewPtr = GetElementPtrInst::Create(NewPtr, Idxs.begin(), Idxs.end(),
583                                            GEPI->getName()+"."+Twine(Val),GEPI);
584       }
585     }
586     GEP->replaceAllUsesWith(NewPtr);
587
588     if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(GEP))
589       GEPI->eraseFromParent();
590     else
591       cast<ConstantExpr>(GEP)->destroyConstant();
592   }
593
594   // Delete the old global, now that it is dead.
595   Globals.erase(GV);
596   ++NumSRA;
597
598   // Loop over the new globals array deleting any globals that are obviously
599   // dead.  This can arise due to scalarization of a structure or an array that
600   // has elements that are dead.
601   unsigned FirstGlobal = 0;
602   for (unsigned i = 0, e = NewGlobals.size(); i != e; ++i)
603     if (NewGlobals[i]->use_empty()) {
604       Globals.erase(NewGlobals[i]);
605       if (FirstGlobal == i) ++FirstGlobal;
606     }
607
608   return FirstGlobal != NewGlobals.size() ? NewGlobals[FirstGlobal] : 0;
609 }
610
611 /// AllUsesOfValueWillTrapIfNull - Return true if all users of the specified
612 /// value will trap if the value is dynamically null.  PHIs keeps track of any 
613 /// phi nodes we've seen to avoid reprocessing them.
614 static bool AllUsesOfValueWillTrapIfNull(Value *V,
615                                          SmallPtrSet<PHINode*, 8> &PHIs) {
616   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
617     if (isa<LoadInst>(*UI)) {
618       // Will trap.
619     } else if (StoreInst *SI = dyn_cast<StoreInst>(*UI)) {
620       if (SI->getOperand(0) == V) {
621         //cerr << "NONTRAPPING USE: " << **UI;
622         return false;  // Storing the value.
623       }
624     } else if (CallInst *CI = dyn_cast<CallInst>(*UI)) {
625       if (CI->getOperand(0) != V) {
626         //cerr << "NONTRAPPING USE: " << **UI;
627         return false;  // Not calling the ptr
628       }
629     } else if (InvokeInst *II = dyn_cast<InvokeInst>(*UI)) {
630       if (II->getOperand(0) != V) {
631         //cerr << "NONTRAPPING USE: " << **UI;
632         return false;  // Not calling the ptr
633       }
634     } else if (BitCastInst *CI = dyn_cast<BitCastInst>(*UI)) {
635       if (!AllUsesOfValueWillTrapIfNull(CI, PHIs)) return false;
636     } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(*UI)) {
637       if (!AllUsesOfValueWillTrapIfNull(GEPI, PHIs)) return false;
638     } else if (PHINode *PN = dyn_cast<PHINode>(*UI)) {
639       // If we've already seen this phi node, ignore it, it has already been
640       // checked.
641       if (PHIs.insert(PN))
642         return AllUsesOfValueWillTrapIfNull(PN, PHIs);
643     } else if (isa<ICmpInst>(*UI) &&
644                isa<ConstantPointerNull>(UI->getOperand(1))) {
645       // Ignore setcc X, null
646     } else {
647       //cerr << "NONTRAPPING USE: " << **UI;
648       return false;
649     }
650   return true;
651 }
652
653 /// AllUsesOfLoadedValueWillTrapIfNull - Return true if all uses of any loads
654 /// from GV will trap if the loaded value is null.  Note that this also permits
655 /// comparisons of the loaded value against null, as a special case.
656 static bool AllUsesOfLoadedValueWillTrapIfNull(GlobalVariable *GV) {
657   for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI!=E; ++UI)
658     if (LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
659       SmallPtrSet<PHINode*, 8> PHIs;
660       if (!AllUsesOfValueWillTrapIfNull(LI, PHIs))
661         return false;
662     } else if (isa<StoreInst>(*UI)) {
663       // Ignore stores to the global.
664     } else {
665       // We don't know or understand this user, bail out.
666       //cerr << "UNKNOWN USER OF GLOBAL!: " << **UI;
667       return false;
668     }
669
670   return true;
671 }
672
673 static bool OptimizeAwayTrappingUsesOfValue(Value *V, Constant *NewV) {
674   bool Changed = false;
675   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ) {
676     Instruction *I = cast<Instruction>(*UI++);
677     if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
678       LI->setOperand(0, NewV);
679       Changed = true;
680     } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
681       if (SI->getOperand(1) == V) {
682         SI->setOperand(1, NewV);
683         Changed = true;
684       }
685     } else if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
686       if (I->getOperand(0) == V) {
687         // Calling through the pointer!  Turn into a direct call, but be careful
688         // that the pointer is not also being passed as an argument.
689         I->setOperand(0, NewV);
690         Changed = true;
691         bool PassedAsArg = false;
692         for (unsigned i = 1, e = I->getNumOperands(); i != e; ++i)
693           if (I->getOperand(i) == V) {
694             PassedAsArg = true;
695             I->setOperand(i, NewV);
696           }
697
698         if (PassedAsArg) {
699           // Being passed as an argument also.  Be careful to not invalidate UI!
700           UI = V->use_begin();
701         }
702       }
703     } else if (CastInst *CI = dyn_cast<CastInst>(I)) {
704       Changed |= OptimizeAwayTrappingUsesOfValue(CI,
705                                 ConstantExpr::getCast(CI->getOpcode(),
706                                                       NewV, CI->getType()));
707       if (CI->use_empty()) {
708         Changed = true;
709         CI->eraseFromParent();
710       }
711     } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
712       // Should handle GEP here.
713       SmallVector<Constant*, 8> Idxs;
714       Idxs.reserve(GEPI->getNumOperands()-1);
715       for (User::op_iterator i = GEPI->op_begin() + 1, e = GEPI->op_end();
716            i != e; ++i)
717         if (Constant *C = dyn_cast<Constant>(*i))
718           Idxs.push_back(C);
719         else
720           break;
721       if (Idxs.size() == GEPI->getNumOperands()-1)
722         Changed |= OptimizeAwayTrappingUsesOfValue(GEPI,
723                           ConstantExpr::getGetElementPtr(NewV, &Idxs[0],
724                                                         Idxs.size()));
725       if (GEPI->use_empty()) {
726         Changed = true;
727         GEPI->eraseFromParent();
728       }
729     }
730   }
731
732   return Changed;
733 }
734
735
736 /// OptimizeAwayTrappingUsesOfLoads - The specified global has only one non-null
737 /// value stored into it.  If there are uses of the loaded value that would trap
738 /// if the loaded value is dynamically null, then we know that they cannot be
739 /// reachable with a null optimize away the load.
740 static bool OptimizeAwayTrappingUsesOfLoads(GlobalVariable *GV, Constant *LV) {
741   bool Changed = false;
742
743   // Keep track of whether we are able to remove all the uses of the global
744   // other than the store that defines it.
745   bool AllNonStoreUsesGone = true;
746   
747   // Replace all uses of loads with uses of uses of the stored value.
748   for (Value::use_iterator GUI = GV->use_begin(), E = GV->use_end(); GUI != E;){
749     User *GlobalUser = *GUI++;
750     if (LoadInst *LI = dyn_cast<LoadInst>(GlobalUser)) {
751       Changed |= OptimizeAwayTrappingUsesOfValue(LI, LV);
752       // If we were able to delete all uses of the loads
753       if (LI->use_empty()) {
754         LI->eraseFromParent();
755         Changed = true;
756       } else {
757         AllNonStoreUsesGone = false;
758       }
759     } else if (isa<StoreInst>(GlobalUser)) {
760       // Ignore the store that stores "LV" to the global.
761       assert(GlobalUser->getOperand(1) == GV &&
762              "Must be storing *to* the global");
763     } else {
764       AllNonStoreUsesGone = false;
765
766       // If we get here we could have other crazy uses that are transitively
767       // loaded.
768       assert((isa<PHINode>(GlobalUser) || isa<SelectInst>(GlobalUser) ||
769               isa<ConstantExpr>(GlobalUser)) && "Only expect load and stores!");
770     }
771   }
772
773   if (Changed) {
774     DEBUG(errs() << "OPTIMIZED LOADS FROM STORED ONCE POINTER: " << *GV);
775     ++NumGlobUses;
776   }
777
778   // If we nuked all of the loads, then none of the stores are needed either,
779   // nor is the global.
780   if (AllNonStoreUsesGone) {
781     DEBUG(errs() << "  *** GLOBAL NOW DEAD!\n");
782     CleanupConstantGlobalUsers(GV, 0);
783     if (GV->use_empty()) {
784       GV->eraseFromParent();
785       ++NumDeleted;
786     }
787     Changed = true;
788   }
789   return Changed;
790 }
791
792 /// ConstantPropUsersOf - Walk the use list of V, constant folding all of the
793 /// instructions that are foldable.
794 static void ConstantPropUsersOf(Value *V) {
795   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; )
796     if (Instruction *I = dyn_cast<Instruction>(*UI++))
797       if (Constant *NewC = ConstantFoldInstruction(I)) {
798         I->replaceAllUsesWith(NewC);
799
800         // Advance UI to the next non-I use to avoid invalidating it!
801         // Instructions could multiply use V.
802         while (UI != E && *UI == I)
803           ++UI;
804         I->eraseFromParent();
805       }
806 }
807
808 /// OptimizeGlobalAddressOfMalloc - This function takes the specified global
809 /// variable, and transforms the program as if it always contained the result of
810 /// the specified malloc.  Because it is always the result of the specified
811 /// malloc, there is no reason to actually DO the malloc.  Instead, turn the
812 /// malloc into a global, and any loads of GV as uses of the new global.
813 static GlobalVariable *OptimizeGlobalAddressOfMalloc(GlobalVariable *GV,
814                                                      CallInst *CI,
815                                                      const Type *AllocTy,
816                                                      Value* NElems,
817                                                      TargetData* TD) {
818   DEBUG(errs() << "PROMOTING GLOBAL: " << *GV << "  CALL = " << *CI << '\n');
819
820   const Type *IntPtrTy = TD->getIntPtrType(GV->getContext());
821   
822   // CI has either 0 or 1 bitcast uses (getMallocType() would otherwise have
823   // returned NULL and we would not be here).
824   BitCastInst *BCI = NULL;
825   for (Value::use_iterator UI = CI->use_begin(), E = CI->use_end(); UI != E; )
826     if ((BCI = dyn_cast<BitCastInst>(cast<Instruction>(*UI++))))
827       break;
828
829   ConstantInt *NElements = cast<ConstantInt>(NElems);
830   if (NElements->getZExtValue() != 1) {
831     // If we have an array allocation, transform it to a single element
832     // allocation to make the code below simpler.
833     Type *NewTy = ArrayType::get(AllocTy, NElements->getZExtValue());
834     unsigned TypeSize = TD->getTypeAllocSize(NewTy);
835     if (const StructType *ST = dyn_cast<StructType>(NewTy))
836       TypeSize = TD->getStructLayout(ST)->getSizeInBytes();
837     Instruction *NewCI = CallInst::CreateMalloc(CI, IntPtrTy, NewTy,
838                                          ConstantInt::get(IntPtrTy, TypeSize));
839     Value* Indices[2];
840     Indices[0] = Indices[1] = Constant::getNullValue(IntPtrTy);
841     Value *NewGEP = GetElementPtrInst::Create(NewCI, Indices, Indices + 2,
842                                               NewCI->getName()+".el0", CI);
843     Value *Cast = new BitCastInst(NewGEP, CI->getType(), "el0", CI);
844     if (BCI) BCI->replaceAllUsesWith(NewGEP);
845     CI->replaceAllUsesWith(Cast);
846     if (BCI) BCI->eraseFromParent();
847     CI->eraseFromParent();
848     BCI = dyn_cast<BitCastInst>(NewCI);
849     CI = BCI ? extractMallocCallFromBitCast(BCI) : cast<CallInst>(NewCI);
850   }
851
852   // Create the new global variable.  The contents of the malloc'd memory is
853   // undefined, so initialize with an undef value.
854   const Type *MAT = getMallocAllocatedType(CI);
855   Constant *Init = UndefValue::get(MAT);
856   GlobalVariable *NewGV = new GlobalVariable(*GV->getParent(), 
857                                              MAT, false,
858                                              GlobalValue::InternalLinkage, Init,
859                                              GV->getName()+".body",
860                                              GV,
861                                              GV->isThreadLocal());
862   
863   // Anything that used the malloc or its bitcast now uses the global directly.
864   if (BCI) BCI->replaceAllUsesWith(NewGV);
865   CI->replaceAllUsesWith(new BitCastInst(NewGV, CI->getType(), "newgv", CI));
866
867   Constant *RepValue = NewGV;
868   if (NewGV->getType() != GV->getType()->getElementType())
869     RepValue = ConstantExpr::getBitCast(RepValue, 
870                                         GV->getType()->getElementType());
871
872   // If there is a comparison against null, we will insert a global bool to
873   // keep track of whether the global was initialized yet or not.
874   GlobalVariable *InitBool =
875     new GlobalVariable(Type::getInt1Ty(GV->getContext()), false,
876                        GlobalValue::InternalLinkage,
877                        ConstantInt::getFalse(GV->getContext()),
878                        GV->getName()+".init", GV->isThreadLocal());
879   bool InitBoolUsed = false;
880
881   // Loop over all uses of GV, processing them in turn.
882   std::vector<StoreInst*> Stores;
883   while (!GV->use_empty())
884     if (LoadInst *LI = dyn_cast<LoadInst>(GV->use_back())) {
885       while (!LI->use_empty()) {
886         Use &LoadUse = LI->use_begin().getUse();
887         if (!isa<ICmpInst>(LoadUse.getUser()))
888           LoadUse = RepValue;
889         else {
890           ICmpInst *ICI = cast<ICmpInst>(LoadUse.getUser());
891           // Replace the cmp X, 0 with a use of the bool value.
892           Value *LV = new LoadInst(InitBool, InitBool->getName()+".val", ICI);
893           InitBoolUsed = true;
894           switch (ICI->getPredicate()) {
895           default: llvm_unreachable("Unknown ICmp Predicate!");
896           case ICmpInst::ICMP_ULT:
897           case ICmpInst::ICMP_SLT:   // X < null -> always false
898             LV = ConstantInt::getFalse(GV->getContext());
899             break;
900           case ICmpInst::ICMP_ULE:
901           case ICmpInst::ICMP_SLE:
902           case ICmpInst::ICMP_EQ:
903             LV = BinaryOperator::CreateNot(LV, "notinit", ICI);
904             break;
905           case ICmpInst::ICMP_NE:
906           case ICmpInst::ICMP_UGE:
907           case ICmpInst::ICMP_SGE:
908           case ICmpInst::ICMP_UGT:
909           case ICmpInst::ICMP_SGT:
910             break;  // no change.
911           }
912           ICI->replaceAllUsesWith(LV);
913           ICI->eraseFromParent();
914         }
915       }
916       LI->eraseFromParent();
917     } else {
918       StoreInst *SI = cast<StoreInst>(GV->use_back());
919       // The global is initialized when the store to it occurs.
920       new StoreInst(ConstantInt::getTrue(GV->getContext()), InitBool, SI);
921       SI->eraseFromParent();
922     }
923
924   // If the initialization boolean was used, insert it, otherwise delete it.
925   if (!InitBoolUsed) {
926     while (!InitBool->use_empty())  // Delete initializations
927       cast<Instruction>(InitBool->use_back())->eraseFromParent();
928     delete InitBool;
929   } else
930     GV->getParent()->getGlobalList().insert(GV, InitBool);
931
932
933   // Now the GV is dead, nuke it and the malloc (both CI and BCI).
934   GV->eraseFromParent();
935   if (BCI) BCI->eraseFromParent();
936   CI->eraseFromParent();
937
938   // To further other optimizations, loop over all users of NewGV and try to
939   // constant prop them.  This will promote GEP instructions with constant
940   // indices into GEP constant-exprs, which will allow global-opt to hack on it.
941   ConstantPropUsersOf(NewGV);
942   if (RepValue != NewGV)
943     ConstantPropUsersOf(RepValue);
944
945   return NewGV;
946 }
947
948 /// ValueIsOnlyUsedLocallyOrStoredToOneGlobal - Scan the use-list of V checking
949 /// to make sure that there are no complex uses of V.  We permit simple things
950 /// like dereferencing the pointer, but not storing through the address, unless
951 /// it is to the specified global.
952 static bool ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Instruction *V,
953                                                       GlobalVariable *GV,
954                                               SmallPtrSet<PHINode*, 8> &PHIs) {
955   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
956     Instruction *Inst = cast<Instruction>(*UI);
957     
958     if (isa<LoadInst>(Inst) || isa<CmpInst>(Inst)) {
959       continue; // Fine, ignore.
960     }
961     
962     if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
963       if (SI->getOperand(0) == V && SI->getOperand(1) != GV)
964         return false;  // Storing the pointer itself... bad.
965       continue; // Otherwise, storing through it, or storing into GV... fine.
966     }
967     
968     if (isa<GetElementPtrInst>(Inst)) {
969       if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Inst, GV, PHIs))
970         return false;
971       continue;
972     }
973     
974     if (PHINode *PN = dyn_cast<PHINode>(Inst)) {
975       // PHIs are ok if all uses are ok.  Don't infinitely recurse through PHI
976       // cycles.
977       if (PHIs.insert(PN))
978         if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(PN, GV, PHIs))
979           return false;
980       continue;
981     }
982     
983     if (BitCastInst *BCI = dyn_cast<BitCastInst>(Inst)) {
984       if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(BCI, GV, PHIs))
985         return false;
986       continue;
987     }
988     
989     return false;
990   }
991   return true;
992 }
993
994 /// ReplaceUsesOfMallocWithGlobal - The Alloc pointer is stored into GV
995 /// somewhere.  Transform all uses of the allocation into loads from the
996 /// global and uses of the resultant pointer.  Further, delete the store into
997 /// GV.  This assumes that these value pass the 
998 /// 'ValueIsOnlyUsedLocallyOrStoredToOneGlobal' predicate.
999 static void ReplaceUsesOfMallocWithGlobal(Instruction *Alloc, 
1000                                           GlobalVariable *GV) {
1001   while (!Alloc->use_empty()) {
1002     Instruction *U = cast<Instruction>(*Alloc->use_begin());
1003     Instruction *InsertPt = U;
1004     if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
1005       // If this is the store of the allocation into the global, remove it.
1006       if (SI->getOperand(1) == GV) {
1007         SI->eraseFromParent();
1008         continue;
1009       }
1010     } else if (PHINode *PN = dyn_cast<PHINode>(U)) {
1011       // Insert the load in the corresponding predecessor, not right before the
1012       // PHI.
1013       InsertPt = PN->getIncomingBlock(Alloc->use_begin())->getTerminator();
1014     } else if (isa<BitCastInst>(U)) {
1015       // Must be bitcast between the malloc and store to initialize the global.
1016       ReplaceUsesOfMallocWithGlobal(U, GV);
1017       U->eraseFromParent();
1018       continue;
1019     } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(U)) {
1020       // If this is a "GEP bitcast" and the user is a store to the global, then
1021       // just process it as a bitcast.
1022       if (GEPI->hasAllZeroIndices() && GEPI->hasOneUse())
1023         if (StoreInst *SI = dyn_cast<StoreInst>(GEPI->use_back()))
1024           if (SI->getOperand(1) == GV) {
1025             // Must be bitcast GEP between the malloc and store to initialize
1026             // the global.
1027             ReplaceUsesOfMallocWithGlobal(GEPI, GV);
1028             GEPI->eraseFromParent();
1029             continue;
1030           }
1031     }
1032       
1033     // Insert a load from the global, and use it instead of the malloc.
1034     Value *NL = new LoadInst(GV, GV->getName()+".val", InsertPt);
1035     U->replaceUsesOfWith(Alloc, NL);
1036   }
1037 }
1038
1039 /// LoadUsesSimpleEnoughForHeapSRA - Verify that all uses of V (a load, or a phi
1040 /// of a load) are simple enough to perform heap SRA on.  This permits GEP's
1041 /// that index through the array and struct field, icmps of null, and PHIs.
1042 static bool LoadUsesSimpleEnoughForHeapSRA(Value *V,
1043                               SmallPtrSet<PHINode*, 32> &LoadUsingPHIs,
1044                               SmallPtrSet<PHINode*, 32> &LoadUsingPHIsPerLoad) {
1045   // We permit two users of the load: setcc comparing against the null
1046   // pointer, and a getelementptr of a specific form.
1047   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
1048     Instruction *User = cast<Instruction>(*UI);
1049     
1050     // Comparison against null is ok.
1051     if (ICmpInst *ICI = dyn_cast<ICmpInst>(User)) {
1052       if (!isa<ConstantPointerNull>(ICI->getOperand(1)))
1053         return false;
1054       continue;
1055     }
1056     
1057     // getelementptr is also ok, but only a simple form.
1058     if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
1059       // Must index into the array and into the struct.
1060       if (GEPI->getNumOperands() < 3)
1061         return false;
1062       
1063       // Otherwise the GEP is ok.
1064       continue;
1065     }
1066     
1067     if (PHINode *PN = dyn_cast<PHINode>(User)) {
1068       if (!LoadUsingPHIsPerLoad.insert(PN))
1069         // This means some phi nodes are dependent on each other.
1070         // Avoid infinite looping!
1071         return false;
1072       if (!LoadUsingPHIs.insert(PN))
1073         // If we have already analyzed this PHI, then it is safe.
1074         continue;
1075       
1076       // Make sure all uses of the PHI are simple enough to transform.
1077       if (!LoadUsesSimpleEnoughForHeapSRA(PN,
1078                                           LoadUsingPHIs, LoadUsingPHIsPerLoad))
1079         return false;
1080       
1081       continue;
1082     }
1083     
1084     // Otherwise we don't know what this is, not ok.
1085     return false;
1086   }
1087   
1088   return true;
1089 }
1090
1091
1092 /// AllGlobalLoadUsesSimpleEnoughForHeapSRA - If all users of values loaded from
1093 /// GV are simple enough to perform HeapSRA, return true.
1094 static bool AllGlobalLoadUsesSimpleEnoughForHeapSRA(GlobalVariable *GV,
1095                                                     Instruction *StoredVal) {
1096   SmallPtrSet<PHINode*, 32> LoadUsingPHIs;
1097   SmallPtrSet<PHINode*, 32> LoadUsingPHIsPerLoad;
1098   for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI != E; 
1099        ++UI)
1100     if (LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
1101       if (!LoadUsesSimpleEnoughForHeapSRA(LI, LoadUsingPHIs,
1102                                           LoadUsingPHIsPerLoad))
1103         return false;
1104       LoadUsingPHIsPerLoad.clear();
1105     }
1106   
1107   // If we reach here, we know that all uses of the loads and transitive uses
1108   // (through PHI nodes) are simple enough to transform.  However, we don't know
1109   // that all inputs the to the PHI nodes are in the same equivalence sets. 
1110   // Check to verify that all operands of the PHIs are either PHIS that can be
1111   // transformed, loads from GV, or MI itself.
1112   for (SmallPtrSet<PHINode*, 32>::iterator I = LoadUsingPHIs.begin(),
1113        E = LoadUsingPHIs.end(); I != E; ++I) {
1114     PHINode *PN = *I;
1115     for (unsigned op = 0, e = PN->getNumIncomingValues(); op != e; ++op) {
1116       Value *InVal = PN->getIncomingValue(op);
1117       
1118       // PHI of the stored value itself is ok.
1119       if (InVal == StoredVal) continue;
1120       
1121       if (PHINode *InPN = dyn_cast<PHINode>(InVal)) {
1122         // One of the PHIs in our set is (optimistically) ok.
1123         if (LoadUsingPHIs.count(InPN))
1124           continue;
1125         return false;
1126       }
1127       
1128       // Load from GV is ok.
1129       if (LoadInst *LI = dyn_cast<LoadInst>(InVal))
1130         if (LI->getOperand(0) == GV)
1131           continue;
1132       
1133       // UNDEF? NULL?
1134       
1135       // Anything else is rejected.
1136       return false;
1137     }
1138   }
1139   
1140   return true;
1141 }
1142
1143 static Value *GetHeapSROAValue(Value *V, unsigned FieldNo,
1144                DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
1145                    std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
1146   std::vector<Value*> &FieldVals = InsertedScalarizedValues[V];
1147   
1148   if (FieldNo >= FieldVals.size())
1149     FieldVals.resize(FieldNo+1);
1150   
1151   // If we already have this value, just reuse the previously scalarized
1152   // version.
1153   if (Value *FieldVal = FieldVals[FieldNo])
1154     return FieldVal;
1155   
1156   // Depending on what instruction this is, we have several cases.
1157   Value *Result;
1158   if (LoadInst *LI = dyn_cast<LoadInst>(V)) {
1159     // This is a scalarized version of the load from the global.  Just create
1160     // a new Load of the scalarized global.
1161     Result = new LoadInst(GetHeapSROAValue(LI->getOperand(0), FieldNo,
1162                                            InsertedScalarizedValues,
1163                                            PHIsToRewrite),
1164                           LI->getName()+".f"+Twine(FieldNo), LI);
1165   } else if (PHINode *PN = dyn_cast<PHINode>(V)) {
1166     // PN's type is pointer to struct.  Make a new PHI of pointer to struct
1167     // field.
1168     const StructType *ST = 
1169       cast<StructType>(cast<PointerType>(PN->getType())->getElementType());
1170     
1171     Result =
1172      PHINode::Create(PointerType::getUnqual(ST->getElementType(FieldNo)),
1173                      PN->getName()+".f"+Twine(FieldNo), PN);
1174     PHIsToRewrite.push_back(std::make_pair(PN, FieldNo));
1175   } else {
1176     llvm_unreachable("Unknown usable value");
1177     Result = 0;
1178   }
1179   
1180   return FieldVals[FieldNo] = Result;
1181 }
1182
1183 /// RewriteHeapSROALoadUser - Given a load instruction and a value derived from
1184 /// the load, rewrite the derived value to use the HeapSRoA'd load.
1185 static void RewriteHeapSROALoadUser(Instruction *LoadUser, 
1186              DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
1187                    std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
1188   // If this is a comparison against null, handle it.
1189   if (ICmpInst *SCI = dyn_cast<ICmpInst>(LoadUser)) {
1190     assert(isa<ConstantPointerNull>(SCI->getOperand(1)));
1191     // If we have a setcc of the loaded pointer, we can use a setcc of any
1192     // field.
1193     Value *NPtr = GetHeapSROAValue(SCI->getOperand(0), 0,
1194                                    InsertedScalarizedValues, PHIsToRewrite);
1195     
1196     Value *New = new ICmpInst(SCI, SCI->getPredicate(), NPtr,
1197                               Constant::getNullValue(NPtr->getType()), 
1198                               SCI->getName());
1199     SCI->replaceAllUsesWith(New);
1200     SCI->eraseFromParent();
1201     return;
1202   }
1203   
1204   // Handle 'getelementptr Ptr, Idx, i32 FieldNo ...'
1205   if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(LoadUser)) {
1206     assert(GEPI->getNumOperands() >= 3 && isa<ConstantInt>(GEPI->getOperand(2))
1207            && "Unexpected GEPI!");
1208   
1209     // Load the pointer for this field.
1210     unsigned FieldNo = cast<ConstantInt>(GEPI->getOperand(2))->getZExtValue();
1211     Value *NewPtr = GetHeapSROAValue(GEPI->getOperand(0), FieldNo,
1212                                      InsertedScalarizedValues, PHIsToRewrite);
1213     
1214     // Create the new GEP idx vector.
1215     SmallVector<Value*, 8> GEPIdx;
1216     GEPIdx.push_back(GEPI->getOperand(1));
1217     GEPIdx.append(GEPI->op_begin()+3, GEPI->op_end());
1218     
1219     Value *NGEPI = GetElementPtrInst::Create(NewPtr,
1220                                              GEPIdx.begin(), GEPIdx.end(),
1221                                              GEPI->getName(), GEPI);
1222     GEPI->replaceAllUsesWith(NGEPI);
1223     GEPI->eraseFromParent();
1224     return;
1225   }
1226
1227   // Recursively transform the users of PHI nodes.  This will lazily create the
1228   // PHIs that are needed for individual elements.  Keep track of what PHIs we
1229   // see in InsertedScalarizedValues so that we don't get infinite loops (very
1230   // antisocial).  If the PHI is already in InsertedScalarizedValues, it has
1231   // already been seen first by another load, so its uses have already been
1232   // processed.
1233   PHINode *PN = cast<PHINode>(LoadUser);
1234   bool Inserted;
1235   DenseMap<Value*, std::vector<Value*> >::iterator InsertPos;
1236   tie(InsertPos, Inserted) =
1237     InsertedScalarizedValues.insert(std::make_pair(PN, std::vector<Value*>()));
1238   if (!Inserted) return;
1239   
1240   // If this is the first time we've seen this PHI, recursively process all
1241   // users.
1242   for (Value::use_iterator UI = PN->use_begin(), E = PN->use_end(); UI != E; ) {
1243     Instruction *User = cast<Instruction>(*UI++);
1244     RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite);
1245   }
1246 }
1247
1248 /// RewriteUsesOfLoadForHeapSRoA - We are performing Heap SRoA on a global.  Ptr
1249 /// is a value loaded from the global.  Eliminate all uses of Ptr, making them
1250 /// use FieldGlobals instead.  All uses of loaded values satisfy
1251 /// AllGlobalLoadUsesSimpleEnoughForHeapSRA.
1252 static void RewriteUsesOfLoadForHeapSRoA(LoadInst *Load, 
1253                DenseMap<Value*, std::vector<Value*> > &InsertedScalarizedValues,
1254                    std::vector<std::pair<PHINode*, unsigned> > &PHIsToRewrite) {
1255   for (Value::use_iterator UI = Load->use_begin(), E = Load->use_end();
1256        UI != E; ) {
1257     Instruction *User = cast<Instruction>(*UI++);
1258     RewriteHeapSROALoadUser(User, InsertedScalarizedValues, PHIsToRewrite);
1259   }
1260   
1261   if (Load->use_empty()) {
1262     Load->eraseFromParent();
1263     InsertedScalarizedValues.erase(Load);
1264   }
1265 }
1266
1267 /// PerformHeapAllocSRoA - CI is an allocation of an array of structures.  Break
1268 /// it up into multiple allocations of arrays of the fields.
1269 static GlobalVariable *PerformHeapAllocSRoA(GlobalVariable *GV, CallInst *CI,
1270                                             Value* NElems, TargetData *TD) {
1271   DEBUG(errs() << "SROA HEAP ALLOC: " << *GV << "  MALLOC = " << *CI << '\n');
1272   const Type* MAT = getMallocAllocatedType(CI);
1273   const StructType *STy = cast<StructType>(MAT);
1274
1275   // There is guaranteed to be at least one use of the malloc (storing
1276   // it into GV).  If there are other uses, change them to be uses of
1277   // the global to simplify later code.  This also deletes the store
1278   // into GV.
1279   ReplaceUsesOfMallocWithGlobal(CI, GV);
1280
1281   // Okay, at this point, there are no users of the malloc.  Insert N
1282   // new mallocs at the same place as CI, and N globals.
1283   std::vector<Value*> FieldGlobals;
1284   std::vector<Value*> FieldMallocs;
1285   
1286   for (unsigned FieldNo = 0, e = STy->getNumElements(); FieldNo != e;++FieldNo){
1287     const Type *FieldTy = STy->getElementType(FieldNo);
1288     const PointerType *PFieldTy = PointerType::getUnqual(FieldTy);
1289     
1290     GlobalVariable *NGV =
1291       new GlobalVariable(*GV->getParent(),
1292                          PFieldTy, false, GlobalValue::InternalLinkage,
1293                          Constant::getNullValue(PFieldTy),
1294                          GV->getName() + ".f" + Twine(FieldNo), GV,
1295                          GV->isThreadLocal());
1296     FieldGlobals.push_back(NGV);
1297     
1298     unsigned TypeSize = TD->getTypeAllocSize(FieldTy);
1299     if (const StructType* ST = dyn_cast<StructType>(FieldTy))
1300       TypeSize = TD->getStructLayout(ST)->getSizeInBytes();
1301     const Type* IntPtrTy = TD->getIntPtrType(CI->getContext());
1302     Value *NMI = CallInst::CreateMalloc(CI, IntPtrTy, FieldTy,
1303                                         ConstantInt::get(IntPtrTy, TypeSize),
1304                                         NElems,
1305                                         CI->getName() + ".f" + Twine(FieldNo));
1306     FieldMallocs.push_back(NMI);
1307     new StoreInst(NMI, NGV, CI);
1308   }
1309   
1310   // The tricky aspect of this transformation is handling the case when malloc
1311   // fails.  In the original code, malloc failing would set the result pointer
1312   // of malloc to null.  In this case, some mallocs could succeed and others
1313   // could fail.  As such, we emit code that looks like this:
1314   //    F0 = malloc(field0)
1315   //    F1 = malloc(field1)
1316   //    F2 = malloc(field2)
1317   //    if (F0 == 0 || F1 == 0 || F2 == 0) {
1318   //      if (F0) { free(F0); F0 = 0; }
1319   //      if (F1) { free(F1); F1 = 0; }
1320   //      if (F2) { free(F2); F2 = 0; }
1321   //    }
1322   Value *RunningOr = 0;
1323   for (unsigned i = 0, e = FieldMallocs.size(); i != e; ++i) {
1324     Value *Cond = new ICmpInst(CI, ICmpInst::ICMP_EQ, FieldMallocs[i],
1325                              Constant::getNullValue(FieldMallocs[i]->getType()),
1326                                "isnull");
1327     if (!RunningOr)
1328       RunningOr = Cond;   // First seteq
1329     else
1330       RunningOr = BinaryOperator::CreateOr(RunningOr, Cond, "tmp", CI);
1331   }
1332
1333   // Split the basic block at the old malloc.
1334   BasicBlock *OrigBB = CI->getParent();
1335   BasicBlock *ContBB = OrigBB->splitBasicBlock(CI, "malloc_cont");
1336   
1337   // Create the block to check the first condition.  Put all these blocks at the
1338   // end of the function as they are unlikely to be executed.
1339   BasicBlock *NullPtrBlock = BasicBlock::Create(OrigBB->getContext(),
1340                                                 "malloc_ret_null",
1341                                                 OrigBB->getParent());
1342   
1343   // Remove the uncond branch from OrigBB to ContBB, turning it into a cond
1344   // branch on RunningOr.
1345   OrigBB->getTerminator()->eraseFromParent();
1346   BranchInst::Create(NullPtrBlock, ContBB, RunningOr, OrigBB);
1347   
1348   // Within the NullPtrBlock, we need to emit a comparison and branch for each
1349   // pointer, because some may be null while others are not.
1350   for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1351     Value *GVVal = new LoadInst(FieldGlobals[i], "tmp", NullPtrBlock);
1352     Value *Cmp = new ICmpInst(*NullPtrBlock, ICmpInst::ICMP_NE, GVVal, 
1353                               Constant::getNullValue(GVVal->getType()),
1354                               "tmp");
1355     BasicBlock *FreeBlock = BasicBlock::Create(Cmp->getContext(), "free_it",
1356                                                OrigBB->getParent());
1357     BasicBlock *NextBlock = BasicBlock::Create(Cmp->getContext(), "next",
1358                                                OrigBB->getParent());
1359     Instruction *BI = BranchInst::Create(FreeBlock, NextBlock,
1360                                          Cmp, NullPtrBlock);
1361
1362     // Fill in FreeBlock.
1363     CallInst::CreateFree(GVVal, BI);
1364     new StoreInst(Constant::getNullValue(GVVal->getType()), FieldGlobals[i],
1365                   FreeBlock);
1366     BranchInst::Create(NextBlock, FreeBlock);
1367     
1368     NullPtrBlock = NextBlock;
1369   }
1370   
1371   BranchInst::Create(ContBB, NullPtrBlock);
1372
1373   // CI is no longer needed, remove it.
1374   CI->eraseFromParent();
1375
1376   /// InsertedScalarizedLoads - As we process loads, if we can't immediately
1377   /// update all uses of the load, keep track of what scalarized loads are
1378   /// inserted for a given load.
1379   DenseMap<Value*, std::vector<Value*> > InsertedScalarizedValues;
1380   InsertedScalarizedValues[GV] = FieldGlobals;
1381   
1382   std::vector<std::pair<PHINode*, unsigned> > PHIsToRewrite;
1383   
1384   // Okay, the malloc site is completely handled.  All of the uses of GV are now
1385   // loads, and all uses of those loads are simple.  Rewrite them to use loads
1386   // of the per-field globals instead.
1387   for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI != E;) {
1388     Instruction *User = cast<Instruction>(*UI++);
1389     
1390     if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
1391       RewriteUsesOfLoadForHeapSRoA(LI, InsertedScalarizedValues, PHIsToRewrite);
1392       continue;
1393     }
1394     
1395     // Must be a store of null.
1396     StoreInst *SI = cast<StoreInst>(User);
1397     assert(isa<ConstantPointerNull>(SI->getOperand(0)) &&
1398            "Unexpected heap-sra user!");
1399     
1400     // Insert a store of null into each global.
1401     for (unsigned i = 0, e = FieldGlobals.size(); i != e; ++i) {
1402       const PointerType *PT = cast<PointerType>(FieldGlobals[i]->getType());
1403       Constant *Null = Constant::getNullValue(PT->getElementType());
1404       new StoreInst(Null, FieldGlobals[i], SI);
1405     }
1406     // Erase the original store.
1407     SI->eraseFromParent();
1408   }
1409
1410   // While we have PHIs that are interesting to rewrite, do it.
1411   while (!PHIsToRewrite.empty()) {
1412     PHINode *PN = PHIsToRewrite.back().first;
1413     unsigned FieldNo = PHIsToRewrite.back().second;
1414     PHIsToRewrite.pop_back();
1415     PHINode *FieldPN = cast<PHINode>(InsertedScalarizedValues[PN][FieldNo]);
1416     assert(FieldPN->getNumIncomingValues() == 0 &&"Already processed this phi");
1417
1418     // Add all the incoming values.  This can materialize more phis.
1419     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1420       Value *InVal = PN->getIncomingValue(i);
1421       InVal = GetHeapSROAValue(InVal, FieldNo, InsertedScalarizedValues,
1422                                PHIsToRewrite);
1423       FieldPN->addIncoming(InVal, PN->getIncomingBlock(i));
1424     }
1425   }
1426   
1427   // Drop all inter-phi links and any loads that made it this far.
1428   for (DenseMap<Value*, std::vector<Value*> >::iterator
1429        I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1430        I != E; ++I) {
1431     if (PHINode *PN = dyn_cast<PHINode>(I->first))
1432       PN->dropAllReferences();
1433     else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1434       LI->dropAllReferences();
1435   }
1436   
1437   // Delete all the phis and loads now that inter-references are dead.
1438   for (DenseMap<Value*, std::vector<Value*> >::iterator
1439        I = InsertedScalarizedValues.begin(), E = InsertedScalarizedValues.end();
1440        I != E; ++I) {
1441     if (PHINode *PN = dyn_cast<PHINode>(I->first))
1442       PN->eraseFromParent();
1443     else if (LoadInst *LI = dyn_cast<LoadInst>(I->first))
1444       LI->eraseFromParent();
1445   }
1446   
1447   // The old global is now dead, remove it.
1448   GV->eraseFromParent();
1449
1450   ++NumHeapSRA;
1451   return cast<GlobalVariable>(FieldGlobals[0]);
1452 }
1453
1454 /// TryToOptimizeStoreOfMallocToGlobal - This function is called when we see a
1455 /// pointer global variable with a single value stored it that is a malloc or
1456 /// cast of malloc.
1457 static bool TryToOptimizeStoreOfMallocToGlobal(GlobalVariable *GV,
1458                                                CallInst *CI,
1459                                                const Type *AllocTy,
1460                                                Module::global_iterator &GVI,
1461                                                TargetData *TD) {
1462   // If this is a malloc of an abstract type, don't touch it.
1463   if (!AllocTy->isSized())
1464     return false;
1465
1466   // We can't optimize this global unless all uses of it are *known* to be
1467   // of the malloc value, not of the null initializer value (consider a use
1468   // that compares the global's value against zero to see if the malloc has
1469   // been reached).  To do this, we check to see if all uses of the global
1470   // would trap if the global were null: this proves that they must all
1471   // happen after the malloc.
1472   if (!AllUsesOfLoadedValueWillTrapIfNull(GV))
1473     return false;
1474
1475   // We can't optimize this if the malloc itself is used in a complex way,
1476   // for example, being stored into multiple globals.  This allows the
1477   // malloc to be stored into the specified global, loaded setcc'd, and
1478   // GEP'd.  These are all things we could transform to using the global
1479   // for.
1480   {
1481     SmallPtrSet<PHINode*, 8> PHIs;
1482     if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(CI, GV, PHIs))
1483       return false;
1484   }  
1485
1486   // If we have a global that is only initialized with a fixed size malloc,
1487   // transform the program to use global memory instead of malloc'd memory.
1488   // This eliminates dynamic allocation, avoids an indirection accessing the
1489   // data, and exposes the resultant global to further GlobalOpt.
1490   // We cannot optimize the malloc if we cannot determine malloc array size.
1491   if (Value *NElems = getMallocArraySize(CI, TD)) {
1492     if (ConstantInt *NElements = dyn_cast<ConstantInt>(NElems))
1493       // Restrict this transformation to only working on small allocations
1494       // (2048 bytes currently), as we don't want to introduce a 16M global or
1495       // something.
1496       if (TD && 
1497           NElements->getZExtValue() * TD->getTypeAllocSize(AllocTy) < 2048) {
1498         GVI = OptimizeGlobalAddressOfMalloc(GV, CI, AllocTy, NElems, TD);
1499         return true;
1500       }
1501   
1502     // If the allocation is an array of structures, consider transforming this
1503     // into multiple malloc'd arrays, one for each field.  This is basically
1504     // SRoA for malloc'd memory.
1505
1506     // If this is an allocation of a fixed size array of structs, analyze as a
1507     // variable size array.  malloc [100 x struct],1 -> malloc struct, 100
1508     if (NElems == ConstantInt::get(CI->getOperand(1)->getType(), 1))
1509       if (const ArrayType *AT = dyn_cast<ArrayType>(AllocTy))
1510         AllocTy = AT->getElementType();
1511   
1512     if (const StructType *AllocSTy = dyn_cast<StructType>(AllocTy)) {
1513       // This the structure has an unreasonable number of fields, leave it
1514       // alone.
1515       if (AllocSTy->getNumElements() <= 16 && AllocSTy->getNumElements() != 0 &&
1516           AllGlobalLoadUsesSimpleEnoughForHeapSRA(GV, CI)) {
1517
1518         // If this is a fixed size array, transform the Malloc to be an alloc of
1519         // structs.  malloc [100 x struct],1 -> malloc struct, 100
1520         if (const ArrayType *AT =
1521                               dyn_cast<ArrayType>(getMallocAllocatedType(CI))) {
1522           const Type *IntPtrTy = TD->getIntPtrType(CI->getContext());
1523           unsigned TypeSize = TD->getStructLayout(AllocSTy)->getSizeInBytes();
1524           Value *AllocSize = ConstantInt::get(IntPtrTy, TypeSize);
1525           Value *NumElements = ConstantInt::get(IntPtrTy, AT->getNumElements());
1526           Instruction *Malloc = CallInst::CreateMalloc(CI, IntPtrTy, AllocSTy,
1527                                                        AllocSize, NumElements,
1528                                                        CI->getName());
1529           Instruction *Cast = new BitCastInst(Malloc, CI->getType(), "tmp", CI);
1530           CI->replaceAllUsesWith(Cast);
1531           CI->eraseFromParent();
1532           CI = dyn_cast<BitCastInst>(Malloc) ?
1533                extractMallocCallFromBitCast(Malloc):
1534                cast<CallInst>(Malloc);
1535         }
1536       
1537         GVI = PerformHeapAllocSRoA(GV, CI, getMallocArraySize(CI, TD), TD);
1538         return true;
1539       }
1540     }
1541   }
1542   
1543   return false;
1544 }  
1545
1546 // OptimizeOnceStoredGlobal - Try to optimize globals based on the knowledge
1547 // that only one value (besides its initializer) is ever stored to the global.
1548 static bool OptimizeOnceStoredGlobal(GlobalVariable *GV, Value *StoredOnceVal,
1549                                      Module::global_iterator &GVI,
1550                                      TargetData *TD) {
1551   // Ignore no-op GEPs and bitcasts.
1552   StoredOnceVal = StoredOnceVal->stripPointerCasts();
1553
1554   // If we are dealing with a pointer global that is initialized to null and
1555   // only has one (non-null) value stored into it, then we can optimize any
1556   // users of the loaded value (often calls and loads) that would trap if the
1557   // value was null.
1558   if (isa<PointerType>(GV->getInitializer()->getType()) &&
1559       GV->getInitializer()->isNullValue()) {
1560     if (Constant *SOVC = dyn_cast<Constant>(StoredOnceVal)) {
1561       if (GV->getInitializer()->getType() != SOVC->getType())
1562         SOVC = 
1563          ConstantExpr::getBitCast(SOVC, GV->getInitializer()->getType());
1564
1565       // Optimize away any trapping uses of the loaded value.
1566       if (OptimizeAwayTrappingUsesOfLoads(GV, SOVC))
1567         return true;
1568     } else if (CallInst *CI = extractMallocCall(StoredOnceVal)) {
1569       const Type* MallocType = getMallocAllocatedType(CI);
1570       if (MallocType && TryToOptimizeStoreOfMallocToGlobal(GV, CI, MallocType, 
1571                                                            GVI, TD))
1572         return true;
1573     }
1574   }
1575
1576   return false;
1577 }
1578
1579 /// TryToShrinkGlobalToBoolean - At this point, we have learned that the only
1580 /// two values ever stored into GV are its initializer and OtherVal.  See if we
1581 /// can shrink the global into a boolean and select between the two values
1582 /// whenever it is used.  This exposes the values to other scalar optimizations.
1583 static bool TryToShrinkGlobalToBoolean(GlobalVariable *GV, Constant *OtherVal) {
1584   const Type *GVElType = GV->getType()->getElementType();
1585   
1586   // If GVElType is already i1, it is already shrunk.  If the type of the GV is
1587   // an FP value, pointer or vector, don't do this optimization because a select
1588   // between them is very expensive and unlikely to lead to later
1589   // simplification.  In these cases, we typically end up with "cond ? v1 : v2"
1590   // where v1 and v2 both require constant pool loads, a big loss.
1591   if (GVElType == Type::getInt1Ty(GV->getContext()) ||
1592       GVElType->isFloatingPoint() ||
1593       isa<PointerType>(GVElType) || isa<VectorType>(GVElType))
1594     return false;
1595   
1596   // Walk the use list of the global seeing if all the uses are load or store.
1597   // If there is anything else, bail out.
1598   for (Value::use_iterator I = GV->use_begin(), E = GV->use_end(); I != E; ++I)
1599     if (!isa<LoadInst>(I) && !isa<StoreInst>(I))
1600       return false;
1601   
1602   DEBUG(errs() << "   *** SHRINKING TO BOOL: " << *GV);
1603   
1604   // Create the new global, initializing it to false.
1605   GlobalVariable *NewGV = new GlobalVariable(Type::getInt1Ty(GV->getContext()),
1606                                              false,
1607                                              GlobalValue::InternalLinkage, 
1608                                         ConstantInt::getFalse(GV->getContext()),
1609                                              GV->getName()+".b",
1610                                              GV->isThreadLocal());
1611   GV->getParent()->getGlobalList().insert(GV, NewGV);
1612
1613   Constant *InitVal = GV->getInitializer();
1614   assert(InitVal->getType() != Type::getInt1Ty(GV->getContext()) &&
1615          "No reason to shrink to bool!");
1616
1617   // If initialized to zero and storing one into the global, we can use a cast
1618   // instead of a select to synthesize the desired value.
1619   bool IsOneZero = false;
1620   if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal))
1621     IsOneZero = InitVal->isNullValue() && CI->isOne();
1622
1623   while (!GV->use_empty()) {
1624     Instruction *UI = cast<Instruction>(GV->use_back());
1625     if (StoreInst *SI = dyn_cast<StoreInst>(UI)) {
1626       // Change the store into a boolean store.
1627       bool StoringOther = SI->getOperand(0) == OtherVal;
1628       // Only do this if we weren't storing a loaded value.
1629       Value *StoreVal;
1630       if (StoringOther || SI->getOperand(0) == InitVal)
1631         StoreVal = ConstantInt::get(Type::getInt1Ty(GV->getContext()),
1632                                     StoringOther);
1633       else {
1634         // Otherwise, we are storing a previously loaded copy.  To do this,
1635         // change the copy from copying the original value to just copying the
1636         // bool.
1637         Instruction *StoredVal = cast<Instruction>(SI->getOperand(0));
1638
1639         // If we're already replaced the input, StoredVal will be a cast or
1640         // select instruction.  If not, it will be a load of the original
1641         // global.
1642         if (LoadInst *LI = dyn_cast<LoadInst>(StoredVal)) {
1643           assert(LI->getOperand(0) == GV && "Not a copy!");
1644           // Insert a new load, to preserve the saved value.
1645           StoreVal = new LoadInst(NewGV, LI->getName()+".b", LI);
1646         } else {
1647           assert((isa<CastInst>(StoredVal) || isa<SelectInst>(StoredVal)) &&
1648                  "This is not a form that we understand!");
1649           StoreVal = StoredVal->getOperand(0);
1650           assert(isa<LoadInst>(StoreVal) && "Not a load of NewGV!");
1651         }
1652       }
1653       new StoreInst(StoreVal, NewGV, SI);
1654     } else {
1655       // Change the load into a load of bool then a select.
1656       LoadInst *LI = cast<LoadInst>(UI);
1657       LoadInst *NLI = new LoadInst(NewGV, LI->getName()+".b", LI);
1658       Value *NSI;
1659       if (IsOneZero)
1660         NSI = new ZExtInst(NLI, LI->getType(), "", LI);
1661       else
1662         NSI = SelectInst::Create(NLI, OtherVal, InitVal, "", LI);
1663       NSI->takeName(LI);
1664       LI->replaceAllUsesWith(NSI);
1665     }
1666     UI->eraseFromParent();
1667   }
1668
1669   GV->eraseFromParent();
1670   return true;
1671 }
1672
1673
1674 /// ProcessInternalGlobal - Analyze the specified global variable and optimize
1675 /// it if possible.  If we make a change, return true.
1676 bool GlobalOpt::ProcessInternalGlobal(GlobalVariable *GV,
1677                                       Module::global_iterator &GVI) {
1678   SmallPtrSet<PHINode*, 16> PHIUsers;
1679   GlobalStatus GS;
1680   GV->removeDeadConstantUsers();
1681
1682   if (GV->use_empty()) {
1683     DEBUG(errs() << "GLOBAL DEAD: " << *GV);
1684     GV->eraseFromParent();
1685     ++NumDeleted;
1686     return true;
1687   }
1688
1689   if (!AnalyzeGlobal(GV, GS, PHIUsers)) {
1690 #if 0
1691     cerr << "Global: " << *GV;
1692     cerr << "  isLoaded = " << GS.isLoaded << "\n";
1693     cerr << "  StoredType = ";
1694     switch (GS.StoredType) {
1695     case GlobalStatus::NotStored: cerr << "NEVER STORED\n"; break;
1696     case GlobalStatus::isInitializerStored: cerr << "INIT STORED\n"; break;
1697     case GlobalStatus::isStoredOnce: cerr << "STORED ONCE\n"; break;
1698     case GlobalStatus::isStored: cerr << "stored\n"; break;
1699     }
1700     if (GS.StoredType == GlobalStatus::isStoredOnce && GS.StoredOnceValue)
1701       cerr << "  StoredOnceValue = " << *GS.StoredOnceValue << "\n";
1702     if (GS.AccessingFunction && !GS.HasMultipleAccessingFunctions)
1703       cerr << "  AccessingFunction = " << GS.AccessingFunction->getName()
1704                 << "\n";
1705     cerr << "  HasMultipleAccessingFunctions =  "
1706               << GS.HasMultipleAccessingFunctions << "\n";
1707     cerr << "  HasNonInstructionUser = " << GS.HasNonInstructionUser<<"\n";
1708     cerr << "\n";
1709 #endif
1710     
1711     // If this is a first class global and has only one accessing function
1712     // and this function is main (which we know is not recursive we can make
1713     // this global a local variable) we replace the global with a local alloca
1714     // in this function.
1715     //
1716     // NOTE: It doesn't make sense to promote non single-value types since we
1717     // are just replacing static memory to stack memory.
1718     //
1719     // If the global is in different address space, don't bring it to stack.
1720     if (!GS.HasMultipleAccessingFunctions &&
1721         GS.AccessingFunction && !GS.HasNonInstructionUser &&
1722         GV->getType()->getElementType()->isSingleValueType() &&
1723         GS.AccessingFunction->getName() == "main" &&
1724         GS.AccessingFunction->hasExternalLinkage() &&
1725         GV->getType()->getAddressSpace() == 0) {
1726       DEBUG(errs() << "LOCALIZING GLOBAL: " << *GV);
1727       Instruction* FirstI = GS.AccessingFunction->getEntryBlock().begin();
1728       const Type* ElemTy = GV->getType()->getElementType();
1729       // FIXME: Pass Global's alignment when globals have alignment
1730       AllocaInst* Alloca = new AllocaInst(ElemTy, NULL, GV->getName(), FirstI);
1731       if (!isa<UndefValue>(GV->getInitializer()))
1732         new StoreInst(GV->getInitializer(), Alloca, FirstI);
1733
1734       GV->replaceAllUsesWith(Alloca);
1735       GV->eraseFromParent();
1736       ++NumLocalized;
1737       return true;
1738     }
1739     
1740     // If the global is never loaded (but may be stored to), it is dead.
1741     // Delete it now.
1742     if (!GS.isLoaded) {
1743       DEBUG(errs() << "GLOBAL NEVER LOADED: " << *GV);
1744
1745       // Delete any stores we can find to the global.  We may not be able to
1746       // make it completely dead though.
1747       bool Changed = CleanupConstantGlobalUsers(GV, GV->getInitializer());
1748
1749       // If the global is dead now, delete it.
1750       if (GV->use_empty()) {
1751         GV->eraseFromParent();
1752         ++NumDeleted;
1753         Changed = true;
1754       }
1755       return Changed;
1756
1757     } else if (GS.StoredType <= GlobalStatus::isInitializerStored) {
1758       DEBUG(errs() << "MARKING CONSTANT: " << *GV);
1759       GV->setConstant(true);
1760
1761       // Clean up any obviously simplifiable users now.
1762       CleanupConstantGlobalUsers(GV, GV->getInitializer());
1763
1764       // If the global is dead now, just nuke it.
1765       if (GV->use_empty()) {
1766         DEBUG(errs() << "   *** Marking constant allowed us to simplify "
1767                      << "all users and delete global!\n");
1768         GV->eraseFromParent();
1769         ++NumDeleted;
1770       }
1771
1772       ++NumMarked;
1773       return true;
1774     } else if (!GV->getInitializer()->getType()->isSingleValueType()) {
1775       if (TargetData *TD = getAnalysisIfAvailable<TargetData>())
1776         if (GlobalVariable *FirstNewGV = SRAGlobal(GV, *TD)) {
1777           GVI = FirstNewGV;  // Don't skip the newly produced globals!
1778           return true;
1779         }
1780     } else if (GS.StoredType == GlobalStatus::isStoredOnce) {
1781       // If the initial value for the global was an undef value, and if only
1782       // one other value was stored into it, we can just change the
1783       // initializer to be the stored value, then delete all stores to the
1784       // global.  This allows us to mark it constant.
1785       if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1786         if (isa<UndefValue>(GV->getInitializer())) {
1787           // Change the initial value here.
1788           GV->setInitializer(SOVConstant);
1789
1790           // Clean up any obviously simplifiable users now.
1791           CleanupConstantGlobalUsers(GV, GV->getInitializer());
1792
1793           if (GV->use_empty()) {
1794             DEBUG(errs() << "   *** Substituting initializer allowed us to "
1795                          << "simplify all users and delete global!\n");
1796             GV->eraseFromParent();
1797             ++NumDeleted;
1798           } else {
1799             GVI = GV;
1800           }
1801           ++NumSubstitute;
1802           return true;
1803         }
1804
1805       // Try to optimize globals based on the knowledge that only one value
1806       // (besides its initializer) is ever stored to the global.
1807       if (OptimizeOnceStoredGlobal(GV, GS.StoredOnceValue, GVI,
1808                                    getAnalysisIfAvailable<TargetData>()))
1809         return true;
1810
1811       // Otherwise, if the global was not a boolean, we can shrink it to be a
1812       // boolean.
1813       if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1814         if (TryToShrinkGlobalToBoolean(GV, SOVConstant)) {
1815           ++NumShrunkToBool;
1816           return true;
1817         }
1818     }
1819   }
1820   return false;
1821 }
1822
1823 /// ChangeCalleesToFastCall - Walk all of the direct calls of the specified
1824 /// function, changing them to FastCC.
1825 static void ChangeCalleesToFastCall(Function *F) {
1826   for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
1827     CallSite User(cast<Instruction>(*UI));
1828     User.setCallingConv(CallingConv::Fast);
1829   }
1830 }
1831
1832 static AttrListPtr StripNest(const AttrListPtr &Attrs) {
1833   for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
1834     if ((Attrs.getSlot(i).Attrs & Attribute::Nest) == 0)
1835       continue;
1836
1837     // There can be only one.
1838     return Attrs.removeAttr(Attrs.getSlot(i).Index, Attribute::Nest);
1839   }
1840
1841   return Attrs;
1842 }
1843
1844 static void RemoveNestAttribute(Function *F) {
1845   F->setAttributes(StripNest(F->getAttributes()));
1846   for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
1847     CallSite User(cast<Instruction>(*UI));
1848     User.setAttributes(StripNest(User.getAttributes()));
1849   }
1850 }
1851
1852 bool GlobalOpt::OptimizeFunctions(Module &M) {
1853   bool Changed = false;
1854   // Optimize functions.
1855   for (Module::iterator FI = M.begin(), E = M.end(); FI != E; ) {
1856     Function *F = FI++;
1857     // Functions without names cannot be referenced outside this module.
1858     if (!F->hasName() && !F->isDeclaration())
1859       F->setLinkage(GlobalValue::InternalLinkage);
1860     F->removeDeadConstantUsers();
1861     if (F->use_empty() && (F->hasLocalLinkage() || F->hasLinkOnceLinkage())) {
1862       F->eraseFromParent();
1863       Changed = true;
1864       ++NumFnDeleted;
1865     } else if (F->hasLocalLinkage()) {
1866       if (F->getCallingConv() == CallingConv::C && !F->isVarArg() &&
1867           !F->hasAddressTaken()) {
1868         // If this function has C calling conventions, is not a varargs
1869         // function, and is only called directly, promote it to use the Fast
1870         // calling convention.
1871         F->setCallingConv(CallingConv::Fast);
1872         ChangeCalleesToFastCall(F);
1873         ++NumFastCallFns;
1874         Changed = true;
1875       }
1876
1877       if (F->getAttributes().hasAttrSomewhere(Attribute::Nest) &&
1878           !F->hasAddressTaken()) {
1879         // The function is not used by a trampoline intrinsic, so it is safe
1880         // to remove the 'nest' attribute.
1881         RemoveNestAttribute(F);
1882         ++NumNestRemoved;
1883         Changed = true;
1884       }
1885     }
1886   }
1887   return Changed;
1888 }
1889
1890 bool GlobalOpt::OptimizeGlobalVars(Module &M) {
1891   bool Changed = false;
1892   for (Module::global_iterator GVI = M.global_begin(), E = M.global_end();
1893        GVI != E; ) {
1894     GlobalVariable *GV = GVI++;
1895     // Global variables without names cannot be referenced outside this module.
1896     if (!GV->hasName() && !GV->isDeclaration())
1897       GV->setLinkage(GlobalValue::InternalLinkage);
1898     if (!GV->isConstant() && GV->hasLocalLinkage() &&
1899         GV->hasInitializer())
1900       Changed |= ProcessInternalGlobal(GV, GVI);
1901   }
1902   return Changed;
1903 }
1904
1905 /// FindGlobalCtors - Find the llvm.globalctors list, verifying that all
1906 /// initializers have an init priority of 65535.
1907 GlobalVariable *GlobalOpt::FindGlobalCtors(Module &M) {
1908   for (Module::global_iterator I = M.global_begin(), E = M.global_end();
1909        I != E; ++I)
1910     if (I->getName() == "llvm.global_ctors") {
1911       // Found it, verify it's an array of { int, void()* }.
1912       const ArrayType *ATy =dyn_cast<ArrayType>(I->getType()->getElementType());
1913       if (!ATy) return 0;
1914       const StructType *STy = dyn_cast<StructType>(ATy->getElementType());
1915       if (!STy || STy->getNumElements() != 2 ||
1916           STy->getElementType(0) != Type::getInt32Ty(M.getContext())) return 0;
1917       const PointerType *PFTy = dyn_cast<PointerType>(STy->getElementType(1));
1918       if (!PFTy) return 0;
1919       const FunctionType *FTy = dyn_cast<FunctionType>(PFTy->getElementType());
1920       if (!FTy || FTy->getReturnType() != Type::getVoidTy(M.getContext()) ||
1921           FTy->isVarArg() || FTy->getNumParams() != 0)
1922         return 0;
1923       
1924       // Verify that the initializer is simple enough for us to handle.
1925       if (!I->hasDefinitiveInitializer()) return 0;
1926       ConstantArray *CA = dyn_cast<ConstantArray>(I->getInitializer());
1927       if (!CA) return 0;
1928       for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i)
1929         if (ConstantStruct *CS = dyn_cast<ConstantStruct>(*i)) {
1930           if (isa<ConstantPointerNull>(CS->getOperand(1)))
1931             continue;
1932
1933           // Must have a function or null ptr.
1934           if (!isa<Function>(CS->getOperand(1)))
1935             return 0;
1936           
1937           // Init priority must be standard.
1938           ConstantInt *CI = dyn_cast<ConstantInt>(CS->getOperand(0));
1939           if (!CI || CI->getZExtValue() != 65535)
1940             return 0;
1941         } else {
1942           return 0;
1943         }
1944       
1945       return I;
1946     }
1947   return 0;
1948 }
1949
1950 /// ParseGlobalCtors - Given a llvm.global_ctors list that we can understand,
1951 /// return a list of the functions and null terminator as a vector.
1952 static std::vector<Function*> ParseGlobalCtors(GlobalVariable *GV) {
1953   ConstantArray *CA = cast<ConstantArray>(GV->getInitializer());
1954   std::vector<Function*> Result;
1955   Result.reserve(CA->getNumOperands());
1956   for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i) {
1957     ConstantStruct *CS = cast<ConstantStruct>(*i);
1958     Result.push_back(dyn_cast<Function>(CS->getOperand(1)));
1959   }
1960   return Result;
1961 }
1962
1963 /// InstallGlobalCtors - Given a specified llvm.global_ctors list, install the
1964 /// specified array, returning the new global to use.
1965 static GlobalVariable *InstallGlobalCtors(GlobalVariable *GCL, 
1966                                           const std::vector<Function*> &Ctors) {
1967   // If we made a change, reassemble the initializer list.
1968   std::vector<Constant*> CSVals;
1969   CSVals.push_back(ConstantInt::get(Type::getInt32Ty(GCL->getContext()),65535));
1970   CSVals.push_back(0);
1971   
1972   // Create the new init list.
1973   std::vector<Constant*> CAList;
1974   for (unsigned i = 0, e = Ctors.size(); i != e; ++i) {
1975     if (Ctors[i]) {
1976       CSVals[1] = Ctors[i];
1977     } else {
1978       const Type *FTy = FunctionType::get(Type::getVoidTy(GCL->getContext()),
1979                                           false);
1980       const PointerType *PFTy = PointerType::getUnqual(FTy);
1981       CSVals[1] = Constant::getNullValue(PFTy);
1982       CSVals[0] = ConstantInt::get(Type::getInt32Ty(GCL->getContext()),
1983                                    2147483647);
1984     }
1985     CAList.push_back(ConstantStruct::get(GCL->getContext(), CSVals, false));
1986   }
1987   
1988   // Create the array initializer.
1989   const Type *StructTy =
1990       cast<ArrayType>(GCL->getType()->getElementType())->getElementType();
1991   Constant *CA = ConstantArray::get(ArrayType::get(StructTy, 
1992                                                    CAList.size()), CAList);
1993   
1994   // If we didn't change the number of elements, don't create a new GV.
1995   if (CA->getType() == GCL->getInitializer()->getType()) {
1996     GCL->setInitializer(CA);
1997     return GCL;
1998   }
1999   
2000   // Create the new global and insert it next to the existing list.
2001   GlobalVariable *NGV = new GlobalVariable(CA->getType(), GCL->isConstant(),
2002                                            GCL->getLinkage(), CA, "",
2003                                            GCL->isThreadLocal());
2004   GCL->getParent()->getGlobalList().insert(GCL, NGV);
2005   NGV->takeName(GCL);
2006   
2007   // Nuke the old list, replacing any uses with the new one.
2008   if (!GCL->use_empty()) {
2009     Constant *V = NGV;
2010     if (V->getType() != GCL->getType())
2011       V = ConstantExpr::getBitCast(V, GCL->getType());
2012     GCL->replaceAllUsesWith(V);
2013   }
2014   GCL->eraseFromParent();
2015   
2016   if (Ctors.size())
2017     return NGV;
2018   else
2019     return 0;
2020 }
2021
2022
2023 static Constant *getVal(DenseMap<Value*, Constant*> &ComputedValues,
2024                         Value *V) {
2025   if (Constant *CV = dyn_cast<Constant>(V)) return CV;
2026   Constant *R = ComputedValues[V];
2027   assert(R && "Reference to an uncomputed value!");
2028   return R;
2029 }
2030
2031 /// isSimpleEnoughPointerToCommit - Return true if this constant is simple
2032 /// enough for us to understand.  In particular, if it is a cast of something,
2033 /// we punt.  We basically just support direct accesses to globals and GEP's of
2034 /// globals.  This should be kept up to date with CommitValueTo.
2035 static bool isSimpleEnoughPointerToCommit(Constant *C) {
2036   // Conservatively, avoid aggregate types. This is because we don't
2037   // want to worry about them partially overlapping other stores.
2038   if (!cast<PointerType>(C->getType())->getElementType()->isSingleValueType())
2039     return false;
2040
2041   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C))
2042     // Do not allow weak/linkonce/dllimport/dllexport linkage or
2043     // external globals.
2044     return GV->hasDefinitiveInitializer();
2045
2046   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
2047     // Handle a constantexpr gep.
2048     if (CE->getOpcode() == Instruction::GetElementPtr &&
2049         isa<GlobalVariable>(CE->getOperand(0)) &&
2050         cast<GEPOperator>(CE)->isInBounds()) {
2051       GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
2052       // Do not allow weak/linkonce/dllimport/dllexport linkage or
2053       // external globals.
2054       if (!GV->hasDefinitiveInitializer())
2055         return false;
2056
2057       // The first index must be zero.
2058       ConstantInt *CI = dyn_cast<ConstantInt>(*next(CE->op_begin()));
2059       if (!CI || !CI->isZero()) return false;
2060
2061       // The remaining indices must be compile-time known integers within the
2062       // notional bounds of the corresponding static array types.
2063       if (!CE->isGEPWithNoNotionalOverIndexing())
2064         return false;
2065
2066       return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
2067     }
2068   return false;
2069 }
2070
2071 /// EvaluateStoreInto - Evaluate a piece of a constantexpr store into a global
2072 /// initializer.  This returns 'Init' modified to reflect 'Val' stored into it.
2073 /// At this point, the GEP operands of Addr [0, OpNo) have been stepped into.
2074 static Constant *EvaluateStoreInto(Constant *Init, Constant *Val,
2075                                    ConstantExpr *Addr, unsigned OpNo) {
2076   // Base case of the recursion.
2077   if (OpNo == Addr->getNumOperands()) {
2078     assert(Val->getType() == Init->getType() && "Type mismatch!");
2079     return Val;
2080   }
2081   
2082   if (const StructType *STy = dyn_cast<StructType>(Init->getType())) {
2083     std::vector<Constant*> Elts;
2084
2085     // Break up the constant into its elements.
2086     if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Init)) {
2087       for (User::op_iterator i = CS->op_begin(), e = CS->op_end(); i != e; ++i)
2088         Elts.push_back(cast<Constant>(*i));
2089     } else if (isa<ConstantAggregateZero>(Init)) {
2090       for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
2091         Elts.push_back(Constant::getNullValue(STy->getElementType(i)));
2092     } else if (isa<UndefValue>(Init)) {
2093       for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
2094         Elts.push_back(UndefValue::get(STy->getElementType(i)));
2095     } else {
2096       llvm_unreachable("This code is out of sync with "
2097              " ConstantFoldLoadThroughGEPConstantExpr");
2098     }
2099     
2100     // Replace the element that we are supposed to.
2101     ConstantInt *CU = cast<ConstantInt>(Addr->getOperand(OpNo));
2102     unsigned Idx = CU->getZExtValue();
2103     assert(Idx < STy->getNumElements() && "Struct index out of range!");
2104     Elts[Idx] = EvaluateStoreInto(Elts[Idx], Val, Addr, OpNo+1);
2105     
2106     // Return the modified struct.
2107     return ConstantStruct::get(Init->getContext(), &Elts[0], Elts.size(),
2108                                STy->isPacked());
2109   } else {
2110     ConstantInt *CI = cast<ConstantInt>(Addr->getOperand(OpNo));
2111     const ArrayType *ATy = cast<ArrayType>(Init->getType());
2112
2113     // Break up the array into elements.
2114     std::vector<Constant*> Elts;
2115     if (ConstantArray *CA = dyn_cast<ConstantArray>(Init)) {
2116       for (User::op_iterator i = CA->op_begin(), e = CA->op_end(); i != e; ++i)
2117         Elts.push_back(cast<Constant>(*i));
2118     } else if (isa<ConstantAggregateZero>(Init)) {
2119       Constant *Elt = Constant::getNullValue(ATy->getElementType());
2120       Elts.assign(ATy->getNumElements(), Elt);
2121     } else if (isa<UndefValue>(Init)) {
2122       Constant *Elt = UndefValue::get(ATy->getElementType());
2123       Elts.assign(ATy->getNumElements(), Elt);
2124     } else {
2125       llvm_unreachable("This code is out of sync with "
2126              " ConstantFoldLoadThroughGEPConstantExpr");
2127     }
2128     
2129     assert(CI->getZExtValue() < ATy->getNumElements());
2130     Elts[CI->getZExtValue()] =
2131       EvaluateStoreInto(Elts[CI->getZExtValue()], Val, Addr, OpNo+1);
2132     return ConstantArray::get(ATy, Elts);
2133   }    
2134 }
2135
2136 /// CommitValueTo - We have decided that Addr (which satisfies the predicate
2137 /// isSimpleEnoughPointerToCommit) should get Val as its value.  Make it happen.
2138 static void CommitValueTo(Constant *Val, Constant *Addr) {
2139   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Addr)) {
2140     assert(GV->hasInitializer());
2141     GV->setInitializer(Val);
2142     return;
2143   }
2144   
2145   ConstantExpr *CE = cast<ConstantExpr>(Addr);
2146   GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
2147   
2148   Constant *Init = GV->getInitializer();
2149   Init = EvaluateStoreInto(Init, Val, CE, 2);
2150   GV->setInitializer(Init);
2151 }
2152
2153 /// ComputeLoadResult - Return the value that would be computed by a load from
2154 /// P after the stores reflected by 'memory' have been performed.  If we can't
2155 /// decide, return null.
2156 static Constant *ComputeLoadResult(Constant *P,
2157                                 const DenseMap<Constant*, Constant*> &Memory) {
2158   // If this memory location has been recently stored, use the stored value: it
2159   // is the most up-to-date.
2160   DenseMap<Constant*, Constant*>::const_iterator I = Memory.find(P);
2161   if (I != Memory.end()) return I->second;
2162  
2163   // Access it.
2164   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(P)) {
2165     if (GV->hasDefinitiveInitializer())
2166       return GV->getInitializer();
2167     return 0;
2168   }
2169   
2170   // Handle a constantexpr getelementptr.
2171   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(P))
2172     if (CE->getOpcode() == Instruction::GetElementPtr &&
2173         isa<GlobalVariable>(CE->getOperand(0))) {
2174       GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
2175       if (GV->hasDefinitiveInitializer())
2176         return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
2177     }
2178
2179   return 0;  // don't know how to evaluate.
2180 }
2181
2182 /// EvaluateFunction - Evaluate a call to function F, returning true if
2183 /// successful, false if we can't evaluate it.  ActualArgs contains the formal
2184 /// arguments for the function.
2185 static bool EvaluateFunction(Function *F, Constant *&RetVal,
2186                              const SmallVectorImpl<Constant*> &ActualArgs,
2187                              std::vector<Function*> &CallStack,
2188                              DenseMap<Constant*, Constant*> &MutatedMemory,
2189                              std::vector<GlobalVariable*> &AllocaTmps) {
2190   // Check to see if this function is already executing (recursion).  If so,
2191   // bail out.  TODO: we might want to accept limited recursion.
2192   if (std::find(CallStack.begin(), CallStack.end(), F) != CallStack.end())
2193     return false;
2194   
2195   CallStack.push_back(F);
2196   
2197   /// Values - As we compute SSA register values, we store their contents here.
2198   DenseMap<Value*, Constant*> Values;
2199   
2200   // Initialize arguments to the incoming values specified.
2201   unsigned ArgNo = 0;
2202   for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end(); AI != E;
2203        ++AI, ++ArgNo)
2204     Values[AI] = ActualArgs[ArgNo];
2205
2206   /// ExecutedBlocks - We only handle non-looping, non-recursive code.  As such,
2207   /// we can only evaluate any one basic block at most once.  This set keeps
2208   /// track of what we have executed so we can detect recursive cases etc.
2209   SmallPtrSet<BasicBlock*, 32> ExecutedBlocks;
2210   
2211   // CurInst - The current instruction we're evaluating.
2212   BasicBlock::iterator CurInst = F->begin()->begin();
2213   
2214   // This is the main evaluation loop.
2215   while (1) {
2216     Constant *InstResult = 0;
2217     
2218     if (StoreInst *SI = dyn_cast<StoreInst>(CurInst)) {
2219       if (SI->isVolatile()) return false;  // no volatile accesses.
2220       Constant *Ptr = getVal(Values, SI->getOperand(1));
2221       if (!isSimpleEnoughPointerToCommit(Ptr))
2222         // If this is too complex for us to commit, reject it.
2223         return false;
2224       Constant *Val = getVal(Values, SI->getOperand(0));
2225       MutatedMemory[Ptr] = Val;
2226     } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(CurInst)) {
2227       InstResult = ConstantExpr::get(BO->getOpcode(),
2228                                      getVal(Values, BO->getOperand(0)),
2229                                      getVal(Values, BO->getOperand(1)));
2230     } else if (CmpInst *CI = dyn_cast<CmpInst>(CurInst)) {
2231       InstResult = ConstantExpr::getCompare(CI->getPredicate(),
2232                                             getVal(Values, CI->getOperand(0)),
2233                                             getVal(Values, CI->getOperand(1)));
2234     } else if (CastInst *CI = dyn_cast<CastInst>(CurInst)) {
2235       InstResult = ConstantExpr::getCast(CI->getOpcode(),
2236                                          getVal(Values, CI->getOperand(0)),
2237                                          CI->getType());
2238     } else if (SelectInst *SI = dyn_cast<SelectInst>(CurInst)) {
2239       InstResult =
2240             ConstantExpr::getSelect(getVal(Values, SI->getOperand(0)),
2241                                            getVal(Values, SI->getOperand(1)),
2242                                            getVal(Values, SI->getOperand(2)));
2243     } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(CurInst)) {
2244       Constant *P = getVal(Values, GEP->getOperand(0));
2245       SmallVector<Constant*, 8> GEPOps;
2246       for (User::op_iterator i = GEP->op_begin() + 1, e = GEP->op_end();
2247            i != e; ++i)
2248         GEPOps.push_back(getVal(Values, *i));
2249       InstResult = cast<GEPOperator>(GEP)->isInBounds() ?
2250           ConstantExpr::getInBoundsGetElementPtr(P, &GEPOps[0], GEPOps.size()) :
2251           ConstantExpr::getGetElementPtr(P, &GEPOps[0], GEPOps.size());
2252     } else if (LoadInst *LI = dyn_cast<LoadInst>(CurInst)) {
2253       if (LI->isVolatile()) return false;  // no volatile accesses.
2254       InstResult = ComputeLoadResult(getVal(Values, LI->getOperand(0)),
2255                                      MutatedMemory);
2256       if (InstResult == 0) return false; // Could not evaluate load.
2257     } else if (AllocaInst *AI = dyn_cast<AllocaInst>(CurInst)) {
2258       if (AI->isArrayAllocation()) return false;  // Cannot handle array allocs.
2259       const Type *Ty = AI->getType()->getElementType();
2260       AllocaTmps.push_back(new GlobalVariable(Ty, false,
2261                                               GlobalValue::InternalLinkage,
2262                                               UndefValue::get(Ty),
2263                                               AI->getName()));
2264       InstResult = AllocaTmps.back();     
2265     } else if (CallInst *CI = dyn_cast<CallInst>(CurInst)) {
2266
2267       // Debug info can safely be ignored here.
2268       if (isa<DbgInfoIntrinsic>(CI)) {
2269         ++CurInst;
2270         continue;
2271       }
2272
2273       // Cannot handle inline asm.
2274       if (isa<InlineAsm>(CI->getOperand(0))) return false;
2275
2276       // Resolve function pointers.
2277       Function *Callee = dyn_cast<Function>(getVal(Values, CI->getOperand(0)));
2278       if (!Callee) return false;  // Cannot resolve.
2279
2280       SmallVector<Constant*, 8> Formals;
2281       for (User::op_iterator i = CI->op_begin() + 1, e = CI->op_end();
2282            i != e; ++i)
2283         Formals.push_back(getVal(Values, *i));
2284
2285       if (Callee->isDeclaration()) {
2286         // If this is a function we can constant fold, do it.
2287         if (Constant *C = ConstantFoldCall(Callee, Formals.data(),
2288                                            Formals.size())) {
2289           InstResult = C;
2290         } else {
2291           return false;
2292         }
2293       } else {
2294         if (Callee->getFunctionType()->isVarArg())
2295           return false;
2296         
2297         Constant *RetVal;
2298         // Execute the call, if successful, use the return value.
2299         if (!EvaluateFunction(Callee, RetVal, Formals, CallStack,
2300                               MutatedMemory, AllocaTmps))
2301           return false;
2302         InstResult = RetVal;
2303       }
2304     } else if (isa<TerminatorInst>(CurInst)) {
2305       BasicBlock *NewBB = 0;
2306       if (BranchInst *BI = dyn_cast<BranchInst>(CurInst)) {
2307         if (BI->isUnconditional()) {
2308           NewBB = BI->getSuccessor(0);
2309         } else {
2310           ConstantInt *Cond =
2311             dyn_cast<ConstantInt>(getVal(Values, BI->getCondition()));
2312           if (!Cond) return false;  // Cannot determine.
2313
2314           NewBB = BI->getSuccessor(!Cond->getZExtValue());          
2315         }
2316       } else if (SwitchInst *SI = dyn_cast<SwitchInst>(CurInst)) {
2317         ConstantInt *Val =
2318           dyn_cast<ConstantInt>(getVal(Values, SI->getCondition()));
2319         if (!Val) return false;  // Cannot determine.
2320         NewBB = SI->getSuccessor(SI->findCaseValue(Val));
2321       } else if (IndirectBrInst *IBI = dyn_cast<IndirectBrInst>(CurInst)) {
2322         Value *Val = getVal(Values, IBI->getAddress())->stripPointerCasts();
2323         if (BlockAddress *BA = dyn_cast<BlockAddress>(Val))
2324           NewBB = BA->getBasicBlock();
2325         else
2326           return false;  // Cannot determine.
2327       } else if (ReturnInst *RI = dyn_cast<ReturnInst>(CurInst)) {
2328         if (RI->getNumOperands())
2329           RetVal = getVal(Values, RI->getOperand(0));
2330         
2331         CallStack.pop_back();  // return from fn.
2332         return true;  // We succeeded at evaluating this ctor!
2333       } else {
2334         // invoke, unwind, unreachable.
2335         return false;  // Cannot handle this terminator.
2336       }
2337       
2338       // Okay, we succeeded in evaluating this control flow.  See if we have
2339       // executed the new block before.  If so, we have a looping function,
2340       // which we cannot evaluate in reasonable time.
2341       if (!ExecutedBlocks.insert(NewBB))
2342         return false;  // looped!
2343       
2344       // Okay, we have never been in this block before.  Check to see if there
2345       // are any PHI nodes.  If so, evaluate them with information about where
2346       // we came from.
2347       BasicBlock *OldBB = CurInst->getParent();
2348       CurInst = NewBB->begin();
2349       PHINode *PN;
2350       for (; (PN = dyn_cast<PHINode>(CurInst)); ++CurInst)
2351         Values[PN] = getVal(Values, PN->getIncomingValueForBlock(OldBB));
2352
2353       // Do NOT increment CurInst.  We know that the terminator had no value.
2354       continue;
2355     } else {
2356       // Did not know how to evaluate this!
2357       return false;
2358     }
2359     
2360     if (!CurInst->use_empty())
2361       Values[CurInst] = InstResult;
2362     
2363     // Advance program counter.
2364     ++CurInst;
2365   }
2366 }
2367
2368 /// EvaluateStaticConstructor - Evaluate static constructors in the function, if
2369 /// we can.  Return true if we can, false otherwise.
2370 static bool EvaluateStaticConstructor(Function *F) {
2371   /// MutatedMemory - For each store we execute, we update this map.  Loads
2372   /// check this to get the most up-to-date value.  If evaluation is successful,
2373   /// this state is committed to the process.
2374   DenseMap<Constant*, Constant*> MutatedMemory;
2375
2376   /// AllocaTmps - To 'execute' an alloca, we create a temporary global variable
2377   /// to represent its body.  This vector is needed so we can delete the
2378   /// temporary globals when we are done.
2379   std::vector<GlobalVariable*> AllocaTmps;
2380   
2381   /// CallStack - This is used to detect recursion.  In pathological situations
2382   /// we could hit exponential behavior, but at least there is nothing
2383   /// unbounded.
2384   std::vector<Function*> CallStack;
2385
2386   // Call the function.
2387   Constant *RetValDummy;
2388   bool EvalSuccess = EvaluateFunction(F, RetValDummy,
2389                                       SmallVector<Constant*, 0>(), CallStack,
2390                                       MutatedMemory, AllocaTmps);
2391   if (EvalSuccess) {
2392     // We succeeded at evaluation: commit the result.
2393     DEBUG(errs() << "FULLY EVALUATED GLOBAL CTOR FUNCTION '"
2394           << F->getName() << "' to " << MutatedMemory.size()
2395           << " stores.\n");
2396     for (DenseMap<Constant*, Constant*>::iterator I = MutatedMemory.begin(),
2397          E = MutatedMemory.end(); I != E; ++I)
2398       CommitValueTo(I->second, I->first);
2399   }
2400   
2401   // At this point, we are done interpreting.  If we created any 'alloca'
2402   // temporaries, release them now.
2403   while (!AllocaTmps.empty()) {
2404     GlobalVariable *Tmp = AllocaTmps.back();
2405     AllocaTmps.pop_back();
2406     
2407     // If there are still users of the alloca, the program is doing something
2408     // silly, e.g. storing the address of the alloca somewhere and using it
2409     // later.  Since this is undefined, we'll just make it be null.
2410     if (!Tmp->use_empty())
2411       Tmp->replaceAllUsesWith(Constant::getNullValue(Tmp->getType()));
2412     delete Tmp;
2413   }
2414   
2415   return EvalSuccess;
2416 }
2417
2418
2419
2420 /// OptimizeGlobalCtorsList - Simplify and evaluation global ctors if possible.
2421 /// Return true if anything changed.
2422 bool GlobalOpt::OptimizeGlobalCtorsList(GlobalVariable *&GCL) {
2423   std::vector<Function*> Ctors = ParseGlobalCtors(GCL);
2424   bool MadeChange = false;
2425   if (Ctors.empty()) return false;
2426   
2427   // Loop over global ctors, optimizing them when we can.
2428   for (unsigned i = 0; i != Ctors.size(); ++i) {
2429     Function *F = Ctors[i];
2430     // Found a null terminator in the middle of the list, prune off the rest of
2431     // the list.
2432     if (F == 0) {
2433       if (i != Ctors.size()-1) {
2434         Ctors.resize(i+1);
2435         MadeChange = true;
2436       }
2437       break;
2438     }
2439     
2440     // We cannot simplify external ctor functions.
2441     if (F->empty()) continue;
2442     
2443     // If we can evaluate the ctor at compile time, do.
2444     if (EvaluateStaticConstructor(F)) {
2445       Ctors.erase(Ctors.begin()+i);
2446       MadeChange = true;
2447       --i;
2448       ++NumCtorsEvaluated;
2449       continue;
2450     }
2451   }
2452   
2453   if (!MadeChange) return false;
2454   
2455   GCL = InstallGlobalCtors(GCL, Ctors);
2456   return true;
2457 }
2458
2459 bool GlobalOpt::OptimizeGlobalAliases(Module &M) {
2460   bool Changed = false;
2461
2462   for (Module::alias_iterator I = M.alias_begin(), E = M.alias_end();
2463        I != E;) {
2464     Module::alias_iterator J = I++;
2465     // Aliases without names cannot be referenced outside this module.
2466     if (!J->hasName() && !J->isDeclaration())
2467       J->setLinkage(GlobalValue::InternalLinkage);
2468     // If the aliasee may change at link time, nothing can be done - bail out.
2469     if (J->mayBeOverridden())
2470       continue;
2471
2472     Constant *Aliasee = J->getAliasee();
2473     GlobalValue *Target = cast<GlobalValue>(Aliasee->stripPointerCasts());
2474     Target->removeDeadConstantUsers();
2475     bool hasOneUse = Target->hasOneUse() && Aliasee->hasOneUse();
2476
2477     // Make all users of the alias use the aliasee instead.
2478     if (!J->use_empty()) {
2479       J->replaceAllUsesWith(Aliasee);
2480       ++NumAliasesResolved;
2481       Changed = true;
2482     }
2483
2484     // If the aliasee has internal linkage, give it the name and linkage
2485     // of the alias, and delete the alias.  This turns:
2486     //   define internal ... @f(...)
2487     //   @a = alias ... @f
2488     // into:
2489     //   define ... @a(...)
2490     if (!Target->hasLocalLinkage())
2491       continue;
2492
2493     // The transform is only useful if the alias does not have internal linkage.
2494     if (J->hasLocalLinkage())
2495       continue;
2496
2497     // Do not perform the transform if multiple aliases potentially target the
2498     // aliasee.  This check also ensures that it is safe to replace the section
2499     // and other attributes of the aliasee with those of the alias.
2500     if (!hasOneUse)
2501       continue;
2502
2503     // Give the aliasee the name, linkage and other attributes of the alias.
2504     Target->takeName(J);
2505     Target->setLinkage(J->getLinkage());
2506     Target->GlobalValue::copyAttributesFrom(J);
2507
2508     // Delete the alias.
2509     M.getAliasList().erase(J);
2510     ++NumAliasesRemoved;
2511     Changed = true;
2512   }
2513
2514   return Changed;
2515 }
2516
2517 bool GlobalOpt::runOnModule(Module &M) {
2518   bool Changed = false;
2519   
2520   // Try to find the llvm.globalctors list.
2521   GlobalVariable *GlobalCtors = FindGlobalCtors(M);
2522
2523   bool LocalChange = true;
2524   while (LocalChange) {
2525     LocalChange = false;
2526     
2527     // Delete functions that are trivially dead, ccc -> fastcc
2528     LocalChange |= OptimizeFunctions(M);
2529     
2530     // Optimize global_ctors list.
2531     if (GlobalCtors)
2532       LocalChange |= OptimizeGlobalCtorsList(GlobalCtors);
2533     
2534     // Optimize non-address-taken globals.
2535     LocalChange |= OptimizeGlobalVars(M);
2536
2537     // Resolve aliases, when possible.
2538     LocalChange |= OptimizeGlobalAliases(M);
2539     Changed |= LocalChange;
2540   }
2541   
2542   // TODO: Move all global ctors functions to the end of the module for code
2543   // layout.
2544   
2545   return Changed;
2546 }