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