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