Add some ifdef'd out debug info
[oota-llvm.git] / lib / Transforms / IPO / GlobalOpt.cpp
1 //===- GlobalOpt.cpp - Optimize Global Variables --------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
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/Support/Debug.h"
26 #include "llvm/Target/TargetData.h"
27 #include "llvm/Transforms/Utils/Local.h"
28 #include "llvm/ADT/Statistic.h"
29 #include "llvm/ADT/StringExtras.h"
30 #include <algorithm>
31 #include <iostream>
32 #include <set>
33 using namespace llvm;
34
35 namespace {
36   Statistic<> NumMarked   ("globalopt", "Number of globals marked constant");
37   Statistic<> NumSRA      ("globalopt", "Number of aggregate globals broken "
38                            "into scalars");
39   Statistic<> NumSubstitute("globalopt",
40                         "Number of globals with initializers stored into them");
41   Statistic<> NumDeleted  ("globalopt", "Number of globals deleted");
42   Statistic<> NumFnDeleted("globalopt", "Number of functions deleted");
43   Statistic<> NumGlobUses ("globalopt", "Number of global uses devirtualized");
44   Statistic<> NumLocalized("globalopt", "Number of globals localized");
45   Statistic<> NumShrunkToBool("globalopt",
46                               "Number of global vars shrunk to booleans");
47   Statistic<> NumFastCallFns("globalopt",
48                              "Number of functions converted to fastcc");
49   Statistic<> NumCtorsEvaluated("globalopt","Number of static ctors evaluated");
50
51   struct GlobalOpt : public ModulePass {
52     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
53       AU.addRequired<TargetData>();
54     }
55
56     bool runOnModule(Module &M);
57
58   private:
59     GlobalVariable *FindGlobalCtors(Module &M);
60     bool OptimizeFunctions(Module &M);
61     bool OptimizeGlobalVars(Module &M);
62     bool OptimizeGlobalCtorsList(GlobalVariable *&GCL);
63     bool ProcessInternalGlobal(GlobalVariable *GV,Module::global_iterator &GVI);
64   };
65
66   RegisterPass<GlobalOpt> X("globalopt", "Global Variable Optimizer");
67 }
68
69 ModulePass *llvm::createGlobalOptimizerPass() { return new GlobalOpt(); }
70
71 /// GlobalStatus - As we analyze each global, keep track of some information
72 /// about it.  If we find out that the address of the global is taken, none of
73 /// this info will be accurate.
74 struct GlobalStatus {
75   /// isLoaded - True if the global is ever loaded.  If the global isn't ever
76   /// loaded it can be deleted.
77   bool isLoaded;
78
79   /// StoredType - Keep track of what stores to the global look like.
80   ///
81   enum StoredType {
82     /// NotStored - There is no store to this global.  It can thus be marked
83     /// constant.
84     NotStored,
85
86     /// isInitializerStored - This global is stored to, but the only thing
87     /// stored is the constant it was initialized with.  This is only tracked
88     /// for scalar globals.
89     isInitializerStored,
90
91     /// isStoredOnce - This global is stored to, but only its initializer and
92     /// one other value is ever stored to it.  If this global isStoredOnce, we
93     /// track the value stored to it in StoredOnceValue below.  This is only
94     /// tracked for scalar globals.
95     isStoredOnce,
96
97     /// isStored - This global is stored to by multiple values or something else
98     /// that we cannot track.
99     isStored
100   } StoredType;
101
102   /// StoredOnceValue - If only one value (besides the initializer constant) is
103   /// ever stored to this global, keep track of what value it is.
104   Value *StoredOnceValue;
105
106   // AccessingFunction/HasMultipleAccessingFunctions - These start out
107   // null/false.  When the first accessing function is noticed, it is recorded.
108   // When a second different accessing function is noticed,
109   // HasMultipleAccessingFunctions is set to true.
110   Function *AccessingFunction;
111   bool HasMultipleAccessingFunctions;
112
113   // HasNonInstructionUser - Set to true if this global has a user that is not
114   // an instruction (e.g. a constant expr or GV initializer).
115   bool HasNonInstructionUser;
116
117   /// isNotSuitableForSRA - Keep track of whether any SRA preventing users of
118   /// the global exist.  Such users include GEP instruction with variable
119   /// indexes, and non-gep/load/store users like constant expr casts.
120   bool isNotSuitableForSRA;
121
122   GlobalStatus() : isLoaded(false), StoredType(NotStored), StoredOnceValue(0),
123                    AccessingFunction(0), HasMultipleAccessingFunctions(false),
124                    HasNonInstructionUser(false), isNotSuitableForSRA(false) {}
125 };
126
127
128
129 /// ConstantIsDead - Return true if the specified constant is (transitively)
130 /// dead.  The constant may be used by other constants (e.g. constant arrays and
131 /// constant exprs) as long as they are dead, but it cannot be used by anything
132 /// else.
133 static bool ConstantIsDead(Constant *C) {
134   if (isa<GlobalValue>(C)) return false;
135
136   for (Value::use_iterator UI = C->use_begin(), E = C->use_end(); UI != E; ++UI)
137     if (Constant *CU = dyn_cast<Constant>(*UI)) {
138       if (!ConstantIsDead(CU)) return false;
139     } else
140       return false;
141   return true;
142 }
143
144
145 /// AnalyzeGlobal - Look at all uses of the global and fill in the GlobalStatus
146 /// structure.  If the global has its address taken, return true to indicate we
147 /// can't do anything with it.
148 ///
149 static bool AnalyzeGlobal(Value *V, GlobalStatus &GS,
150                           std::set<PHINode*> &PHIUsers) {
151   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
152     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(*UI)) {
153       GS.HasNonInstructionUser = true;
154
155       if (AnalyzeGlobal(CE, GS, PHIUsers)) return true;
156       if (CE->getOpcode() != Instruction::GetElementPtr)
157         GS.isNotSuitableForSRA = true;
158       else if (!GS.isNotSuitableForSRA) {
159         // Check to see if this ConstantExpr GEP is SRA'able.  In particular, we
160         // don't like < 3 operand CE's, and we don't like non-constant integer
161         // indices.
162         if (CE->getNumOperands() < 3 || !CE->getOperand(1)->isNullValue())
163           GS.isNotSuitableForSRA = true;
164         else {
165           for (unsigned i = 1, e = CE->getNumOperands(); i != e; ++i)
166             if (!isa<ConstantInt>(CE->getOperand(i))) {
167               GS.isNotSuitableForSRA = true;
168               break;
169             }
170         }
171       }
172
173     } else if (Instruction *I = dyn_cast<Instruction>(*UI)) {
174       if (!GS.HasMultipleAccessingFunctions) {
175         Function *F = I->getParent()->getParent();
176         if (GS.AccessingFunction == 0)
177           GS.AccessingFunction = F;
178         else if (GS.AccessingFunction != F)
179           GS.HasMultipleAccessingFunctions = true;
180       }
181       if (isa<LoadInst>(I)) {
182         GS.isLoaded = true;
183       } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
184         // Don't allow a store OF the address, only stores TO the address.
185         if (SI->getOperand(0) == V) return true;
186
187         // If this is a direct store to the global (i.e., the global is a scalar
188         // value, not an aggregate), keep more specific information about
189         // stores.
190         if (GS.StoredType != GlobalStatus::isStored)
191           if (GlobalVariable *GV = dyn_cast<GlobalVariable>(SI->getOperand(1))){
192             Value *StoredVal = SI->getOperand(0);
193             if (StoredVal == GV->getInitializer()) {
194               if (GS.StoredType < GlobalStatus::isInitializerStored)
195                 GS.StoredType = GlobalStatus::isInitializerStored;
196             } else if (isa<LoadInst>(StoredVal) &&
197                        cast<LoadInst>(StoredVal)->getOperand(0) == GV) {
198               // G = G
199               if (GS.StoredType < GlobalStatus::isInitializerStored)
200                 GS.StoredType = GlobalStatus::isInitializerStored;
201             } else if (GS.StoredType < GlobalStatus::isStoredOnce) {
202               GS.StoredType = GlobalStatus::isStoredOnce;
203               GS.StoredOnceValue = StoredVal;
204             } else if (GS.StoredType == GlobalStatus::isStoredOnce &&
205                        GS.StoredOnceValue == StoredVal) {
206               // noop.
207             } else {
208               GS.StoredType = GlobalStatus::isStored;
209             }
210           } else {
211             GS.StoredType = GlobalStatus::isStored;
212           }
213       } else if (isa<GetElementPtrInst>(I)) {
214         if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
215
216         // If the first two indices are constants, this can be SRA'd.
217         if (isa<GlobalVariable>(I->getOperand(0))) {
218           if (I->getNumOperands() < 3 || !isa<Constant>(I->getOperand(1)) ||
219               !cast<Constant>(I->getOperand(1))->isNullValue() ||
220               !isa<ConstantInt>(I->getOperand(2)))
221             GS.isNotSuitableForSRA = true;
222         } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I->getOperand(0))){
223           if (CE->getOpcode() != Instruction::GetElementPtr ||
224               CE->getNumOperands() < 3 || I->getNumOperands() < 2 ||
225               !isa<Constant>(I->getOperand(0)) ||
226               !cast<Constant>(I->getOperand(0))->isNullValue())
227             GS.isNotSuitableForSRA = true;
228         } else {
229           GS.isNotSuitableForSRA = true;
230         }
231       } else if (isa<SelectInst>(I)) {
232         if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
233         GS.isNotSuitableForSRA = true;
234       } else if (PHINode *PN = dyn_cast<PHINode>(I)) {
235         // PHI nodes we can check just like select or GEP instructions, but we
236         // have to be careful about infinite recursion.
237         if (PHIUsers.insert(PN).second)  // Not already visited.
238           if (AnalyzeGlobal(I, GS, PHIUsers)) return true;
239         GS.isNotSuitableForSRA = true;
240       } else if (isa<SetCondInst>(I)) {
241         GS.isNotSuitableForSRA = true;
242       } else if (isa<MemCpyInst>(I) || isa<MemMoveInst>(I)) {
243         if (I->getOperand(1) == V)
244           GS.StoredType = GlobalStatus::isStored;
245         if (I->getOperand(2) == V)
246           GS.isLoaded = true;
247         GS.isNotSuitableForSRA = true;
248       } else if (isa<MemSetInst>(I)) {
249         assert(I->getOperand(1) == V && "Memset only takes one pointer!");
250         GS.StoredType = GlobalStatus::isStored;
251         GS.isNotSuitableForSRA = true;
252       } else {
253         return true;  // Any other non-load instruction might take address!
254       }
255     } else if (Constant *C = dyn_cast<Constant>(*UI)) {
256       GS.HasNonInstructionUser = true;
257       // We might have a dead and dangling constant hanging off of here.
258       if (!ConstantIsDead(C))
259         return true;
260     } else {
261       GS.HasNonInstructionUser = true;
262       // Otherwise must be some other user.
263       return true;
264     }
265
266   return false;
267 }
268
269 static Constant *getAggregateConstantElement(Constant *Agg, Constant *Idx) {
270   ConstantInt *CI = dyn_cast<ConstantInt>(Idx);
271   if (!CI) return 0;
272   unsigned IdxV = (unsigned)CI->getRawValue();
273
274   if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Agg)) {
275     if (IdxV < CS->getNumOperands()) return CS->getOperand(IdxV);
276   } else if (ConstantArray *CA = dyn_cast<ConstantArray>(Agg)) {
277     if (IdxV < CA->getNumOperands()) return CA->getOperand(IdxV);
278   } else if (ConstantPacked *CP = dyn_cast<ConstantPacked>(Agg)) {
279     if (IdxV < CP->getNumOperands()) return CP->getOperand(IdxV);
280   } else if (isa<ConstantAggregateZero>(Agg)) {
281     if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
282       if (IdxV < STy->getNumElements())
283         return Constant::getNullValue(STy->getElementType(IdxV));
284     } else if (const SequentialType *STy =
285                dyn_cast<SequentialType>(Agg->getType())) {
286       return Constant::getNullValue(STy->getElementType());
287     }
288   } else if (isa<UndefValue>(Agg)) {
289     if (const StructType *STy = dyn_cast<StructType>(Agg->getType())) {
290       if (IdxV < STy->getNumElements())
291         return UndefValue::get(STy->getElementType(IdxV));
292     } else if (const SequentialType *STy =
293                dyn_cast<SequentialType>(Agg->getType())) {
294       return UndefValue::get(STy->getElementType());
295     }
296   }
297   return 0;
298 }
299
300
301 /// CleanupConstantGlobalUsers - We just marked GV constant.  Loop over all
302 /// users of the global, cleaning up the obvious ones.  This is largely just a
303 /// quick scan over the use list to clean up the easy and obvious cruft.  This
304 /// returns true if it made a change.
305 static bool CleanupConstantGlobalUsers(Value *V, Constant *Init) {
306   bool Changed = false;
307   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;) {
308     User *U = *UI++;
309
310     if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
311       if (Init) {
312         // Replace the load with the initializer.
313         LI->replaceAllUsesWith(Init);
314         LI->eraseFromParent();
315         Changed = true;
316       }
317     } else if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
318       // Store must be unreachable or storing Init into the global.
319       SI->eraseFromParent();
320       Changed = true;
321     } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(U)) {
322       if (CE->getOpcode() == Instruction::GetElementPtr) {
323         Constant *SubInit = 0;
324         if (Init)
325           SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
326         Changed |= CleanupConstantGlobalUsers(CE, SubInit);
327       } else if (CE->getOpcode() == Instruction::Cast &&
328                  isa<PointerType>(CE->getType())) {
329         // Pointer cast, delete any stores and memsets to the global.
330         Changed |= CleanupConstantGlobalUsers(CE, 0);
331       }
332
333       if (CE->use_empty()) {
334         CE->destroyConstant();
335         Changed = true;
336       }
337     } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
338       Constant *SubInit = 0;
339       ConstantExpr *CE = 
340         dyn_cast_or_null<ConstantExpr>(ConstantFoldInstruction(GEP));
341       if (Init && CE && CE->getOpcode() == Instruction::GetElementPtr)
342         SubInit = ConstantFoldLoadThroughGEPConstantExpr(Init, CE);
343       Changed |= CleanupConstantGlobalUsers(GEP, SubInit);
344
345       if (GEP->use_empty()) {
346         GEP->eraseFromParent();
347         Changed = true;
348       }
349     } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(U)) { // memset/cpy/mv
350       if (MI->getRawDest() == V) {
351         MI->eraseFromParent();
352         Changed = true;
353       }
354
355     } else if (Constant *C = dyn_cast<Constant>(U)) {
356       // If we have a chain of dead constantexprs or other things dangling from
357       // us, and if they are all dead, nuke them without remorse.
358       if (ConstantIsDead(C)) {
359         C->destroyConstant();
360         // This could have invalidated UI, start over from scratch.
361         CleanupConstantGlobalUsers(V, Init);
362         return true;
363       }
364     }
365   }
366   return Changed;
367 }
368
369 /// SRAGlobal - Perform scalar replacement of aggregates on the specified global
370 /// variable.  This opens the door for other optimizations by exposing the
371 /// behavior of the program in a more fine-grained way.  We have determined that
372 /// this transformation is safe already.  We return the first global variable we
373 /// insert so that the caller can reprocess it.
374 static GlobalVariable *SRAGlobal(GlobalVariable *GV) {
375   assert(GV->hasInternalLinkage() && !GV->isConstant());
376   Constant *Init = GV->getInitializer();
377   const Type *Ty = Init->getType();
378
379   std::vector<GlobalVariable*> NewGlobals;
380   Module::GlobalListType &Globals = GV->getParent()->getGlobalList();
381
382   if (const StructType *STy = dyn_cast<StructType>(Ty)) {
383     NewGlobals.reserve(STy->getNumElements());
384     for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
385       Constant *In = getAggregateConstantElement(Init,
386                                             ConstantUInt::get(Type::UIntTy, i));
387       assert(In && "Couldn't get element of initializer?");
388       GlobalVariable *NGV = new GlobalVariable(STy->getElementType(i), false,
389                                                GlobalVariable::InternalLinkage,
390                                                In, GV->getName()+"."+utostr(i));
391       Globals.insert(GV, NGV);
392       NewGlobals.push_back(NGV);
393     }
394   } else if (const SequentialType *STy = dyn_cast<SequentialType>(Ty)) {
395     unsigned NumElements = 0;
396     if (const ArrayType *ATy = dyn_cast<ArrayType>(STy))
397       NumElements = ATy->getNumElements();
398     else if (const PackedType *PTy = dyn_cast<PackedType>(STy))
399       NumElements = PTy->getNumElements();
400     else
401       assert(0 && "Unknown aggregate sequential type!");
402
403     if (NumElements > 16 && GV->hasNUsesOrMore(16))
404       return 0; // It's not worth it.
405     NewGlobals.reserve(NumElements);
406     for (unsigned i = 0, e = NumElements; i != e; ++i) {
407       Constant *In = getAggregateConstantElement(Init,
408                                             ConstantUInt::get(Type::UIntTy, i));
409       assert(In && "Couldn't get element of initializer?");
410
411       GlobalVariable *NGV = new GlobalVariable(STy->getElementType(), false,
412                                                GlobalVariable::InternalLinkage,
413                                                In, GV->getName()+"."+utostr(i));
414       Globals.insert(GV, NGV);
415       NewGlobals.push_back(NGV);
416     }
417   }
418
419   if (NewGlobals.empty())
420     return 0;
421
422   DEBUG(std::cerr << "PERFORMING GLOBAL SRA ON: " << *GV);
423
424   Constant *NullInt = Constant::getNullValue(Type::IntTy);
425
426   // Loop over all of the uses of the global, replacing the constantexpr geps,
427   // with smaller constantexpr geps or direct references.
428   while (!GV->use_empty()) {
429     User *GEP = GV->use_back();
430     assert(((isa<ConstantExpr>(GEP) &&
431              cast<ConstantExpr>(GEP)->getOpcode()==Instruction::GetElementPtr)||
432             isa<GetElementPtrInst>(GEP)) && "NonGEP CE's are not SRAable!");
433
434     // Ignore the 1th operand, which has to be zero or else the program is quite
435     // broken (undefined).  Get the 2nd operand, which is the structure or array
436     // index.
437     unsigned Val =
438        (unsigned)cast<ConstantInt>(GEP->getOperand(2))->getRawValue();
439     if (Val >= NewGlobals.size()) Val = 0; // Out of bound array access.
440
441     Value *NewPtr = NewGlobals[Val];
442
443     // Form a shorter GEP if needed.
444     if (GEP->getNumOperands() > 3)
445       if (ConstantExpr *CE = dyn_cast<ConstantExpr>(GEP)) {
446         std::vector<Constant*> Idxs;
447         Idxs.push_back(NullInt);
448         for (unsigned i = 3, e = CE->getNumOperands(); i != e; ++i)
449           Idxs.push_back(CE->getOperand(i));
450         NewPtr = ConstantExpr::getGetElementPtr(cast<Constant>(NewPtr), Idxs);
451       } else {
452         GetElementPtrInst *GEPI = cast<GetElementPtrInst>(GEP);
453         std::vector<Value*> Idxs;
454         Idxs.push_back(NullInt);
455         for (unsigned i = 3, e = GEPI->getNumOperands(); i != e; ++i)
456           Idxs.push_back(GEPI->getOperand(i));
457         NewPtr = new GetElementPtrInst(NewPtr, Idxs,
458                                        GEPI->getName()+"."+utostr(Val), GEPI);
459       }
460     GEP->replaceAllUsesWith(NewPtr);
461
462     if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(GEP))
463       GEPI->eraseFromParent();
464     else
465       cast<ConstantExpr>(GEP)->destroyConstant();
466   }
467
468   // Delete the old global, now that it is dead.
469   Globals.erase(GV);
470   ++NumSRA;
471
472   // Loop over the new globals array deleting any globals that are obviously
473   // dead.  This can arise due to scalarization of a structure or an array that
474   // has elements that are dead.
475   unsigned FirstGlobal = 0;
476   for (unsigned i = 0, e = NewGlobals.size(); i != e; ++i)
477     if (NewGlobals[i]->use_empty()) {
478       Globals.erase(NewGlobals[i]);
479       if (FirstGlobal == i) ++FirstGlobal;
480     }
481
482   return FirstGlobal != NewGlobals.size() ? NewGlobals[FirstGlobal] : 0;
483 }
484
485 /// AllUsesOfValueWillTrapIfNull - Return true if all users of the specified
486 /// value will trap if the value is dynamically null.
487 static bool AllUsesOfValueWillTrapIfNull(Value *V) {
488   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
489     if (isa<LoadInst>(*UI)) {
490       // Will trap.
491     } else if (StoreInst *SI = dyn_cast<StoreInst>(*UI)) {
492       if (SI->getOperand(0) == V) {
493         //std::cerr << "NONTRAPPING USE: " << **UI;
494         return false;  // Storing the value.
495       }
496     } else if (CallInst *CI = dyn_cast<CallInst>(*UI)) {
497       if (CI->getOperand(0) != V) {
498         //std::cerr << "NONTRAPPING USE: " << **UI;
499         return false;  // Not calling the ptr
500       }
501     } else if (InvokeInst *II = dyn_cast<InvokeInst>(*UI)) {
502       if (II->getOperand(0) != V) {
503         //std::cerr << "NONTRAPPING USE: " << **UI;
504         return false;  // Not calling the ptr
505       }
506     } else if (CastInst *CI = dyn_cast<CastInst>(*UI)) {
507       if (!AllUsesOfValueWillTrapIfNull(CI)) return false;
508     } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(*UI)) {
509       if (!AllUsesOfValueWillTrapIfNull(GEPI)) return false;
510     } else if (isa<SetCondInst>(*UI) &&
511                isa<ConstantPointerNull>(UI->getOperand(1))) {
512       // Ignore setcc X, null
513     } else {
514       //std::cerr << "NONTRAPPING USE: " << **UI;
515       return false;
516     }
517   return true;
518 }
519
520 /// AllUsesOfLoadedValueWillTrapIfNull - Return true if all uses of any loads
521 /// from GV will trap if the loaded value is null.  Note that this also permits
522 /// comparisons of the loaded value against null, as a special case.
523 static bool AllUsesOfLoadedValueWillTrapIfNull(GlobalVariable *GV) {
524   for (Value::use_iterator UI = GV->use_begin(), E = GV->use_end(); UI!=E; ++UI)
525     if (LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
526       if (!AllUsesOfValueWillTrapIfNull(LI))
527         return false;
528     } else if (isa<StoreInst>(*UI)) {
529       // Ignore stores to the global.
530     } else {
531       // We don't know or understand this user, bail out.
532       //std::cerr << "UNKNOWN USER OF GLOBAL!: " << **UI;
533       return false;
534     }
535
536   return true;
537 }
538
539 static bool OptimizeAwayTrappingUsesOfValue(Value *V, Constant *NewV) {
540   bool Changed = false;
541   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ) {
542     Instruction *I = cast<Instruction>(*UI++);
543     if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
544       LI->setOperand(0, NewV);
545       Changed = true;
546     } else if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
547       if (SI->getOperand(1) == V) {
548         SI->setOperand(1, NewV);
549         Changed = true;
550       }
551     } else if (isa<CallInst>(I) || isa<InvokeInst>(I)) {
552       if (I->getOperand(0) == V) {
553         // Calling through the pointer!  Turn into a direct call, but be careful
554         // that the pointer is not also being passed as an argument.
555         I->setOperand(0, NewV);
556         Changed = true;
557         bool PassedAsArg = false;
558         for (unsigned i = 1, e = I->getNumOperands(); i != e; ++i)
559           if (I->getOperand(i) == V) {
560             PassedAsArg = true;
561             I->setOperand(i, NewV);
562           }
563
564         if (PassedAsArg) {
565           // Being passed as an argument also.  Be careful to not invalidate UI!
566           UI = V->use_begin();
567         }
568       }
569     } else if (CastInst *CI = dyn_cast<CastInst>(I)) {
570       Changed |= OptimizeAwayTrappingUsesOfValue(CI,
571                                     ConstantExpr::getCast(NewV, CI->getType()));
572       if (CI->use_empty()) {
573         Changed = true;
574         CI->eraseFromParent();
575       }
576     } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(I)) {
577       // Should handle GEP here.
578       std::vector<Constant*> Indices;
579       Indices.reserve(GEPI->getNumOperands()-1);
580       for (unsigned i = 1, e = GEPI->getNumOperands(); i != e; ++i)
581         if (Constant *C = dyn_cast<Constant>(GEPI->getOperand(i)))
582           Indices.push_back(C);
583         else
584           break;
585       if (Indices.size() == GEPI->getNumOperands()-1)
586         Changed |= OptimizeAwayTrappingUsesOfValue(GEPI,
587                                 ConstantExpr::getGetElementPtr(NewV, Indices));
588       if (GEPI->use_empty()) {
589         Changed = true;
590         GEPI->eraseFromParent();
591       }
592     }
593   }
594
595   return Changed;
596 }
597
598
599 /// OptimizeAwayTrappingUsesOfLoads - The specified global has only one non-null
600 /// value stored into it.  If there are uses of the loaded value that would trap
601 /// if the loaded value is dynamically null, then we know that they cannot be
602 /// reachable with a null optimize away the load.
603 static bool OptimizeAwayTrappingUsesOfLoads(GlobalVariable *GV, Constant *LV) {
604   std::vector<LoadInst*> Loads;
605   bool Changed = false;
606
607   // Replace all uses of loads with uses of uses of the stored value.
608   for (Value::use_iterator GUI = GV->use_begin(), E = GV->use_end();
609        GUI != E; ++GUI)
610     if (LoadInst *LI = dyn_cast<LoadInst>(*GUI)) {
611       Loads.push_back(LI);
612       Changed |= OptimizeAwayTrappingUsesOfValue(LI, LV);
613     } else {
614       assert(isa<StoreInst>(*GUI) && "Only expect load and stores!");
615     }
616
617   if (Changed) {
618     DEBUG(std::cerr << "OPTIMIZED LOADS FROM STORED ONCE POINTER: " << *GV);
619     ++NumGlobUses;
620   }
621
622   // Delete all of the loads we can, keeping track of whether we nuked them all!
623   bool AllLoadsGone = true;
624   while (!Loads.empty()) {
625     LoadInst *L = Loads.back();
626     if (L->use_empty()) {
627       L->eraseFromParent();
628       Changed = true;
629     } else {
630       AllLoadsGone = false;
631     }
632     Loads.pop_back();
633   }
634
635   // If we nuked all of the loads, then none of the stores are needed either,
636   // nor is the global.
637   if (AllLoadsGone) {
638     DEBUG(std::cerr << "  *** GLOBAL NOW DEAD!\n");
639     CleanupConstantGlobalUsers(GV, 0);
640     if (GV->use_empty()) {
641       GV->eraseFromParent();
642       ++NumDeleted;
643     }
644     Changed = true;
645   }
646   return Changed;
647 }
648
649 /// ConstantPropUsersOf - Walk the use list of V, constant folding all of the
650 /// instructions that are foldable.
651 static void ConstantPropUsersOf(Value *V) {
652   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; )
653     if (Instruction *I = dyn_cast<Instruction>(*UI++))
654       if (Constant *NewC = ConstantFoldInstruction(I)) {
655         I->replaceAllUsesWith(NewC);
656
657         // Advance UI to the next non-I use to avoid invalidating it!
658         // Instructions could multiply use V.
659         while (UI != E && *UI == I)
660           ++UI;
661         I->eraseFromParent();
662       }
663 }
664
665 /// OptimizeGlobalAddressOfMalloc - This function takes the specified global
666 /// variable, and transforms the program as if it always contained the result of
667 /// the specified malloc.  Because it is always the result of the specified
668 /// malloc, there is no reason to actually DO the malloc.  Instead, turn the
669 /// malloc into a global, and any laods of GV as uses of the new global.
670 static GlobalVariable *OptimizeGlobalAddressOfMalloc(GlobalVariable *GV,
671                                                      MallocInst *MI) {
672   DEBUG(std::cerr << "PROMOTING MALLOC GLOBAL: " << *GV << "  MALLOC = " <<*MI);
673   ConstantInt *NElements = cast<ConstantInt>(MI->getArraySize());
674
675   if (NElements->getRawValue() != 1) {
676     // If we have an array allocation, transform it to a single element
677     // allocation to make the code below simpler.
678     Type *NewTy = ArrayType::get(MI->getAllocatedType(),
679                                  (unsigned)NElements->getRawValue());
680     MallocInst *NewMI =
681       new MallocInst(NewTy, Constant::getNullValue(Type::UIntTy),
682                      MI->getAlignment(), MI->getName(), MI);
683     std::vector<Value*> Indices;
684     Indices.push_back(Constant::getNullValue(Type::IntTy));
685     Indices.push_back(Indices[0]);
686     Value *NewGEP = new GetElementPtrInst(NewMI, Indices,
687                                           NewMI->getName()+".el0", MI);
688     MI->replaceAllUsesWith(NewGEP);
689     MI->eraseFromParent();
690     MI = NewMI;
691   }
692
693   // Create the new global variable.  The contents of the malloc'd memory is
694   // undefined, so initialize with an undef value.
695   Constant *Init = UndefValue::get(MI->getAllocatedType());
696   GlobalVariable *NewGV = new GlobalVariable(MI->getAllocatedType(), false,
697                                              GlobalValue::InternalLinkage, Init,
698                                              GV->getName()+".body");
699   GV->getParent()->getGlobalList().insert(GV, NewGV);
700
701   // Anything that used the malloc now uses the global directly.
702   MI->replaceAllUsesWith(NewGV);
703
704   Constant *RepValue = NewGV;
705   if (NewGV->getType() != GV->getType()->getElementType())
706     RepValue = ConstantExpr::getCast(RepValue, GV->getType()->getElementType());
707
708   // If there is a comparison against null, we will insert a global bool to
709   // keep track of whether the global was initialized yet or not.
710   GlobalVariable *InitBool =
711     new GlobalVariable(Type::BoolTy, false, GlobalValue::InternalLinkage,
712                        ConstantBool::getFalse(), GV->getName()+".init");
713   bool InitBoolUsed = false;
714
715   // Loop over all uses of GV, processing them in turn.
716   std::vector<StoreInst*> Stores;
717   while (!GV->use_empty())
718     if (LoadInst *LI = dyn_cast<LoadInst>(GV->use_back())) {
719       while (!LI->use_empty()) {
720         Use &LoadUse = LI->use_begin().getUse();
721         if (!isa<SetCondInst>(LoadUse.getUser()))
722           LoadUse = RepValue;
723         else {
724           // Replace the setcc X, 0 with a use of the bool value.
725           SetCondInst *SCI = cast<SetCondInst>(LoadUse.getUser());
726           Value *LV = new LoadInst(InitBool, InitBool->getName()+".val", SCI);
727           InitBoolUsed = true;
728           switch (SCI->getOpcode()) {
729           default: assert(0 && "Unknown opcode!");
730           case Instruction::SetLT:
731             LV = ConstantBool::getFalse();   // X < null -> always false
732             break;
733           case Instruction::SetEQ:
734           case Instruction::SetLE:
735             LV = BinaryOperator::createNot(LV, "notinit", SCI);
736             break;
737           case Instruction::SetNE:
738           case Instruction::SetGE:
739           case Instruction::SetGT:
740             break;  // no change.
741           }
742           SCI->replaceAllUsesWith(LV);
743           SCI->eraseFromParent();
744         }
745       }
746       LI->eraseFromParent();
747     } else {
748       StoreInst *SI = cast<StoreInst>(GV->use_back());
749       // The global is initialized when the store to it occurs.
750       new StoreInst(ConstantBool::getTrue(), InitBool, SI);
751       SI->eraseFromParent();
752     }
753
754   // If the initialization boolean was used, insert it, otherwise delete it.
755   if (!InitBoolUsed) {
756     while (!InitBool->use_empty())  // Delete initializations
757       cast<Instruction>(InitBool->use_back())->eraseFromParent();
758     delete InitBool;
759   } else
760     GV->getParent()->getGlobalList().insert(GV, InitBool);
761
762
763   // Now the GV is dead, nuke it and the malloc.
764   GV->eraseFromParent();
765   MI->eraseFromParent();
766
767   // To further other optimizations, loop over all users of NewGV and try to
768   // constant prop them.  This will promote GEP instructions with constant
769   // indices into GEP constant-exprs, which will allow global-opt to hack on it.
770   ConstantPropUsersOf(NewGV);
771   if (RepValue != NewGV)
772     ConstantPropUsersOf(RepValue);
773
774   return NewGV;
775 }
776
777 /// ValueIsOnlyUsedLocallyOrStoredToOneGlobal - Scan the use-list of V checking
778 /// to make sure that there are no complex uses of V.  We permit simple things
779 /// like dereferencing the pointer, but not storing through the address, unless
780 /// it is to the specified global.
781 static bool ValueIsOnlyUsedLocallyOrStoredToOneGlobal(Instruction *V,
782                                                       GlobalVariable *GV) {
783   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI)
784     if (isa<LoadInst>(*UI) || isa<SetCondInst>(*UI)) {
785       // Fine, ignore.
786     } else if (StoreInst *SI = dyn_cast<StoreInst>(*UI)) {
787       if (SI->getOperand(0) == V && SI->getOperand(1) != GV)
788         return false;  // Storing the pointer itself... bad.
789       // Otherwise, storing through it, or storing into GV... fine.
790     } else if (isa<GetElementPtrInst>(*UI) || isa<SelectInst>(*UI)) {
791       if (!ValueIsOnlyUsedLocallyOrStoredToOneGlobal(cast<Instruction>(*UI),GV))
792         return false;
793     } else {
794       return false;
795     }
796   return true;
797
798 }
799
800 // OptimizeOnceStoredGlobal - Try to optimize globals based on the knowledge
801 // that only one value (besides its initializer) is ever stored to the global.
802 static bool OptimizeOnceStoredGlobal(GlobalVariable *GV, Value *StoredOnceVal,
803                                      Module::global_iterator &GVI,
804                                      TargetData &TD) {
805   if (CastInst *CI = dyn_cast<CastInst>(StoredOnceVal))
806     StoredOnceVal = CI->getOperand(0);
807   else if (GetElementPtrInst *GEPI =dyn_cast<GetElementPtrInst>(StoredOnceVal)){
808     // "getelementptr Ptr, 0, 0, 0" is really just a cast.
809     bool IsJustACast = true;
810     for (unsigned i = 1, e = GEPI->getNumOperands(); i != e; ++i)
811       if (!isa<Constant>(GEPI->getOperand(i)) ||
812           !cast<Constant>(GEPI->getOperand(i))->isNullValue()) {
813         IsJustACast = false;
814         break;
815       }
816     if (IsJustACast)
817       StoredOnceVal = GEPI->getOperand(0);
818   }
819
820   // If we are dealing with a pointer global that is initialized to null and
821   // only has one (non-null) value stored into it, then we can optimize any
822   // users of the loaded value (often calls and loads) that would trap if the
823   // value was null.
824   if (isa<PointerType>(GV->getInitializer()->getType()) &&
825       GV->getInitializer()->isNullValue()) {
826     if (Constant *SOVC = dyn_cast<Constant>(StoredOnceVal)) {
827       if (GV->getInitializer()->getType() != SOVC->getType())
828         SOVC = ConstantExpr::getCast(SOVC, GV->getInitializer()->getType());
829
830       // Optimize away any trapping uses of the loaded value.
831       if (OptimizeAwayTrappingUsesOfLoads(GV, SOVC))
832         return true;
833     } else if (MallocInst *MI = dyn_cast<MallocInst>(StoredOnceVal)) {
834       // If this is a malloc of an abstract type, don't touch it.
835       if (!MI->getAllocatedType()->isSized())
836         return false;
837       
838       // If we have a global that is only initialized with a fixed size malloc,
839       // and if all users of the malloc trap, and if the malloc'd address is not
840       // put anywhere else, transform the program to use global memory instead
841       // of malloc'd memory.  This eliminates dynamic allocation (good) and
842       // exposes the resultant global to further GlobalOpt (even better).  Note
843       // that we restrict this transformation to only working on small
844       // allocations (2048 bytes currently), as we don't want to introduce a 16M
845       // global or something.
846       if (ConstantInt *NElements = dyn_cast<ConstantInt>(MI->getArraySize())) {
847         if (NElements->getRawValue()*
848                      TD.getTypeSize(MI->getAllocatedType()) < 2048 &&
849             AllUsesOfLoadedValueWillTrapIfNull(GV) &&
850             ValueIsOnlyUsedLocallyOrStoredToOneGlobal(MI, GV)) {
851           GVI = OptimizeGlobalAddressOfMalloc(GV, MI);
852           return true;
853         }
854       }
855     }
856   }
857
858   return false;
859 }
860
861 /// ShrinkGlobalToBoolean - At this point, we have learned that the only two
862 /// values ever stored into GV are its initializer and OtherVal.
863 static void ShrinkGlobalToBoolean(GlobalVariable *GV, Constant *OtherVal) {
864   // Create the new global, initializing it to false.
865   GlobalVariable *NewGV = new GlobalVariable(Type::BoolTy, false,
866          GlobalValue::InternalLinkage, ConstantBool::getFalse(),
867                                              GV->getName()+".b");
868   GV->getParent()->getGlobalList().insert(GV, NewGV);
869
870   Constant *InitVal = GV->getInitializer();
871   assert(InitVal->getType() != Type::BoolTy && "No reason to shrink to bool!");
872
873   // If initialized to zero and storing one into the global, we can use a cast
874   // instead of a select to synthesize the desired value.
875   bool IsOneZero = false;
876   if (ConstantInt *CI = dyn_cast<ConstantInt>(OtherVal))
877     IsOneZero = InitVal->isNullValue() && CI->equalsInt(1);
878
879   while (!GV->use_empty()) {
880     Instruction *UI = cast<Instruction>(GV->use_back());
881     if (StoreInst *SI = dyn_cast<StoreInst>(UI)) {
882       // Change the store into a boolean store.
883       bool StoringOther = SI->getOperand(0) == OtherVal;
884       // Only do this if we weren't storing a loaded value.
885       Value *StoreVal;
886       if (StoringOther || SI->getOperand(0) == InitVal)
887         StoreVal = ConstantBool::get(StoringOther);
888       else {
889         // Otherwise, we are storing a previously loaded copy.  To do this,
890         // change the copy from copying the original value to just copying the
891         // bool.
892         Instruction *StoredVal = cast<Instruction>(SI->getOperand(0));
893
894         // If we're already replaced the input, StoredVal will be a cast or
895         // select instruction.  If not, it will be a load of the original
896         // global.
897         if (LoadInst *LI = dyn_cast<LoadInst>(StoredVal)) {
898           assert(LI->getOperand(0) == GV && "Not a copy!");
899           // Insert a new load, to preserve the saved value.
900           StoreVal = new LoadInst(NewGV, LI->getName()+".b", LI);
901         } else {
902           assert((isa<CastInst>(StoredVal) || isa<SelectInst>(StoredVal)) &&
903                  "This is not a form that we understand!");
904           StoreVal = StoredVal->getOperand(0);
905           assert(isa<LoadInst>(StoreVal) && "Not a load of NewGV!");
906         }
907       }
908       new StoreInst(StoreVal, NewGV, SI);
909     } else if (!UI->use_empty()) {
910       // Change the load into a load of bool then a select.
911       LoadInst *LI = cast<LoadInst>(UI);
912
913       std::string Name = LI->getName(); LI->setName("");
914       LoadInst *NLI = new LoadInst(NewGV, Name+".b", LI);
915       Value *NSI;
916       if (IsOneZero)
917         NSI = new CastInst(NLI, LI->getType(), Name, LI);
918       else
919         NSI = new SelectInst(NLI, OtherVal, InitVal, Name, LI);
920       LI->replaceAllUsesWith(NSI);
921     }
922     UI->eraseFromParent();
923   }
924
925   GV->eraseFromParent();
926 }
927
928
929 /// ProcessInternalGlobal - Analyze the specified global variable and optimize
930 /// it if possible.  If we make a change, return true.
931 bool GlobalOpt::ProcessInternalGlobal(GlobalVariable *GV,
932                                       Module::global_iterator &GVI) {
933   std::set<PHINode*> PHIUsers;
934   GlobalStatus GS;
935   GV->removeDeadConstantUsers();
936
937   if (GV->use_empty()) {
938     DEBUG(std::cerr << "GLOBAL DEAD: " << *GV);
939     GV->eraseFromParent();
940     ++NumDeleted;
941     return true;
942   }
943
944   if (!AnalyzeGlobal(GV, GS, PHIUsers)) {
945 #if 0
946     std::cerr << "Global: " << *GV;
947     std::cerr << "  isLoaded = " << GS.isLoaded << "\n";
948     std::cerr << "  StoredType = ";
949     switch (GS.StoredType) {
950     case GlobalStatus::NotStored: std::cerr << "NEVER STORED\n"; break;
951     case GlobalStatus::isInitializerStored: std::cerr << "INIT STORED\n"; break;
952     case GlobalStatus::isStoredOnce: std::cerr << "STORED ONCE\n"; break;
953     case GlobalStatus::isStored: std::cerr << "stored\n"; break;
954     }
955     if (GS.StoredType == GlobalStatus::isStoredOnce && GS.StoredOnceValue)
956       std::cerr << "  StoredOnceValue = " << *GS.StoredOnceValue << "\n";
957     if (GS.AccessingFunction && !GS.HasMultipleAccessingFunctions)
958       std::cerr << "  AccessingFunction = " << GS.AccessingFunction->getName()
959                 << "\n";
960     std::cerr << "  HasMultipleAccessingFunctions =  "
961               << GS.HasMultipleAccessingFunctions << "\n";
962     std::cerr << "  HasNonInstructionUser = " << GS.HasNonInstructionUser<<"\n";
963     std::cerr << "  isNotSuitableForSRA = " << GS.isNotSuitableForSRA << "\n";
964     std::cerr << "\n";
965 #endif
966     
967     // If this is a first class global and has only one accessing function
968     // and this function is main (which we know is not recursive we can make
969     // this global a local variable) we replace the global with a local alloca
970     // in this function.
971     //
972     // NOTE: It doesn't make sense to promote non first class types since we
973     // are just replacing static memory to stack memory.
974     if (!GS.HasMultipleAccessingFunctions &&
975         GS.AccessingFunction && !GS.HasNonInstructionUser &&
976         GV->getType()->getElementType()->isFirstClassType() &&
977         GS.AccessingFunction->getName() == "main" &&
978         GS.AccessingFunction->hasExternalLinkage()) {
979       DEBUG(std::cerr << "LOCALIZING GLOBAL: " << *GV);
980       Instruction* FirstI = GS.AccessingFunction->getEntryBlock().begin();
981       const Type* ElemTy = GV->getType()->getElementType();
982       // FIXME: Pass Global's alignment when globals have alignment
983       AllocaInst* Alloca = new AllocaInst(ElemTy, NULL, GV->getName(), FirstI);
984       if (!isa<UndefValue>(GV->getInitializer()))
985         new StoreInst(GV->getInitializer(), Alloca, FirstI);
986
987       GV->replaceAllUsesWith(Alloca);
988       GV->eraseFromParent();
989       ++NumLocalized;
990       return true;
991     }
992     
993     // If the global is never loaded (but may be stored to), it is dead.
994     // Delete it now.
995     if (!GS.isLoaded) {
996       DEBUG(std::cerr << "GLOBAL NEVER LOADED: " << *GV);
997
998       // Delete any stores we can find to the global.  We may not be able to
999       // make it completely dead though.
1000       bool Changed = CleanupConstantGlobalUsers(GV, GV->getInitializer());
1001
1002       // If the global is dead now, delete it.
1003       if (GV->use_empty()) {
1004         GV->eraseFromParent();
1005         ++NumDeleted;
1006         Changed = true;
1007       }
1008       return Changed;
1009
1010     } else if (GS.StoredType <= GlobalStatus::isInitializerStored) {
1011       DEBUG(std::cerr << "MARKING CONSTANT: " << *GV);
1012       GV->setConstant(true);
1013
1014       // Clean up any obviously simplifiable users now.
1015       CleanupConstantGlobalUsers(GV, GV->getInitializer());
1016
1017       // If the global is dead now, just nuke it.
1018       if (GV->use_empty()) {
1019         DEBUG(std::cerr << "   *** Marking constant allowed us to simplify "
1020               "all users and delete global!\n");
1021         GV->eraseFromParent();
1022         ++NumDeleted;
1023       }
1024
1025       ++NumMarked;
1026       return true;
1027     } else if (!GS.isNotSuitableForSRA &&
1028                !GV->getInitializer()->getType()->isFirstClassType()) {
1029       if (GlobalVariable *FirstNewGV = SRAGlobal(GV)) {
1030         GVI = FirstNewGV;  // Don't skip the newly produced globals!
1031         return true;
1032       }
1033     } else if (GS.StoredType == GlobalStatus::isStoredOnce) {
1034       // If the initial value for the global was an undef value, and if only
1035       // one other value was stored into it, we can just change the
1036       // initializer to be an undef value, then delete all stores to the
1037       // global.  This allows us to mark it constant.
1038       if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1039         if (isa<UndefValue>(GV->getInitializer())) {
1040           // Change the initial value here.
1041           GV->setInitializer(SOVConstant);
1042
1043           // Clean up any obviously simplifiable users now.
1044           CleanupConstantGlobalUsers(GV, GV->getInitializer());
1045
1046           if (GV->use_empty()) {
1047             DEBUG(std::cerr << "   *** Substituting initializer allowed us to "
1048                   "simplify all users and delete global!\n");
1049             GV->eraseFromParent();
1050             ++NumDeleted;
1051           } else {
1052             GVI = GV;
1053           }
1054           ++NumSubstitute;
1055           return true;
1056         }
1057
1058       // Try to optimize globals based on the knowledge that only one value
1059       // (besides its initializer) is ever stored to the global.
1060       if (OptimizeOnceStoredGlobal(GV, GS.StoredOnceValue, GVI,
1061                                    getAnalysis<TargetData>()))
1062         return true;
1063
1064       // Otherwise, if the global was not a boolean, we can shrink it to be a
1065       // boolean.
1066       if (Constant *SOVConstant = dyn_cast<Constant>(GS.StoredOnceValue))
1067         if (GV->getType()->getElementType() != Type::BoolTy &&
1068             !GV->getType()->getElementType()->isFloatingPoint()) {
1069           DEBUG(std::cerr << "   *** SHRINKING TO BOOL: " << *GV);
1070           ShrinkGlobalToBoolean(GV, SOVConstant);
1071           ++NumShrunkToBool;
1072           return true;
1073         }
1074     }
1075   }
1076   return false;
1077 }
1078
1079 /// OnlyCalledDirectly - Return true if the specified function is only called
1080 /// directly.  In other words, its address is never taken.
1081 static bool OnlyCalledDirectly(Function *F) {
1082   for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
1083     Instruction *User = dyn_cast<Instruction>(*UI);
1084     if (!User) return false;
1085     if (!isa<CallInst>(User) && !isa<InvokeInst>(User)) return false;
1086
1087     // See if the function address is passed as an argument.
1088     for (unsigned i = 1, e = User->getNumOperands(); i != e; ++i)
1089       if (User->getOperand(i) == F) return false;
1090   }
1091   return true;
1092 }
1093
1094 /// ChangeCalleesToFastCall - Walk all of the direct calls of the specified
1095 /// function, changing them to FastCC.
1096 static void ChangeCalleesToFastCall(Function *F) {
1097   for (Value::use_iterator UI = F->use_begin(), E = F->use_end(); UI != E;++UI){
1098     Instruction *User = cast<Instruction>(*UI);
1099     if (CallInst *CI = dyn_cast<CallInst>(User))
1100       CI->setCallingConv(CallingConv::Fast);
1101     else
1102       cast<InvokeInst>(User)->setCallingConv(CallingConv::Fast);
1103   }
1104 }
1105
1106 bool GlobalOpt::OptimizeFunctions(Module &M) {
1107   bool Changed = false;
1108   // Optimize functions.
1109   for (Module::iterator FI = M.begin(), E = M.end(); FI != E; ) {
1110     Function *F = FI++;
1111     F->removeDeadConstantUsers();
1112     if (F->use_empty() && (F->hasInternalLinkage() ||
1113                            F->hasLinkOnceLinkage())) {
1114       M.getFunctionList().erase(F);
1115       Changed = true;
1116       ++NumFnDeleted;
1117     } else if (F->hasInternalLinkage() &&
1118                F->getCallingConv() == CallingConv::C &&  !F->isVarArg() &&
1119                OnlyCalledDirectly(F)) {
1120       // If this function has C calling conventions, is not a varargs
1121       // function, and is only called directly, promote it to use the Fast
1122       // calling convention.
1123       F->setCallingConv(CallingConv::Fast);
1124       ChangeCalleesToFastCall(F);
1125       ++NumFastCallFns;
1126       Changed = true;
1127     }
1128   }
1129   return Changed;
1130 }
1131
1132 bool GlobalOpt::OptimizeGlobalVars(Module &M) {
1133   bool Changed = false;
1134   for (Module::global_iterator GVI = M.global_begin(), E = M.global_end();
1135        GVI != E; ) {
1136     GlobalVariable *GV = GVI++;
1137     if (!GV->isConstant() && GV->hasInternalLinkage() &&
1138         GV->hasInitializer())
1139       Changed |= ProcessInternalGlobal(GV, GVI);
1140   }
1141   return Changed;
1142 }
1143
1144 /// FindGlobalCtors - Find the llvm.globalctors list, verifying that all
1145 /// initializers have an init priority of 65535.
1146 GlobalVariable *GlobalOpt::FindGlobalCtors(Module &M) {
1147   for (Module::global_iterator I = M.global_begin(), E = M.global_end();
1148        I != E; ++I)
1149     if (I->getName() == "llvm.global_ctors") {
1150       // Found it, verify it's an array of { int, void()* }.
1151       const ArrayType *ATy =dyn_cast<ArrayType>(I->getType()->getElementType());
1152       if (!ATy) return 0;
1153       const StructType *STy = dyn_cast<StructType>(ATy->getElementType());
1154       if (!STy || STy->getNumElements() != 2 ||
1155           STy->getElementType(0) != Type::IntTy) return 0;
1156       const PointerType *PFTy = dyn_cast<PointerType>(STy->getElementType(1));
1157       if (!PFTy) return 0;
1158       const FunctionType *FTy = dyn_cast<FunctionType>(PFTy->getElementType());
1159       if (!FTy || FTy->getReturnType() != Type::VoidTy || FTy->isVarArg() ||
1160           FTy->getNumParams() != 0)
1161         return 0;
1162       
1163       // Verify that the initializer is simple enough for us to handle.
1164       if (!I->hasInitializer()) return 0;
1165       ConstantArray *CA = dyn_cast<ConstantArray>(I->getInitializer());
1166       if (!CA) return 0;
1167       for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1168         if (ConstantStruct *CS = dyn_cast<ConstantStruct>(CA->getOperand(i))) {
1169           if (isa<ConstantPointerNull>(CS->getOperand(1)))
1170             continue;
1171
1172           // Must have a function or null ptr.
1173           if (!isa<Function>(CS->getOperand(1)))
1174             return 0;
1175           
1176           // Init priority must be standard.
1177           ConstantInt *CI = dyn_cast<ConstantInt>(CS->getOperand(0));
1178           if (!CI || CI->getRawValue() != 65535)
1179             return 0;
1180         } else {
1181           return 0;
1182         }
1183       
1184       return I;
1185     }
1186   return 0;
1187 }
1188
1189 /// ParseGlobalCtors - Given a llvm.global_ctors list that we can understand,
1190 /// return a list of the functions and null terminator as a vector.
1191 static std::vector<Function*> ParseGlobalCtors(GlobalVariable *GV) {
1192   ConstantArray *CA = cast<ConstantArray>(GV->getInitializer());
1193   std::vector<Function*> Result;
1194   Result.reserve(CA->getNumOperands());
1195   for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i) {
1196     ConstantStruct *CS = cast<ConstantStruct>(CA->getOperand(i));
1197     Result.push_back(dyn_cast<Function>(CS->getOperand(1)));
1198   }
1199   return Result;
1200 }
1201
1202 /// InstallGlobalCtors - Given a specified llvm.global_ctors list, install the
1203 /// specified array, returning the new global to use.
1204 static GlobalVariable *InstallGlobalCtors(GlobalVariable *GCL, 
1205                                           const std::vector<Function*> &Ctors) {
1206   // If we made a change, reassemble the initializer list.
1207   std::vector<Constant*> CSVals;
1208   CSVals.push_back(ConstantSInt::get(Type::IntTy, 65535));
1209   CSVals.push_back(0);
1210   
1211   // Create the new init list.
1212   std::vector<Constant*> CAList;
1213   for (unsigned i = 0, e = Ctors.size(); i != e; ++i) {
1214     if (Ctors[i]) {
1215       CSVals[1] = Ctors[i];
1216     } else {
1217       const Type *FTy = FunctionType::get(Type::VoidTy,
1218                                           std::vector<const Type*>(), false);
1219       const PointerType *PFTy = PointerType::get(FTy);
1220       CSVals[1] = Constant::getNullValue(PFTy);
1221       CSVals[0] = ConstantSInt::get(Type::IntTy, 2147483647);
1222     }
1223     CAList.push_back(ConstantStruct::get(CSVals));
1224   }
1225   
1226   // Create the array initializer.
1227   const Type *StructTy =
1228     cast<ArrayType>(GCL->getType()->getElementType())->getElementType();
1229   Constant *CA = ConstantArray::get(ArrayType::get(StructTy, CAList.size()),
1230                                     CAList);
1231   
1232   // If we didn't change the number of elements, don't create a new GV.
1233   if (CA->getType() == GCL->getInitializer()->getType()) {
1234     GCL->setInitializer(CA);
1235     return GCL;
1236   }
1237   
1238   // Create the new global and insert it next to the existing list.
1239   GlobalVariable *NGV = new GlobalVariable(CA->getType(), GCL->isConstant(),
1240                                            GCL->getLinkage(), CA,
1241                                            GCL->getName());
1242   GCL->setName("");
1243   GCL->getParent()->getGlobalList().insert(GCL, NGV);
1244   
1245   // Nuke the old list, replacing any uses with the new one.
1246   if (!GCL->use_empty()) {
1247     Constant *V = NGV;
1248     if (V->getType() != GCL->getType())
1249       V = ConstantExpr::getCast(V, GCL->getType());
1250     GCL->replaceAllUsesWith(V);
1251   }
1252   GCL->eraseFromParent();
1253   
1254   if (Ctors.size())
1255     return NGV;
1256   else
1257     return 0;
1258 }
1259
1260
1261 static Constant *getVal(std::map<Value*, Constant*> &ComputedValues,
1262                         Value *V) {
1263   if (Constant *CV = dyn_cast<Constant>(V)) return CV;
1264   Constant *R = ComputedValues[V];
1265   assert(R && "Reference to an uncomputed value!");
1266   return R;
1267 }
1268
1269 /// isSimpleEnoughPointerToCommit - Return true if this constant is simple
1270 /// enough for us to understand.  In particular, if it is a cast of something,
1271 /// we punt.  We basically just support direct accesses to globals and GEP's of
1272 /// globals.  This should be kept up to date with CommitValueTo.
1273 static bool isSimpleEnoughPointerToCommit(Constant *C) {
1274   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(C)) {
1275     if (!GV->hasExternalLinkage() && !GV->hasInternalLinkage())
1276       return false;  // do not allow weak/linkonce/dllimport/dllexport linkage.
1277     return !GV->isExternal();  // reject external globals.
1278   }
1279   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
1280     // Handle a constantexpr gep.
1281     if (CE->getOpcode() == Instruction::GetElementPtr &&
1282         isa<GlobalVariable>(CE->getOperand(0))) {
1283       GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
1284       if (!GV->hasExternalLinkage() && !GV->hasInternalLinkage())
1285         return false;  // do not allow weak/linkonce/dllimport/dllexport linkage.
1286       return GV->hasInitializer() &&
1287              ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
1288     }
1289   return false;
1290 }
1291
1292 /// EvaluateStoreInto - Evaluate a piece of a constantexpr store into a global
1293 /// initializer.  This returns 'Init' modified to reflect 'Val' stored into it.
1294 /// At this point, the GEP operands of Addr [0, OpNo) have been stepped into.
1295 static Constant *EvaluateStoreInto(Constant *Init, Constant *Val,
1296                                    ConstantExpr *Addr, unsigned OpNo) {
1297   // Base case of the recursion.
1298   if (OpNo == Addr->getNumOperands()) {
1299     assert(Val->getType() == Init->getType() && "Type mismatch!");
1300     return Val;
1301   }
1302   
1303   if (const StructType *STy = dyn_cast<StructType>(Init->getType())) {
1304     std::vector<Constant*> Elts;
1305
1306     // Break up the constant into its elements.
1307     if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Init)) {
1308       for (unsigned i = 0, e = CS->getNumOperands(); i != e; ++i)
1309         Elts.push_back(CS->getOperand(i));
1310     } else if (isa<ConstantAggregateZero>(Init)) {
1311       for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
1312         Elts.push_back(Constant::getNullValue(STy->getElementType(i)));
1313     } else if (isa<UndefValue>(Init)) {
1314       for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i)
1315         Elts.push_back(UndefValue::get(STy->getElementType(i)));
1316     } else {
1317       assert(0 && "This code is out of sync with "
1318              " ConstantFoldLoadThroughGEPConstantExpr");
1319     }
1320     
1321     // Replace the element that we are supposed to.
1322     ConstantUInt *CU = cast<ConstantUInt>(Addr->getOperand(OpNo));
1323     assert(CU->getValue() < STy->getNumElements() &&
1324            "Struct index out of range!");
1325     unsigned Idx = (unsigned)CU->getValue();
1326     Elts[Idx] = EvaluateStoreInto(Elts[Idx], Val, Addr, OpNo+1);
1327     
1328     // Return the modified struct.
1329     return ConstantStruct::get(Elts);
1330   } else {
1331     ConstantInt *CI = cast<ConstantInt>(Addr->getOperand(OpNo));
1332     const ArrayType *ATy = cast<ArrayType>(Init->getType());
1333
1334     // Break up the array into elements.
1335     std::vector<Constant*> Elts;
1336     if (ConstantArray *CA = dyn_cast<ConstantArray>(Init)) {
1337       for (unsigned i = 0, e = CA->getNumOperands(); i != e; ++i)
1338         Elts.push_back(CA->getOperand(i));
1339     } else if (isa<ConstantAggregateZero>(Init)) {
1340       Constant *Elt = Constant::getNullValue(ATy->getElementType());
1341       Elts.assign(ATy->getNumElements(), Elt);
1342     } else if (isa<UndefValue>(Init)) {
1343       Constant *Elt = UndefValue::get(ATy->getElementType());
1344       Elts.assign(ATy->getNumElements(), Elt);
1345     } else {
1346       assert(0 && "This code is out of sync with "
1347              " ConstantFoldLoadThroughGEPConstantExpr");
1348     }
1349     
1350     assert((uint64_t)CI->getRawValue() < ATy->getNumElements());
1351     Elts[(uint64_t)CI->getRawValue()] =
1352       EvaluateStoreInto(Elts[(uint64_t)CI->getRawValue()], Val, Addr, OpNo+1);
1353     return ConstantArray::get(ATy, Elts);
1354   }    
1355 }
1356
1357 /// CommitValueTo - We have decided that Addr (which satisfies the predicate
1358 /// isSimpleEnoughPointerToCommit) should get Val as its value.  Make it happen.
1359 static void CommitValueTo(Constant *Val, Constant *Addr) {
1360   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(Addr)) {
1361     assert(GV->hasInitializer());
1362     GV->setInitializer(Val);
1363     return;
1364   }
1365   
1366   ConstantExpr *CE = cast<ConstantExpr>(Addr);
1367   GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
1368   
1369   Constant *Init = GV->getInitializer();
1370   Init = EvaluateStoreInto(Init, Val, CE, 2);
1371   GV->setInitializer(Init);
1372 }
1373
1374 /// ComputeLoadResult - Return the value that would be computed by a load from
1375 /// P after the stores reflected by 'memory' have been performed.  If we can't
1376 /// decide, return null.
1377 static Constant *ComputeLoadResult(Constant *P,
1378                                 const std::map<Constant*, Constant*> &Memory) {
1379   // If this memory location has been recently stored, use the stored value: it
1380   // is the most up-to-date.
1381   std::map<Constant*, Constant*>::const_iterator I = Memory.find(P);
1382   if (I != Memory.end()) return I->second;
1383  
1384   // Access it.
1385   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(P)) {
1386     if (GV->hasInitializer())
1387       return GV->getInitializer();
1388     return 0;
1389   }
1390   
1391   // Handle a constantexpr getelementptr.
1392   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(P))
1393     if (CE->getOpcode() == Instruction::GetElementPtr &&
1394         isa<GlobalVariable>(CE->getOperand(0))) {
1395       GlobalVariable *GV = cast<GlobalVariable>(CE->getOperand(0));
1396       if (GV->hasInitializer())
1397         return ConstantFoldLoadThroughGEPConstantExpr(GV->getInitializer(), CE);
1398     }
1399
1400   return 0;  // don't know how to evaluate.
1401 }
1402
1403 /// EvaluateFunction - Evaluate a call to function F, returning true if
1404 /// successful, false if we can't evaluate it.  ActualArgs contains the formal
1405 /// arguments for the function.
1406 static bool EvaluateFunction(Function *F, Constant *&RetVal,
1407                              const std::vector<Constant*> &ActualArgs,
1408                              std::vector<Function*> &CallStack,
1409                              std::map<Constant*, Constant*> &MutatedMemory,
1410                              std::vector<GlobalVariable*> &AllocaTmps) {
1411   // Check to see if this function is already executing (recursion).  If so,
1412   // bail out.  TODO: we might want to accept limited recursion.
1413   if (std::find(CallStack.begin(), CallStack.end(), F) != CallStack.end())
1414     return false;
1415   
1416   CallStack.push_back(F);
1417   
1418   /// Values - As we compute SSA register values, we store their contents here.
1419   std::map<Value*, Constant*> Values;
1420   
1421   // Initialize arguments to the incoming values specified.
1422   unsigned ArgNo = 0;
1423   for (Function::arg_iterator AI = F->arg_begin(), E = F->arg_end(); AI != E;
1424        ++AI, ++ArgNo)
1425     Values[AI] = ActualArgs[ArgNo];
1426
1427   /// ExecutedBlocks - We only handle non-looping, non-recursive code.  As such,
1428   /// we can only evaluate any one basic block at most once.  This set keeps
1429   /// track of what we have executed so we can detect recursive cases etc.
1430   std::set<BasicBlock*> ExecutedBlocks;
1431   
1432   // CurInst - The current instruction we're evaluating.
1433   BasicBlock::iterator CurInst = F->begin()->begin();
1434   
1435   // This is the main evaluation loop.
1436   while (1) {
1437     Constant *InstResult = 0;
1438     
1439     if (StoreInst *SI = dyn_cast<StoreInst>(CurInst)) {
1440       if (SI->isVolatile()) return false;  // no volatile accesses.
1441       Constant *Ptr = getVal(Values, SI->getOperand(1));
1442       if (!isSimpleEnoughPointerToCommit(Ptr))
1443         // If this is too complex for us to commit, reject it.
1444         return false;
1445       Constant *Val = getVal(Values, SI->getOperand(0));
1446       MutatedMemory[Ptr] = Val;
1447     } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(CurInst)) {
1448       InstResult = ConstantExpr::get(BO->getOpcode(),
1449                                      getVal(Values, BO->getOperand(0)),
1450                                      getVal(Values, BO->getOperand(1)));
1451     } else if (ShiftInst *SI = dyn_cast<ShiftInst>(CurInst)) {
1452       InstResult = ConstantExpr::get(SI->getOpcode(),
1453                                      getVal(Values, SI->getOperand(0)),
1454                                      getVal(Values, SI->getOperand(1)));
1455     } else if (CastInst *CI = dyn_cast<CastInst>(CurInst)) {
1456       InstResult = ConstantExpr::getCast(getVal(Values, CI->getOperand(0)),
1457                                          CI->getType());
1458     } else if (SelectInst *SI = dyn_cast<SelectInst>(CurInst)) {
1459       InstResult = ConstantExpr::getSelect(getVal(Values, SI->getOperand(0)),
1460                                            getVal(Values, SI->getOperand(1)),
1461                                            getVal(Values, SI->getOperand(2)));
1462     } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(CurInst)) {
1463       Constant *P = getVal(Values, GEP->getOperand(0));
1464       std::vector<Constant*> GEPOps;
1465       for (unsigned i = 1, e = GEP->getNumOperands(); i != e; ++i)
1466         GEPOps.push_back(getVal(Values, GEP->getOperand(i)));
1467       InstResult = ConstantExpr::getGetElementPtr(P, GEPOps);
1468     } else if (LoadInst *LI = dyn_cast<LoadInst>(CurInst)) {
1469       if (LI->isVolatile()) return false;  // no volatile accesses.
1470       InstResult = ComputeLoadResult(getVal(Values, LI->getOperand(0)),
1471                                      MutatedMemory);
1472       if (InstResult == 0) return false; // Could not evaluate load.
1473     } else if (AllocaInst *AI = dyn_cast<AllocaInst>(CurInst)) {
1474       if (AI->isArrayAllocation()) return false;  // Cannot handle array allocs.
1475       const Type *Ty = AI->getType()->getElementType();
1476       AllocaTmps.push_back(new GlobalVariable(Ty, false,
1477                                               GlobalValue::InternalLinkage,
1478                                               UndefValue::get(Ty),
1479                                               AI->getName()));
1480       InstResult = AllocaTmps.back();     
1481     } else if (CallInst *CI = dyn_cast<CallInst>(CurInst)) {
1482       // Cannot handle inline asm.
1483       if (isa<InlineAsm>(CI->getOperand(0))) return false;
1484
1485       // Resolve function pointers.
1486       Function *Callee = dyn_cast<Function>(getVal(Values, CI->getOperand(0)));
1487       if (!Callee) return false;  // Cannot resolve.
1488
1489       std::vector<Constant*> Formals;
1490       for (unsigned i = 1, e = CI->getNumOperands(); i != e; ++i)
1491         Formals.push_back(getVal(Values, CI->getOperand(i)));
1492       
1493       if (Callee->isExternal()) {
1494         // If this is a function we can constant fold, do it.
1495         if (Constant *C = ConstantFoldCall(Callee, Formals)) {
1496           InstResult = C;
1497         } else {
1498           return false;
1499         }
1500       } else {
1501         if (Callee->getFunctionType()->isVarArg())
1502           return false;
1503         
1504         Constant *RetVal;
1505         
1506         // Execute the call, if successful, use the return value.
1507         if (!EvaluateFunction(Callee, RetVal, Formals, CallStack,
1508                               MutatedMemory, AllocaTmps))
1509           return false;
1510         InstResult = RetVal;
1511       }
1512     } else if (TerminatorInst *TI = dyn_cast<TerminatorInst>(CurInst)) {
1513       BasicBlock *NewBB = 0;
1514       if (BranchInst *BI = dyn_cast<BranchInst>(CurInst)) {
1515         if (BI->isUnconditional()) {
1516           NewBB = BI->getSuccessor(0);
1517         } else {
1518           ConstantBool *Cond =
1519             dyn_cast<ConstantBool>(getVal(Values, BI->getCondition()));
1520           if (!Cond) return false;  // Cannot determine.
1521           NewBB = BI->getSuccessor(!Cond->getValue());          
1522         }
1523       } else if (SwitchInst *SI = dyn_cast<SwitchInst>(CurInst)) {
1524         ConstantInt *Val =
1525           dyn_cast<ConstantInt>(getVal(Values, SI->getCondition()));
1526         if (!Val) return false;  // Cannot determine.
1527         NewBB = SI->getSuccessor(SI->findCaseValue(Val));
1528       } else if (ReturnInst *RI = dyn_cast<ReturnInst>(CurInst)) {
1529         if (RI->getNumOperands())
1530           RetVal = getVal(Values, RI->getOperand(0));
1531         
1532         CallStack.pop_back();  // return from fn.
1533         return true;  // We succeeded at evaluating this ctor!
1534       } else {
1535         // invoke, unwind, unreachable.
1536         return false;  // Cannot handle this terminator.
1537       }
1538       
1539       // Okay, we succeeded in evaluating this control flow.  See if we have
1540       // executed the new block before.  If so, we have a looping function,
1541       // which we cannot evaluate in reasonable time.
1542       if (!ExecutedBlocks.insert(NewBB).second)
1543         return false;  // looped!
1544       
1545       // Okay, we have never been in this block before.  Check to see if there
1546       // are any PHI nodes.  If so, evaluate them with information about where
1547       // we came from.
1548       BasicBlock *OldBB = CurInst->getParent();
1549       CurInst = NewBB->begin();
1550       PHINode *PN;
1551       for (; (PN = dyn_cast<PHINode>(CurInst)); ++CurInst)
1552         Values[PN] = getVal(Values, PN->getIncomingValueForBlock(OldBB));
1553
1554       // Do NOT increment CurInst.  We know that the terminator had no value.
1555       continue;
1556     } else {
1557       // Did not know how to evaluate this!
1558       return false;
1559     }
1560     
1561     if (!CurInst->use_empty())
1562       Values[CurInst] = InstResult;
1563     
1564     // Advance program counter.
1565     ++CurInst;
1566   }
1567 }
1568
1569 /// EvaluateStaticConstructor - Evaluate static constructors in the function, if
1570 /// we can.  Return true if we can, false otherwise.
1571 static bool EvaluateStaticConstructor(Function *F) {
1572   /// MutatedMemory - For each store we execute, we update this map.  Loads
1573   /// check this to get the most up-to-date value.  If evaluation is successful,
1574   /// this state is committed to the process.
1575   std::map<Constant*, Constant*> MutatedMemory;
1576
1577   /// AllocaTmps - To 'execute' an alloca, we create a temporary global variable
1578   /// to represent its body.  This vector is needed so we can delete the
1579   /// temporary globals when we are done.
1580   std::vector<GlobalVariable*> AllocaTmps;
1581   
1582   /// CallStack - This is used to detect recursion.  In pathological situations
1583   /// we could hit exponential behavior, but at least there is nothing
1584   /// unbounded.
1585   std::vector<Function*> CallStack;
1586
1587   // Call the function.
1588   Constant *RetValDummy;
1589   bool EvalSuccess = EvaluateFunction(F, RetValDummy, std::vector<Constant*>(),
1590                                        CallStack, MutatedMemory, AllocaTmps);
1591   if (EvalSuccess) {
1592     // We succeeded at evaluation: commit the result.
1593     DEBUG(std::cerr << "FULLY EVALUATED GLOBAL CTOR FUNCTION '" <<
1594           F->getName() << "' to " << MutatedMemory.size() << " stores.\n");
1595     for (std::map<Constant*, Constant*>::iterator I = MutatedMemory.begin(),
1596          E = MutatedMemory.end(); I != E; ++I)
1597       CommitValueTo(I->second, I->first);
1598   }
1599   
1600   // At this point, we are done interpreting.  If we created any 'alloca'
1601   // temporaries, release them now.
1602   while (!AllocaTmps.empty()) {
1603     GlobalVariable *Tmp = AllocaTmps.back();
1604     AllocaTmps.pop_back();
1605     
1606     // If there are still users of the alloca, the program is doing something
1607     // silly, e.g. storing the address of the alloca somewhere and using it
1608     // later.  Since this is undefined, we'll just make it be null.
1609     if (!Tmp->use_empty())
1610       Tmp->replaceAllUsesWith(Constant::getNullValue(Tmp->getType()));
1611     delete Tmp;
1612   }
1613   
1614   return EvalSuccess;
1615 }
1616
1617
1618
1619
1620 /// OptimizeGlobalCtorsList - Simplify and evaluation global ctors if possible.
1621 /// Return true if anything changed.
1622 bool GlobalOpt::OptimizeGlobalCtorsList(GlobalVariable *&GCL) {
1623   std::vector<Function*> Ctors = ParseGlobalCtors(GCL);
1624   bool MadeChange = false;
1625   if (Ctors.empty()) return false;
1626   
1627   // Loop over global ctors, optimizing them when we can.
1628   for (unsigned i = 0; i != Ctors.size(); ++i) {
1629     Function *F = Ctors[i];
1630     // Found a null terminator in the middle of the list, prune off the rest of
1631     // the list.
1632     if (F == 0) {
1633       if (i != Ctors.size()-1) {
1634         Ctors.resize(i+1);
1635         MadeChange = true;
1636       }
1637       break;
1638     }
1639     
1640     // We cannot simplify external ctor functions.
1641     if (F->empty()) continue;
1642     
1643     // If we can evaluate the ctor at compile time, do.
1644     if (EvaluateStaticConstructor(F)) {
1645       Ctors.erase(Ctors.begin()+i);
1646       MadeChange = true;
1647       --i;
1648       ++NumCtorsEvaluated;
1649       continue;
1650     }
1651   }
1652   
1653   if (!MadeChange) return false;
1654   
1655   GCL = InstallGlobalCtors(GCL, Ctors);
1656   return true;
1657 }
1658
1659
1660 bool GlobalOpt::runOnModule(Module &M) {
1661   bool Changed = false;
1662   
1663   // Try to find the llvm.globalctors list.
1664   GlobalVariable *GlobalCtors = FindGlobalCtors(M);
1665
1666   bool LocalChange = true;
1667   while (LocalChange) {
1668     LocalChange = false;
1669     
1670     // Delete functions that are trivially dead, ccc -> fastcc
1671     LocalChange |= OptimizeFunctions(M);
1672     
1673     // Optimize global_ctors list.
1674     if (GlobalCtors)
1675       LocalChange |= OptimizeGlobalCtorsList(GlobalCtors);
1676     
1677     // Optimize non-address-taken globals.
1678     LocalChange |= OptimizeGlobalVars(M);
1679     Changed |= LocalChange;
1680   }
1681   
1682   // TODO: Move all global ctors functions to the end of the module for code
1683   // layout.
1684   
1685   return Changed;
1686 }