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