lib/Transforms/IPO/GlobalOpt.cpp

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