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