lib/Transforms/IPO/GlobalOpt.cpp

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