lib/Transforms/Scalar/ScalarReplAggregates.cpp

   1 //===- ScalarReplAggregates.cpp - Scalar Replacement of Aggregates --------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This transformation implements the well known scalar replacement of
  11 // aggregates transformation.  This xform breaks up alloca instructions of
  12 // aggregate type (structure or array) into individual alloca instructions for
  13 // each member (if possible).  Then, if possible, it transforms the individual
  14 // alloca instructions into nice clean scalar SSA form.
  15 //
  16 // This combines a simple SRoA algorithm with the Mem2Reg algorithm because they
  17 // often interact, especially for C++ programs.  As such, iterating between
  18 // SRoA, then Mem2Reg until we run out of things to promote works well.
  19 //
  20 //===----------------------------------------------------------------------===//
  21
  22 #define DEBUG_TYPE "scalarrepl"
  23 #include "llvm/Transforms/Scalar.h"
  24 #include "llvm/ADT/SetVector.h"
  25 #include "llvm/ADT/SmallVector.h"
  26 #include "llvm/ADT/Statistic.h"
  27 #include "llvm/Analysis/Loads.h"
  28 #include "llvm/Analysis/ValueTracking.h"
  29 #include "llvm/DIBuilder.h"
  30 #include "llvm/DebugInfo.h"
  31 #include "llvm/IR/Constants.h"
  32 #include "llvm/IR/DataLayout.h"
  33 #include "llvm/IR/DerivedTypes.h"
  34 #include "llvm/IR/Dominators.h"
  35 #include "llvm/IR/Function.h"
  36 #include "llvm/IR/GlobalVariable.h"
  37 #include "llvm/IR/IRBuilder.h"
  38 #include "llvm/IR/Instructions.h"
  39 #include "llvm/IR/IntrinsicInst.h"
  40 #include "llvm/IR/LLVMContext.h"
  41 #include "llvm/IR/Module.h"
  42 #include "llvm/IR/Operator.h"
  43 #include "llvm/Pass.h"
  44 #include "llvm/Support/CallSite.h"
  45 #include "llvm/Support/Debug.h"
  46 #include "llvm/Support/ErrorHandling.h"
  47 #include "llvm/Support/GetElementPtrTypeIterator.h"
  48 #include "llvm/Support/MathExtras.h"
  49 #include "llvm/Support/raw_ostream.h"
  50 #include "llvm/Transforms/Utils/Local.h"
  51 #include "llvm/Transforms/Utils/PromoteMemToReg.h"
  52 #include "llvm/Transforms/Utils/SSAUpdater.h"
  53 using namespace llvm;
  54
  55 STATISTIC(NumReplaced,  "Number of allocas broken up");
  56 STATISTIC(NumPromoted,  "Number of allocas promoted");
  57 STATISTIC(NumAdjusted,  "Number of scalar allocas adjusted to allow promotion");
  58 STATISTIC(NumConverted, "Number of aggregates converted to scalar");
  59
  60 namespace {
  61   struct SROA : public FunctionPass {
  62     SROA(int T, bool hasDT, char &ID, int ST, int AT, int SLT)
  63       : FunctionPass(ID), HasDomTree(hasDT) {
  64       if (T == -1)
  65         SRThreshold = 128;
  66       else
  67         SRThreshold = T;
  68       if (ST == -1)
  69         StructMemberThreshold = 32;
  70       else
  71         StructMemberThreshold = ST;
  72       if (AT == -1)
  73         ArrayElementThreshold = 8;
  74       else
  75         ArrayElementThreshold = AT;
  76       if (SLT == -1)
  77         // Do not limit the scalar integer load size if no threshold is given.
  78         ScalarLoadThreshold = -1;
  79       else
  80         ScalarLoadThreshold = SLT;
  81     }
  82
  83     bool runOnFunction(Function &F);
  84
  85     bool performScalarRepl(Function &F);
  86     bool performPromotion(Function &F);
  87
  88   private:
  89     bool HasDomTree;
  90     DataLayout *DL;
  91
  92     /// DeadInsts - Keep track of instructions we have made dead, so that
  93     /// we can remove them after we are done working.
  94     SmallVector<Value*, 32> DeadInsts;
  95
  96     /// AllocaInfo - When analyzing uses of an alloca instruction, this captures
  97     /// information about the uses.  All these fields are initialized to false
  98     /// and set to true when something is learned.
  99     struct AllocaInfo {
 100       /// The alloca to promote.
 101       AllocaInst *AI;
 102
 103       /// CheckedPHIs - This is a set of verified PHI nodes, to prevent infinite
 104       /// looping and avoid redundant work.
 105       SmallPtrSet<PHINode*, 8> CheckedPHIs;
 106
 107       /// isUnsafe - This is set to true if the alloca cannot be SROA'd.
 108       bool isUnsafe : 1;
 109
 110       /// isMemCpySrc - This is true if this aggregate is memcpy'd from.
 111       bool isMemCpySrc : 1;
 112
 113       /// isMemCpyDst - This is true if this aggregate is memcpy'd into.
 114       bool isMemCpyDst : 1;
 115
 116       /// hasSubelementAccess - This is true if a subelement of the alloca is
 117       /// ever accessed, or false if the alloca is only accessed with mem
 118       /// intrinsics or load/store that only access the entire alloca at once.
 119       bool hasSubelementAccess : 1;
 120
 121       /// hasALoadOrStore - This is true if there are any loads or stores to it.
 122       /// The alloca may just be accessed with memcpy, for example, which would
 123       /// not set this.
 124       bool hasALoadOrStore : 1;
 125
 126       explicit AllocaInfo(AllocaInst *ai)
 127         : AI(ai), isUnsafe(false), isMemCpySrc(false), isMemCpyDst(false),
 128           hasSubelementAccess(false), hasALoadOrStore(false) {}
 129     };
 130
 131     /// SRThreshold - The maximum alloca size to considered for SROA.
 132     unsigned SRThreshold;
 133
 134     /// StructMemberThreshold - The maximum number of members a struct can
 135     /// contain to be considered for SROA.
 136     unsigned StructMemberThreshold;
 137
 138     /// ArrayElementThreshold - The maximum number of elements an array can
 139     /// have to be considered for SROA.
 140     unsigned ArrayElementThreshold;
 141
 142     /// ScalarLoadThreshold - The maximum size in bits of scalars to load when
 143     /// converting to scalar
 144     unsigned ScalarLoadThreshold;
 145
 146     void MarkUnsafe(AllocaInfo &I, Instruction *User) {
 147       I.isUnsafe = true;
 148       DEBUG(dbgs() << "  Transformation preventing inst: " << *User << '\n');
 149     }
 150
 151     bool isSafeAllocaToScalarRepl(AllocaInst *AI);
 152
 153     void isSafeForScalarRepl(Instruction *I, uint64_t Offset, AllocaInfo &Info);
 154     void isSafePHISelectUseForScalarRepl(Instruction *User, uint64_t Offset,
 155                                          AllocaInfo &Info);
 156     void isSafeGEP(GetElementPtrInst *GEPI, uint64_t &Offset, AllocaInfo &Info);
 157     void isSafeMemAccess(uint64_t Offset, uint64_t MemSize,
 158                          Type *MemOpType, bool isStore, AllocaInfo &Info,
 159                          Instruction *TheAccess, bool AllowWholeAccess);
 160     bool TypeHasComponent(Type *T, uint64_t Offset, uint64_t Size);
 161     uint64_t FindElementAndOffset(Type *&T, uint64_t &Offset,
 162                                   Type *&IdxTy);
 163
 164     void DoScalarReplacement(AllocaInst *AI,
 165                              std::vector<AllocaInst*> &WorkList);
 166     void DeleteDeadInstructions();
 167
 168     void RewriteForScalarRepl(Instruction *I, AllocaInst *AI, uint64_t Offset,
 169                               SmallVectorImpl<AllocaInst *> &NewElts);
 170     void RewriteBitCast(BitCastInst *BC, AllocaInst *AI, uint64_t Offset,
 171                         SmallVectorImpl<AllocaInst *> &NewElts);
 172     void RewriteGEP(GetElementPtrInst *GEPI, AllocaInst *AI, uint64_t Offset,
 173                     SmallVectorImpl<AllocaInst *> &NewElts);
 174     void RewriteLifetimeIntrinsic(IntrinsicInst *II, AllocaInst *AI,
 175                                   uint64_t Offset,
 176                                   SmallVectorImpl<AllocaInst *> &NewElts);
 177     void RewriteMemIntrinUserOfAlloca(MemIntrinsic *MI, Instruction *Inst,
 178                                       AllocaInst *AI,
 179                                       SmallVectorImpl<AllocaInst *> &NewElts);
 180     void RewriteStoreUserOfWholeAlloca(StoreInst *SI, AllocaInst *AI,
 181                                        SmallVectorImpl<AllocaInst *> &NewElts);
 182     void RewriteLoadUserOfWholeAlloca(LoadInst *LI, AllocaInst *AI,
 183                                       SmallVectorImpl<AllocaInst *> &NewElts);
 184     bool ShouldAttemptScalarRepl(AllocaInst *AI);
 185   };
 186
 187   // SROA_DT - SROA that uses DominatorTree.
 188   struct SROA_DT : public SROA {
 189     static char ID;
 190   public:
 191     SROA_DT(int T = -1, int ST = -1, int AT = -1, int SLT = -1) :
 192         SROA(T, true, ID, ST, AT, SLT) {
 193       initializeSROA_DTPass(*PassRegistry::getPassRegistry());
 194     }
 195
 196     // getAnalysisUsage - This pass does not require any passes, but we know it
 197     // will not alter the CFG, so say so.
 198     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 199       AU.addRequired<DominatorTreeWrapperPass>();
 200       AU.setPreservesCFG();
 201     }
 202   };
 203
 204   // SROA_SSAUp - SROA that uses SSAUpdater.
 205   struct SROA_SSAUp : public SROA {
 206     static char ID;
 207   public:
 208     SROA_SSAUp(int T = -1, int ST = -1, int AT = -1, int SLT = -1) :
 209         SROA(T, false, ID, ST, AT, SLT) {
 210       initializeSROA_SSAUpPass(*PassRegistry::getPassRegistry());
 211     }
 212
 213     // getAnalysisUsage - This pass does not require any passes, but we know it
 214     // will not alter the CFG, so say so.
 215     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 216       AU.setPreservesCFG();
 217     }
 218   };
 219
 220 }
 221
 222 char SROA_DT::ID = 0;
 223 char SROA_SSAUp::ID = 0;
 224
 225 INITIALIZE_PASS_BEGIN(SROA_DT, "scalarrepl",
 226                 "Scalar Replacement of Aggregates (DT)", false, false)
 227 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
 228 INITIALIZE_PASS_END(SROA_DT, "scalarrepl",
 229                 "Scalar Replacement of Aggregates (DT)", false, false)
 230
 231 INITIALIZE_PASS_BEGIN(SROA_SSAUp, "scalarrepl-ssa",
 232                       "Scalar Replacement of Aggregates (SSAUp)", false, false)
 233 INITIALIZE_PASS_END(SROA_SSAUp, "scalarrepl-ssa",
 234                     "Scalar Replacement of Aggregates (SSAUp)", false, false)
 235
 236 // Public interface to the ScalarReplAggregates pass
 237 FunctionPass *llvm::createScalarReplAggregatesPass(int Threshold,
 238                                                    bool UseDomTree,
 239                                                    int StructMemberThreshold,
 240                                                    int ArrayElementThreshold,
 241                                                    int ScalarLoadThreshold) {
 242   if (UseDomTree)
 243     return new SROA_DT(Threshold, StructMemberThreshold, ArrayElementThreshold,
 244                        ScalarLoadThreshold);
 245   return new SROA_SSAUp(Threshold, StructMemberThreshold,
 246                         ArrayElementThreshold, ScalarLoadThreshold);
 247 }
 248
 249
 250 //===----------------------------------------------------------------------===//
 251 // Convert To Scalar Optimization.
 252 //===----------------------------------------------------------------------===//
 253
 254 namespace {
 255 /// ConvertToScalarInfo - This class implements the "Convert To Scalar"
 256 /// optimization, which scans the uses of an alloca and determines if it can
 257 /// rewrite it in terms of a single new alloca that can be mem2reg'd.
 258 class ConvertToScalarInfo {
 259   /// AllocaSize - The size of the alloca being considered in bytes.
 260   unsigned AllocaSize;
 261   const DataLayout &DL;
 262   unsigned ScalarLoadThreshold;
 263
 264   /// IsNotTrivial - This is set to true if there is some access to the object
 265   /// which means that mem2reg can't promote it.
 266   bool IsNotTrivial;
 267
 268   /// ScalarKind - Tracks the kind of alloca being considered for promotion,
 269   /// computed based on the uses of the alloca rather than the LLVM type system.
 270   enum {
 271     Unknown,
 272
 273     // Accesses via GEPs that are consistent with element access of a vector
 274     // type. This will not be converted into a vector unless there is a later
 275     // access using an actual vector type.
 276     ImplicitVector,
 277
 278     // Accesses via vector operations and GEPs that are consistent with the
 279     // layout of a vector type.
 280     Vector,
 281
 282     // An integer bag-of-bits with bitwise operations for insertion and
 283     // extraction. Any combination of types can be converted into this kind
 284     // of scalar.
 285     Integer
 286   } ScalarKind;
 287
 288   /// VectorTy - This tracks the type that we should promote the vector to if
 289   /// it is possible to turn it into a vector.  This starts out null, and if it
 290   /// isn't possible to turn into a vector type, it gets set to VoidTy.
 291   VectorType *VectorTy;
 292
 293   /// HadNonMemTransferAccess - True if there is at least one access to the
 294   /// alloca that is not a MemTransferInst.  We don't want to turn structs into
 295   /// large integers unless there is some potential for optimization.
 296   bool HadNonMemTransferAccess;
 297
 298   /// HadDynamicAccess - True if some element of this alloca was dynamic.
 299   /// We don't yet have support for turning a dynamic access into a large
 300   /// integer.
 301   bool HadDynamicAccess;
 302
 303 public:
 304   explicit ConvertToScalarInfo(unsigned Size, const DataLayout &DL,
 305                                unsigned SLT)
 306     : AllocaSize(Size), DL(DL), ScalarLoadThreshold(SLT), IsNotTrivial(false),
 307     ScalarKind(Unknown), VectorTy(0), HadNonMemTransferAccess(false),
 308     HadDynamicAccess(false) { }
 309
 310   AllocaInst *TryConvert(AllocaInst *AI);
 311
 312 private:
 313   bool CanConvertToScalar(Value *V, uint64_t Offset, Value* NonConstantIdx);
 314   void MergeInTypeForLoadOrStore(Type *In, uint64_t Offset);
 315   bool MergeInVectorType(VectorType *VInTy, uint64_t Offset);
 316   void ConvertUsesToScalar(Value *Ptr, AllocaInst *NewAI, uint64_t Offset,
 317                            Value *NonConstantIdx);
 318
 319   Value *ConvertScalar_ExtractValue(Value *NV, Type *ToType,
 320                                     uint64_t Offset, Value* NonConstantIdx,
 321                                     IRBuilder<> &Builder);
 322   Value *ConvertScalar_InsertValue(Value *StoredVal, Value *ExistingVal,
 323                                    uint64_t Offset, Value* NonConstantIdx,
 324                                    IRBuilder<> &Builder);
 325 };
 326 } // end anonymous namespace.
 327
 328
 329 /// TryConvert - Analyze the specified alloca, and if it is safe to do so,
 330 /// rewrite it to be a new alloca which is mem2reg'able.  This returns the new
 331 /// alloca if possible or null if not.
 332 AllocaInst *ConvertToScalarInfo::TryConvert(AllocaInst *AI) {
 333   // If we can't convert this scalar, or if mem2reg can trivially do it, bail
 334   // out.
 335   if (!CanConvertToScalar(AI, 0, 0) || !IsNotTrivial)
 336     return 0;
 337
 338   // If an alloca has only memset / memcpy uses, it may still have an Unknown
 339   // ScalarKind. Treat it as an Integer below.
 340   if (ScalarKind == Unknown)
 341     ScalarKind = Integer;
 342
 343   if (ScalarKind == Vector && VectorTy->getBitWidth() != AllocaSize * 8)
 344     ScalarKind = Integer;
 345
 346   // If we were able to find a vector type that can handle this with
 347   // insert/extract elements, and if there was at least one use that had
 348   // a vector type, promote this to a vector.  We don't want to promote
 349   // random stuff that doesn't use vectors (e.g. <9 x double>) because then
 350   // we just get a lot of insert/extracts.  If at least one vector is
 351   // involved, then we probably really do have a union of vector/array.
 352   Type *NewTy;
 353   if (ScalarKind == Vector) {
 354     assert(VectorTy && "Missing type for vector scalar.");
 355     DEBUG(dbgs() << "CONVERT TO VECTOR: " << *AI << "\n  TYPE = "
 356           << *VectorTy << '\n');
 357     NewTy = VectorTy;  // Use the vector type.
 358   } else {
 359     unsigned BitWidth = AllocaSize * 8;
 360
 361     // Do not convert to scalar integer if the alloca size exceeds the
 362     // scalar load threshold.
 363     if (BitWidth > ScalarLoadThreshold)
 364       return 0;
 365
 366     if ((ScalarKind == ImplicitVector || ScalarKind == Integer) &&
 367         !HadNonMemTransferAccess && !DL.fitsInLegalInteger(BitWidth))
 368       return 0;
 369     // Dynamic accesses on integers aren't yet supported.  They need us to shift
 370     // by a dynamic amount which could be difficult to work out as we might not
 371     // know whether to use a left or right shift.
 372     if (ScalarKind == Integer && HadDynamicAccess)
 373       return 0;
 374
 375     DEBUG(dbgs() << "CONVERT TO SCALAR INTEGER: " << *AI << "\n");
 376     // Create and insert the integer alloca.
 377     NewTy = IntegerType::get(AI->getContext(), BitWidth);
 378   }
 379   AllocaInst *NewAI = new AllocaInst(NewTy, 0, "", AI->getParent()->begin());
 380   ConvertUsesToScalar(AI, NewAI, 0, 0);
 381   return NewAI;
 382 }
 383
 384 /// MergeInTypeForLoadOrStore - Add the 'In' type to the accumulated vector type
 385 /// (VectorTy) so far at the offset specified by Offset (which is specified in
 386 /// bytes).
 387 ///
 388 /// There are two cases we handle here:
 389 ///   1) A union of vector types of the same size and potentially its elements.
 390 ///      Here we turn element accesses into insert/extract element operations.
 391 ///      This promotes a <4 x float> with a store of float to the third element
 392 ///      into a <4 x float> that uses insert element.
 393 ///   2) A fully general blob of memory, which we turn into some (potentially
 394 ///      large) integer type with extract and insert operations where the loads
 395 ///      and stores would mutate the memory.  We mark this by setting VectorTy
 396 ///      to VoidTy.
 397 void ConvertToScalarInfo::MergeInTypeForLoadOrStore(Type *In,
 398                                                     uint64_t Offset) {
 399   // If we already decided to turn this into a blob of integer memory, there is
 400   // nothing to be done.
 401   if (ScalarKind == Integer)
 402     return;
 403
 404   // If this could be contributing to a vector, analyze it.
 405
 406   // If the In type is a vector that is the same size as the alloca, see if it
 407   // matches the existing VecTy.
 408   if (VectorType *VInTy = dyn_cast<VectorType>(In)) {
 409     if (MergeInVectorType(VInTy, Offset))
 410       return;
 411   } else if (In->isFloatTy() || In->isDoubleTy() ||
 412              (In->isIntegerTy() && In->getPrimitiveSizeInBits() >= 8 &&
 413               isPowerOf2_32(In->getPrimitiveSizeInBits()))) {
 414     // Full width accesses can be ignored, because they can always be turned
 415     // into bitcasts.
 416     unsigned EltSize = In->getPrimitiveSizeInBits()/8;
 417     if (EltSize == AllocaSize)
 418       return;
 419
 420     // If we're accessing something that could be an element of a vector, see
 421     // if the implied vector agrees with what we already have and if Offset is
 422     // compatible with it.
 423     if (Offset % EltSize == 0 && AllocaSize % EltSize == 0 &&
 424         (!VectorTy || EltSize == VectorTy->getElementType()
 425                                          ->getPrimitiveSizeInBits()/8)) {
 426       if (!VectorTy) {
 427         ScalarKind = ImplicitVector;
 428         VectorTy = VectorType::get(In, AllocaSize/EltSize);
 429       }
 430       return;
 431     }
 432   }
 433
 434   // Otherwise, we have a case that we can't handle with an optimized vector
 435   // form.  We can still turn this into a large integer.
 436   ScalarKind = Integer;
 437 }
 438
 439 /// MergeInVectorType - Handles the vector case of MergeInTypeForLoadOrStore,
 440 /// returning true if the type was successfully merged and false otherwise.
 441 bool ConvertToScalarInfo::MergeInVectorType(VectorType *VInTy,
 442                                             uint64_t Offset) {
 443   if (VInTy->getBitWidth()/8 == AllocaSize && Offset == 0) {
 444     // If we're storing/loading a vector of the right size, allow it as a
 445     // vector.  If this the first vector we see, remember the type so that
 446     // we know the element size. If this is a subsequent access, ignore it
 447     // even if it is a differing type but the same size. Worst case we can
 448     // bitcast the resultant vectors.
 449     if (!VectorTy)
 450       VectorTy = VInTy;
 451     ScalarKind = Vector;
 452     return true;
 453   }
 454
 455   return false;
 456 }
 457
 458 /// CanConvertToScalar - V is a pointer.  If we can convert the pointee and all
 459 /// its accesses to a single vector type, return true and set VecTy to
 460 /// the new type.  If we could convert the alloca into a single promotable
 461 /// integer, return true but set VecTy to VoidTy.  Further, if the use is not a
 462 /// completely trivial use that mem2reg could promote, set IsNotTrivial.  Offset
 463 /// is the current offset from the base of the alloca being analyzed.
 464 ///
 465 /// If we see at least one access to the value that is as a vector type, set the
 466 /// SawVec flag.
 467 bool ConvertToScalarInfo::CanConvertToScalar(Value *V, uint64_t Offset,
 468                                              Value* NonConstantIdx) {
 469   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI!=E; ++UI) {
 470     Instruction *User = cast<Instruction>(*UI);
 471
 472     if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
 473       // Don't break volatile loads.
 474       if (!LI->isSimple())
 475         return false;
 476       // Don't touch MMX operations.
 477       if (LI->getType()->isX86_MMXTy())
 478         return false;
 479       HadNonMemTransferAccess = true;
 480       MergeInTypeForLoadOrStore(LI->getType(), Offset);
 481       continue;
 482     }
 483
 484     if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
 485       // Storing the pointer, not into the value?
 486       if (SI->getOperand(0) == V || !SI->isSimple()) return false;
 487       // Don't touch MMX operations.
 488       if (SI->getOperand(0)->getType()->isX86_MMXTy())
 489         return false;
 490       HadNonMemTransferAccess = true;
 491       MergeInTypeForLoadOrStore(SI->getOperand(0)->getType(), Offset);
 492       continue;
 493     }
 494
 495     if (BitCastInst *BCI = dyn_cast<BitCastInst>(User)) {
 496       if (!onlyUsedByLifetimeMarkers(BCI))
 497         IsNotTrivial = true;  // Can't be mem2reg'd.
 498       if (!CanConvertToScalar(BCI, Offset, NonConstantIdx))
 499         return false;
 500       continue;
 501     }
 502
 503     if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(User)) {
 504       // If this is a GEP with a variable indices, we can't handle it.
 505       PointerType* PtrTy = dyn_cast<PointerType>(GEP->getPointerOperandType());
 506       if (!PtrTy)
 507         return false;
 508
 509       // Compute the offset that this GEP adds to the pointer.
 510       SmallVector<Value*, 8> Indices(GEP->op_begin()+1, GEP->op_end());
 511       Value *GEPNonConstantIdx = 0;
 512       if (!GEP->hasAllConstantIndices()) {
 513         if (!isa<VectorType>(PtrTy->getElementType()))
 514           return false;
 515         if (NonConstantIdx)
 516           return false;
 517         GEPNonConstantIdx = Indices.pop_back_val();
 518         if (!GEPNonConstantIdx->getType()->isIntegerTy(32))
 519           return false;
 520         HadDynamicAccess = true;
 521       } else
 522         GEPNonConstantIdx = NonConstantIdx;
 523       uint64_t GEPOffset = DL.getIndexedOffset(PtrTy,
 524                                                Indices);
 525       // See if all uses can be converted.
 526       if (!CanConvertToScalar(GEP, Offset+GEPOffset, GEPNonConstantIdx))
 527         return false;
 528       IsNotTrivial = true;  // Can't be mem2reg'd.
 529       HadNonMemTransferAccess = true;
 530       continue;
 531     }
 532
 533     // If this is a constant sized memset of a constant value (e.g. 0) we can
 534     // handle it.
 535     if (MemSetInst *MSI = dyn_cast<MemSetInst>(User)) {
 536       // Store to dynamic index.
 537       if (NonConstantIdx)
 538         return false;
 539       // Store of constant value.
 540       if (!isa<ConstantInt>(MSI->getValue()))
 541         return false;
 542
 543       // Store of constant size.
 544       ConstantInt *Len = dyn_cast<ConstantInt>(MSI->getLength());
 545       if (!Len)
 546         return false;
 547
 548       // If the size differs from the alloca, we can only convert the alloca to
 549       // an integer bag-of-bits.
 550       // FIXME: This should handle all of the cases that are currently accepted
 551       // as vector element insertions.
 552       if (Len->getZExtValue() != AllocaSize || Offset != 0)
 553         ScalarKind = Integer;
 554
 555       IsNotTrivial = true;  // Can't be mem2reg'd.
 556       HadNonMemTransferAccess = true;
 557       continue;
 558     }
 559
 560     // If this is a memcpy or memmove into or out of the whole allocation, we
 561     // can handle it like a load or store of the scalar type.
 562     if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(User)) {
 563       // Store to dynamic index.
 564       if (NonConstantIdx)
 565         return false;
 566       ConstantInt *Len = dyn_cast<ConstantInt>(MTI->getLength());
 567       if (Len == 0 || Len->getZExtValue() != AllocaSize || Offset != 0)
 568         return false;
 569
 570       IsNotTrivial = true;  // Can't be mem2reg'd.
 571       continue;
 572     }
 573
 574     // If this is a lifetime intrinsic, we can handle it.
 575     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(User)) {
 576       if (II->getIntrinsicID() == Intrinsic::lifetime_start ||
 577           II->getIntrinsicID() == Intrinsic::lifetime_end) {
 578         continue;
 579       }
 580     }
 581
 582     // Otherwise, we cannot handle this!
 583     return false;
 584   }
 585
 586   return true;
 587 }
 588
 589 /// ConvertUsesToScalar - Convert all of the users of Ptr to use the new alloca
 590 /// directly.  This happens when we are converting an "integer union" to a
 591 /// single integer scalar, or when we are converting a "vector union" to a
 592 /// vector with insert/extractelement instructions.
 593 ///
 594 /// Offset is an offset from the original alloca, in bits that need to be
 595 /// shifted to the right.  By the end of this, there should be no uses of Ptr.
 596 void ConvertToScalarInfo::ConvertUsesToScalar(Value *Ptr, AllocaInst *NewAI,
 597                                               uint64_t Offset,
 598                                               Value* NonConstantIdx) {
 599   while (!Ptr->use_empty()) {
 600     Instruction *User = cast<Instruction>(Ptr->use_back());
 601
 602     if (BitCastInst *CI = dyn_cast<BitCastInst>(User)) {
 603       ConvertUsesToScalar(CI, NewAI, Offset, NonConstantIdx);
 604       CI->eraseFromParent();
 605       continue;
 606     }
 607
 608     if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(User)) {
 609       // Compute the offset that this GEP adds to the pointer.
 610       SmallVector<Value*, 8> Indices(GEP->op_begin()+1, GEP->op_end());
 611       Value* GEPNonConstantIdx = 0;
 612       if (!GEP->hasAllConstantIndices()) {
 613         assert(!NonConstantIdx &&
 614                "Dynamic GEP reading from dynamic GEP unsupported");
 615         GEPNonConstantIdx = Indices.pop_back_val();
 616       } else
 617         GEPNonConstantIdx = NonConstantIdx;
 618       uint64_t GEPOffset = DL.getIndexedOffset(GEP->getPointerOperandType(),
 619                                                Indices);
 620       ConvertUsesToScalar(GEP, NewAI, Offset+GEPOffset*8, GEPNonConstantIdx);
 621       GEP->eraseFromParent();
 622       continue;
 623     }
 624
 625     IRBuilder<> Builder(User);
 626
 627     if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
 628       // The load is a bit extract from NewAI shifted right by Offset bits.
 629       Value *LoadedVal = Builder.CreateLoad(NewAI);
 630       Value *NewLoadVal
 631         = ConvertScalar_ExtractValue(LoadedVal, LI->getType(), Offset,
 632                                      NonConstantIdx, Builder);
 633       LI->replaceAllUsesWith(NewLoadVal);
 634       LI->eraseFromParent();
 635       continue;
 636     }
 637
 638     if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
 639       assert(SI->getOperand(0) != Ptr && "Consistency error!");
 640       Instruction *Old = Builder.CreateLoad(NewAI, NewAI->getName()+".in");
 641       Value *New = ConvertScalar_InsertValue(SI->getOperand(0), Old, Offset,
 642                                              NonConstantIdx, Builder);
 643       Builder.CreateStore(New, NewAI);
 644       SI->eraseFromParent();
 645
 646       // If the load we just inserted is now dead, then the inserted store
 647       // overwrote the entire thing.
 648       if (Old->use_empty())
 649         Old->eraseFromParent();
 650       continue;
 651     }
 652
 653     // If this is a constant sized memset of a constant value (e.g. 0) we can
 654     // transform it into a store of the expanded constant value.
 655     if (MemSetInst *MSI = dyn_cast<MemSetInst>(User)) {
 656       assert(MSI->getRawDest() == Ptr && "Consistency error!");
 657       assert(!NonConstantIdx && "Cannot replace dynamic memset with insert");
 658       int64_t SNumBytes = cast<ConstantInt>(MSI->getLength())->getSExtValue();
 659       if (SNumBytes > 0 && (SNumBytes >> 32) == 0) {
 660         unsigned NumBytes = static_cast<unsigned>(SNumBytes);
 661         unsigned Val = cast<ConstantInt>(MSI->getValue())->getZExtValue();
 662
 663         // Compute the value replicated the right number of times.
 664         APInt APVal(NumBytes*8, Val);
 665
 666         // Splat the value if non-zero.
 667         if (Val)
 668           for (unsigned i = 1; i != NumBytes; ++i)
 669             APVal |= APVal << 8;
 670
 671         Instruction *Old = Builder.CreateLoad(NewAI, NewAI->getName()+".in");
 672         Value *New = ConvertScalar_InsertValue(
 673                                     ConstantInt::get(User->getContext(), APVal),
 674                                                Old, Offset, 0, Builder);
 675         Builder.CreateStore(New, NewAI);
 676
 677         // If the load we just inserted is now dead, then the memset overwrote
 678         // the entire thing.
 679         if (Old->use_empty())
 680           Old->eraseFromParent();
 681       }
 682       MSI->eraseFromParent();
 683       continue;
 684     }
 685
 686     // If this is a memcpy or memmove into or out of the whole allocation, we
 687     // can handle it like a load or store of the scalar type.
 688     if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(User)) {
 689       assert(Offset == 0 && "must be store to start of alloca");
 690       assert(!NonConstantIdx && "Cannot replace dynamic transfer with insert");
 691
 692       // If the source and destination are both to the same alloca, then this is
 693       // a noop copy-to-self, just delete it.  Otherwise, emit a load and store
 694       // as appropriate.
 695       AllocaInst *OrigAI = cast<AllocaInst>(GetUnderlyingObject(Ptr, &DL, 0));
 696
 697       if (GetUnderlyingObject(MTI->getSource(), &DL, 0) != OrigAI) {
 698         // Dest must be OrigAI, change this to be a load from the original
 699         // pointer (bitcasted), then a store to our new alloca.
 700         assert(MTI->getRawDest() == Ptr && "Neither use is of pointer?");
 701         Value *SrcPtr = MTI->getSource();
 702         PointerType* SPTy = cast<PointerType>(SrcPtr->getType());
 703         PointerType* AIPTy = cast<PointerType>(NewAI->getType());
 704         if (SPTy->getAddressSpace() != AIPTy->getAddressSpace()) {
 705           AIPTy = PointerType::get(AIPTy->getElementType(),
 706                                    SPTy->getAddressSpace());
 707         }
 708         SrcPtr = Builder.CreateBitCast(SrcPtr, AIPTy);
 709
 710         LoadInst *SrcVal = Builder.CreateLoad(SrcPtr, "srcval");
 711         SrcVal->setAlignment(MTI->getAlignment());
 712         Builder.CreateStore(SrcVal, NewAI);
 713       } else if (GetUnderlyingObject(MTI->getDest(), &DL, 0) != OrigAI) {
 714         // Src must be OrigAI, change this to be a load from NewAI then a store
 715         // through the original dest pointer (bitcasted).
 716         assert(MTI->getRawSource() == Ptr && "Neither use is of pointer?");
 717         LoadInst *SrcVal = Builder.CreateLoad(NewAI, "srcval");
 718
 719         PointerType* DPTy = cast<PointerType>(MTI->getDest()->getType());
 720         PointerType* AIPTy = cast<PointerType>(NewAI->getType());
 721         if (DPTy->getAddressSpace() != AIPTy->getAddressSpace()) {
 722           AIPTy = PointerType::get(AIPTy->getElementType(),
 723                                    DPTy->getAddressSpace());
 724         }
 725         Value *DstPtr = Builder.CreateBitCast(MTI->getDest(), AIPTy);
 726
 727         StoreInst *NewStore = Builder.CreateStore(SrcVal, DstPtr);
 728         NewStore->setAlignment(MTI->getAlignment());
 729       } else {
 730         // Noop transfer. Src == Dst
 731       }
 732
 733       MTI->eraseFromParent();
 734       continue;
 735     }
 736
 737     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(User)) {
 738       if (II->getIntrinsicID() == Intrinsic::lifetime_start ||
 739           II->getIntrinsicID() == Intrinsic::lifetime_end) {
 740         // There's no need to preserve these, as the resulting alloca will be
 741         // converted to a register anyways.
 742         II->eraseFromParent();
 743         continue;
 744       }
 745     }
 746
 747     llvm_unreachable("Unsupported operation!");
 748   }
 749 }
 750
 751 /// ConvertScalar_ExtractValue - Extract a value of type ToType from an integer
 752 /// or vector value FromVal, extracting the bits from the offset specified by
 753 /// Offset.  This returns the value, which is of type ToType.
 754 ///
 755 /// This happens when we are converting an "integer union" to a single
 756 /// integer scalar, or when we are converting a "vector union" to a vector with
 757 /// insert/extractelement instructions.
 758 ///
 759 /// Offset is an offset from the original alloca, in bits that need to be
 760 /// shifted to the right.
 761 Value *ConvertToScalarInfo::
 762 ConvertScalar_ExtractValue(Value *FromVal, Type *ToType,
 763                            uint64_t Offset, Value* NonConstantIdx,
 764                            IRBuilder<> &Builder) {
 765   // If the load is of the whole new alloca, no conversion is needed.
 766   Type *FromType = FromVal->getType();
 767   if (FromType == ToType && Offset == 0)
 768     return FromVal;
 769
 770   // If the result alloca is a vector type, this is either an element
 771   // access or a bitcast to another vector type of the same size.
 772   if (VectorType *VTy = dyn_cast<VectorType>(FromType)) {
 773     unsigned FromTypeSize = DL.getTypeAllocSize(FromType);
 774     unsigned ToTypeSize = DL.getTypeAllocSize(ToType);
 775     if (FromTypeSize == ToTypeSize)
 776         return Builder.CreateBitCast(FromVal, ToType);
 777
 778     // Otherwise it must be an element access.
 779     unsigned Elt = 0;
 780     if (Offset) {
 781       unsigned EltSize = DL.getTypeAllocSizeInBits(VTy->getElementType());
 782       Elt = Offset/EltSize;
 783       assert(EltSize*Elt == Offset && "Invalid modulus in validity checking");
 784     }
 785     // Return the element extracted out of it.
 786     Value *Idx;
 787     if (NonConstantIdx) {
 788       if (Elt)
 789         Idx = Builder.CreateAdd(NonConstantIdx,
 790                                 Builder.getInt32(Elt),
 791                                 "dyn.offset");
 792       else
 793         Idx = NonConstantIdx;
 794     } else
 795       Idx = Builder.getInt32(Elt);
 796     Value *V = Builder.CreateExtractElement(FromVal, Idx);
 797     if (V->getType() != ToType)
 798       V = Builder.CreateBitCast(V, ToType);
 799     return V;
 800   }
 801
 802   // If ToType is a first class aggregate, extract out each of the pieces and
 803   // use insertvalue's to form the FCA.
 804   if (StructType *ST = dyn_cast<StructType>(ToType)) {
 805     assert(!NonConstantIdx &&
 806            "Dynamic indexing into struct types not supported");
 807     const StructLayout &Layout = *DL.getStructLayout(ST);
 808     Value *Res = UndefValue::get(ST);
 809     for (unsigned i = 0, e = ST->getNumElements(); i != e; ++i) {
 810       Value *Elt = ConvertScalar_ExtractValue(FromVal, ST->getElementType(i),
 811                                         Offset+Layout.getElementOffsetInBits(i),
 812                                               0, Builder);
 813       Res = Builder.CreateInsertValue(Res, Elt, i);
 814     }
 815     return Res;
 816   }
 817
 818   if (ArrayType *AT = dyn_cast<ArrayType>(ToType)) {
 819     assert(!NonConstantIdx &&
 820            "Dynamic indexing into array types not supported");
 821     uint64_t EltSize = DL.getTypeAllocSizeInBits(AT->getElementType());
 822     Value *Res = UndefValue::get(AT);
 823     for (unsigned i = 0, e = AT->getNumElements(); i != e; ++i) {
 824       Value *Elt = ConvertScalar_ExtractValue(FromVal, AT->getElementType(),
 825                                               Offset+i*EltSize, 0, Builder);
 826       Res = Builder.CreateInsertValue(Res, Elt, i);
 827     }
 828     return Res;
 829   }
 830
 831   // Otherwise, this must be a union that was converted to an integer value.
 832   IntegerType *NTy = cast<IntegerType>(FromVal->getType());
 833
 834   // If this is a big-endian system and the load is narrower than the
 835   // full alloca type, we need to do a shift to get the right bits.
 836   int ShAmt = 0;
 837   if (DL.isBigEndian()) {
 838     // On big-endian machines, the lowest bit is stored at the bit offset
 839     // from the pointer given by getTypeStoreSizeInBits.  This matters for
 840     // integers with a bitwidth that is not a multiple of 8.
 841     ShAmt = DL.getTypeStoreSizeInBits(NTy) -
 842             DL.getTypeStoreSizeInBits(ToType) - Offset;
 843   } else {
 844     ShAmt = Offset;
 845   }
 846
 847   // Note: we support negative bitwidths (with shl) which are not defined.
 848   // We do this to support (f.e.) loads off the end of a structure where
 849   // only some bits are used.
 850   if (ShAmt > 0 && (unsigned)ShAmt < NTy->getBitWidth())
 851     FromVal = Builder.CreateLShr(FromVal,
 852                                  ConstantInt::get(FromVal->getType(), ShAmt));
 853   else if (ShAmt < 0 && (unsigned)-ShAmt < NTy->getBitWidth())
 854     FromVal = Builder.CreateShl(FromVal,
 855                                 ConstantInt::get(FromVal->getType(), -ShAmt));
 856
 857   // Finally, unconditionally truncate the integer to the right width.
 858   unsigned LIBitWidth = DL.getTypeSizeInBits(ToType);
 859   if (LIBitWidth < NTy->getBitWidth())
 860     FromVal =
 861       Builder.CreateTrunc(FromVal, IntegerType::get(FromVal->getContext(),
 862                                                     LIBitWidth));
 863   else if (LIBitWidth > NTy->getBitWidth())
 864     FromVal =
 865        Builder.CreateZExt(FromVal, IntegerType::get(FromVal->getContext(),
 866                                                     LIBitWidth));
 867
 868   // If the result is an integer, this is a trunc or bitcast.
 869   if (ToType->isIntegerTy()) {
 870     // Should be done.
 871   } else if (ToType->isFloatingPointTy() || ToType->isVectorTy()) {
 872     // Just do a bitcast, we know the sizes match up.
 873     FromVal = Builder.CreateBitCast(FromVal, ToType);
 874   } else {
 875     // Otherwise must be a pointer.
 876     FromVal = Builder.CreateIntToPtr(FromVal, ToType);
 877   }
 878   assert(FromVal->getType() == ToType && "Didn't convert right?");
 879   return FromVal;
 880 }
 881
 882 /// ConvertScalar_InsertValue - Insert the value "SV" into the existing integer
 883 /// or vector value "Old" at the offset specified by Offset.
 884 ///
 885 /// This happens when we are converting an "integer union" to a
 886 /// single integer scalar, or when we are converting a "vector union" to a
 887 /// vector with insert/extractelement instructions.
 888 ///
 889 /// Offset is an offset from the original alloca, in bits that need to be
 890 /// shifted to the right.
 891 ///
 892 /// NonConstantIdx is an index value if there was a GEP with a non-constant
 893 /// index value.  If this is 0 then all GEPs used to find this insert address
 894 /// are constant.
 895 Value *ConvertToScalarInfo::
 896 ConvertScalar_InsertValue(Value *SV, Value *Old,
 897                           uint64_t Offset, Value* NonConstantIdx,
 898                           IRBuilder<> &Builder) {
 899   // Convert the stored type to the actual type, shift it left to insert
 900   // then 'or' into place.
 901   Type *AllocaType = Old->getType();
 902   LLVMContext &Context = Old->getContext();
 903
 904   if (VectorType *VTy = dyn_cast<VectorType>(AllocaType)) {
 905     uint64_t VecSize = DL.getTypeAllocSizeInBits(VTy);
 906     uint64_t ValSize = DL.getTypeAllocSizeInBits(SV->getType());
 907
 908     // Changing the whole vector with memset or with an access of a different
 909     // vector type?
 910     if (ValSize == VecSize)
 911         return Builder.CreateBitCast(SV, AllocaType);
 912
 913     // Must be an element insertion.
 914     Type *EltTy = VTy->getElementType();
 915     if (SV->getType() != EltTy)
 916       SV = Builder.CreateBitCast(SV, EltTy);
 917     uint64_t EltSize = DL.getTypeAllocSizeInBits(EltTy);
 918     unsigned Elt = Offset/EltSize;
 919     Value *Idx;
 920     if (NonConstantIdx) {
 921       if (Elt)
 922         Idx = Builder.CreateAdd(NonConstantIdx,
 923                                 Builder.getInt32(Elt),
 924                                 "dyn.offset");
 925       else
 926         Idx = NonConstantIdx;
 927     } else
 928       Idx = Builder.getInt32(Elt);
 929     return Builder.CreateInsertElement(Old, SV, Idx);
 930   }
 931
 932   // If SV is a first-class aggregate value, insert each value recursively.
 933   if (StructType *ST = dyn_cast<StructType>(SV->getType())) {
 934     assert(!NonConstantIdx &&
 935            "Dynamic indexing into struct types not supported");
 936     const StructLayout &Layout = *DL.getStructLayout(ST);
 937     for (unsigned i = 0, e = ST->getNumElements(); i != e; ++i) {
 938       Value *Elt = Builder.CreateExtractValue(SV, i);
 939       Old = ConvertScalar_InsertValue(Elt, Old,
 940                                       Offset+Layout.getElementOffsetInBits(i),
 941                                       0, Builder);
 942     }
 943     return Old;
 944   }
 945
 946   if (ArrayType *AT = dyn_cast<ArrayType>(SV->getType())) {
 947     assert(!NonConstantIdx &&
 948            "Dynamic indexing into array types not supported");
 949     uint64_t EltSize = DL.getTypeAllocSizeInBits(AT->getElementType());
 950     for (unsigned i = 0, e = AT->getNumElements(); i != e; ++i) {
 951       Value *Elt = Builder.CreateExtractValue(SV, i);
 952       Old = ConvertScalar_InsertValue(Elt, Old, Offset+i*EltSize, 0, Builder);
 953     }
 954     return Old;
 955   }
 956
 957   // If SV is a float, convert it to the appropriate integer type.
 958   // If it is a pointer, do the same.
 959   unsigned SrcWidth = DL.getTypeSizeInBits(SV->getType());
 960   unsigned DestWidth = DL.getTypeSizeInBits(AllocaType);
 961   unsigned SrcStoreWidth = DL.getTypeStoreSizeInBits(SV->getType());
 962   unsigned DestStoreWidth = DL.getTypeStoreSizeInBits(AllocaType);
 963   if (SV->getType()->isFloatingPointTy() || SV->getType()->isVectorTy())
 964     SV = Builder.CreateBitCast(SV, IntegerType::get(SV->getContext(),SrcWidth));
 965   else if (SV->getType()->isPointerTy())
 966     SV = Builder.CreatePtrToInt(SV, DL.getIntPtrType(SV->getType()));
 967
 968   // Zero extend or truncate the value if needed.
 969   if (SV->getType() != AllocaType) {
 970     if (SV->getType()->getPrimitiveSizeInBits() <
 971              AllocaType->getPrimitiveSizeInBits())
 972       SV = Builder.CreateZExt(SV, AllocaType);
 973     else {
 974       // Truncation may be needed if storing more than the alloca can hold
 975       // (undefined behavior).
 976       SV = Builder.CreateTrunc(SV, AllocaType);
 977       SrcWidth = DestWidth;
 978       SrcStoreWidth = DestStoreWidth;
 979     }
 980   }
 981
 982   // If this is a big-endian system and the store is narrower than the
 983   // full alloca type, we need to do a shift to get the right bits.
 984   int ShAmt = 0;
 985   if (DL.isBigEndian()) {
 986     // On big-endian machines, the lowest bit is stored at the bit offset
 987     // from the pointer given by getTypeStoreSizeInBits.  This matters for
 988     // integers with a bitwidth that is not a multiple of 8.
 989     ShAmt = DestStoreWidth - SrcStoreWidth - Offset;
 990   } else {
 991     ShAmt = Offset;
 992   }
 993
 994   // Note: we support negative bitwidths (with shr) which are not defined.
 995   // We do this to support (f.e.) stores off the end of a structure where
 996   // only some bits in the structure are set.
 997   APInt Mask(APInt::getLowBitsSet(DestWidth, SrcWidth));
 998   if (ShAmt > 0 && (unsigned)ShAmt < DestWidth) {
 999     SV = Builder.CreateShl(SV, ConstantInt::get(SV->getType(), ShAmt));
1000     Mask <<= ShAmt;
1001   } else if (ShAmt < 0 && (unsigned)-ShAmt < DestWidth) {
1002     SV = Builder.CreateLShr(SV, ConstantInt::get(SV->getType(), -ShAmt));
1003     Mask = Mask.lshr(-ShAmt);
1004   }
1005
1006   // Mask out the bits we are about to insert from the old value, and or
1007   // in the new bits.
1008   if (SrcWidth != DestWidth) {
1009     assert(DestWidth > SrcWidth);
1010     Old = Builder.CreateAnd(Old, ConstantInt::get(Context, ~Mask), "mask");
1011     SV = Builder.CreateOr(Old, SV, "ins");
1012   }
1013   return SV;
1014 }
1015
1016
1017 //===----------------------------------------------------------------------===//
1018 // SRoA Driver
1019 //===----------------------------------------------------------------------===//
1020
1021
1022 bool SROA::runOnFunction(Function &F) {
1023   if (skipOptnoneFunction(F))
1024     return false;
1025
1026   DL = getAnalysisIfAvailable<DataLayout>();
1027
1028   bool Changed = performPromotion(F);
1029
1030   // FIXME: ScalarRepl currently depends on DataLayout more than it
1031   // theoretically needs to. It should be refactored in order to support
1032   // target-independent IR. Until this is done, just skip the actual
1033   // scalar-replacement portion of this pass.
1034   if (!DL) return Changed;
1035
1036   while (1) {
1037     bool LocalChange = performScalarRepl(F);
1038     if (!LocalChange) break;   // No need to repromote if no scalarrepl
1039     Changed = true;
1040     LocalChange = performPromotion(F);
1041     if (!LocalChange) break;   // No need to re-scalarrepl if no promotion
1042   }
1043
1044   return Changed;
1045 }
1046
1047 namespace {
1048 class AllocaPromoter : public LoadAndStorePromoter {
1049   AllocaInst *AI;
1050   DIBuilder *DIB;
1051   SmallVector<DbgDeclareInst *, 4> DDIs;
1052   SmallVector<DbgValueInst *, 4> DVIs;
1053 public:
1054   AllocaPromoter(const SmallVectorImpl<Instruction*> &Insts, SSAUpdater &S,
1055                  DIBuilder *DB)
1056     : LoadAndStorePromoter(Insts, S), AI(0), DIB(DB) {}
1057
1058   void run(AllocaInst *AI, const SmallVectorImpl<Instruction*> &Insts) {
1059     // Remember which alloca we're promoting (for isInstInList).
1060     this->AI = AI;
1061     if (MDNode *DebugNode = MDNode::getIfExists(AI->getContext(), AI)) {
1062       for (Value::use_iterator UI = DebugNode->use_begin(),
1063              E = DebugNode->use_end(); UI != E; ++UI)
1064         if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(*UI))
1065           DDIs.push_back(DDI);
1066         else if (DbgValueInst *DVI = dyn_cast<DbgValueInst>(*UI))
1067           DVIs.push_back(DVI);
1068     }
1069
1070     LoadAndStorePromoter::run(Insts);
1071     AI->eraseFromParent();
1072     for (SmallVectorImpl<DbgDeclareInst *>::iterator I = DDIs.begin(),
1073            E = DDIs.end(); I != E; ++I) {
1074       DbgDeclareInst *DDI = *I;
1075       DDI->eraseFromParent();
1076     }
1077     for (SmallVectorImpl<DbgValueInst *>::iterator I = DVIs.begin(),
1078            E = DVIs.end(); I != E; ++I) {
1079       DbgValueInst *DVI = *I;
1080       DVI->eraseFromParent();
1081     }
1082   }
1083
1084   virtual bool isInstInList(Instruction *I,
1085                             const SmallVectorImpl<Instruction*> &Insts) const {
1086     if (LoadInst *LI = dyn_cast<LoadInst>(I))
1087       return LI->getOperand(0) == AI;
1088     return cast<StoreInst>(I)->getPointerOperand() == AI;
1089   }
1090
1091   virtual void updateDebugInfo(Instruction *Inst) const {
1092     for (SmallVectorImpl<DbgDeclareInst *>::const_iterator I = DDIs.begin(),
1093            E = DDIs.end(); I != E; ++I) {
1094       DbgDeclareInst *DDI = *I;
1095       if (StoreInst *SI = dyn_cast<StoreInst>(Inst))
1096         ConvertDebugDeclareToDebugValue(DDI, SI, *DIB);
1097       else if (LoadInst *LI = dyn_cast<LoadInst>(Inst))
1098         ConvertDebugDeclareToDebugValue(DDI, LI, *DIB);
1099     }
1100     for (SmallVectorImpl<DbgValueInst *>::const_iterator I = DVIs.begin(),
1101            E = DVIs.end(); I != E; ++I) {
1102       DbgValueInst *DVI = *I;
1103       Value *Arg = NULL;
1104       if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
1105         // If an argument is zero extended then use argument directly. The ZExt
1106         // may be zapped by an optimization pass in future.
1107         if (ZExtInst *ZExt = dyn_cast<ZExtInst>(SI->getOperand(0)))
1108           Arg = dyn_cast<Argument>(ZExt->getOperand(0));
1109         if (SExtInst *SExt = dyn_cast<SExtInst>(SI->getOperand(0)))
1110           Arg = dyn_cast<Argument>(SExt->getOperand(0));
1111         if (!Arg)
1112           Arg = SI->getOperand(0);
1113       } else if (LoadInst *LI = dyn_cast<LoadInst>(Inst)) {
1114         Arg = LI->getOperand(0);
1115       } else {
1116         continue;
1117       }
1118       Instruction *DbgVal =
1119         DIB->insertDbgValueIntrinsic(Arg, 0, DIVariable(DVI->getVariable()),
1120                                      Inst);
1121       DbgVal->setDebugLoc(DVI->getDebugLoc());
1122     }
1123   }
1124 };
1125 } // end anon namespace
1126
1127 /// isSafeSelectToSpeculate - Select instructions that use an alloca and are
1128 /// subsequently loaded can be rewritten to load both input pointers and then
1129 /// select between the result, allowing the load of the alloca to be promoted.
1130 /// From this:
1131 ///   %P2 = select i1 %cond, i32* %Alloca, i32* %Other
1132 ///   %V = load i32* %P2
1133 /// to:
1134 ///   %V1 = load i32* %Alloca      -> will be mem2reg'd
1135 ///   %V2 = load i32* %Other
1136 ///   %V = select i1 %cond, i32 %V1, i32 %V2
1137 ///
1138 /// We can do this to a select if its only uses are loads and if the operand to
1139 /// the select can be loaded unconditionally.
1140 static bool isSafeSelectToSpeculate(SelectInst *SI, const DataLayout *DL) {
1141   bool TDerefable = SI->getTrueValue()->isDereferenceablePointer();
1142   bool FDerefable = SI->getFalseValue()->isDereferenceablePointer();
1143
1144   for (Value::use_iterator UI = SI->use_begin(), UE = SI->use_end();
1145        UI != UE; ++UI) {
1146     LoadInst *LI = dyn_cast<LoadInst>(*UI);
1147     if (LI == 0 || !LI->isSimple()) return false;
1148
1149     // Both operands to the select need to be dereferencable, either absolutely
1150     // (e.g. allocas) or at this point because we can see other accesses to it.
1151     if (!TDerefable && !isSafeToLoadUnconditionally(SI->getTrueValue(), LI,
1152                                                     LI->getAlignment(), DL))
1153       return false;
1154     if (!FDerefable && !isSafeToLoadUnconditionally(SI->getFalseValue(), LI,
1155                                                     LI->getAlignment(), DL))
1156       return false;
1157   }
1158
1159   return true;
1160 }
1161
1162 /// isSafePHIToSpeculate - PHI instructions that use an alloca and are
1163 /// subsequently loaded can be rewritten to load both input pointers in the pred
1164 /// blocks and then PHI the results, allowing the load of the alloca to be
1165 /// promoted.
1166 /// From this:
1167 ///   %P2 = phi [i32* %Alloca, i32* %Other]
1168 ///   %V = load i32* %P2
1169 /// to:
1170 ///   %V1 = load i32* %Alloca      -> will be mem2reg'd
1171 ///   ...
1172 ///   %V2 = load i32* %Other
1173 ///   ...
1174 ///   %V = phi [i32 %V1, i32 %V2]
1175 ///
1176 /// We can do this to a select if its only uses are loads and if the operand to
1177 /// the select can be loaded unconditionally.
1178 static bool isSafePHIToSpeculate(PHINode *PN, const DataLayout *DL) {
1179   // For now, we can only do this promotion if the load is in the same block as
1180   // the PHI, and if there are no stores between the phi and load.
1181   // TODO: Allow recursive phi users.
1182   // TODO: Allow stores.
1183   BasicBlock *BB = PN->getParent();
1184   unsigned MaxAlign = 0;
1185   for (Value::use_iterator UI = PN->use_begin(), UE = PN->use_end();
1186        UI != UE; ++UI) {
1187     LoadInst *LI = dyn_cast<LoadInst>(*UI);
1188     if (LI == 0 || !LI->isSimple()) return false;
1189
1190     // For now we only allow loads in the same block as the PHI.  This is a
1191     // common case that happens when instcombine merges two loads through a PHI.
1192     if (LI->getParent() != BB) return false;
1193
1194     // Ensure that there are no instructions between the PHI and the load that
1195     // could store.
1196     for (BasicBlock::iterator BBI = PN; &*BBI != LI; ++BBI)
1197       if (BBI->mayWriteToMemory())
1198         return false;
1199
1200     MaxAlign = std::max(MaxAlign, LI->getAlignment());
1201   }
1202
1203   // Okay, we know that we have one or more loads in the same block as the PHI.
1204   // We can transform this if it is safe to push the loads into the predecessor
1205   // blocks.  The only thing to watch out for is that we can't put a possibly
1206   // trapping load in the predecessor if it is a critical edge.
1207   for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1208     BasicBlock *Pred = PN->getIncomingBlock(i);
1209     Value *InVal = PN->getIncomingValue(i);
1210
1211     // If the terminator of the predecessor has side-effects (an invoke),
1212     // there is no safe place to put a load in the predecessor.
1213     if (Pred->getTerminator()->mayHaveSideEffects())
1214       return false;
1215
1216     // If the value is produced by the terminator of the predecessor
1217     // (an invoke), there is no valid place to put a load in the predecessor.
1218     if (Pred->getTerminator() == InVal)
1219       return false;
1220
1221     // If the predecessor has a single successor, then the edge isn't critical.
1222     if (Pred->getTerminator()->getNumSuccessors() == 1)
1223       continue;
1224
1225     // If this pointer is always safe to load, or if we can prove that there is
1226     // already a load in the block, then we can move the load to the pred block.
1227     if (InVal->isDereferenceablePointer() ||
1228         isSafeToLoadUnconditionally(InVal, Pred->getTerminator(), MaxAlign, DL))
1229       continue;
1230
1231     return false;
1232   }
1233
1234   return true;
1235 }
1236
1237
1238 /// tryToMakeAllocaBePromotable - This returns true if the alloca only has
1239 /// direct (non-volatile) loads and stores to it.  If the alloca is close but
1240 /// not quite there, this will transform the code to allow promotion.  As such,
1241 /// it is a non-pure predicate.
1242 static bool tryToMakeAllocaBePromotable(AllocaInst *AI, const DataLayout *DL) {
1243   SetVector<Instruction*, SmallVector<Instruction*, 4>,
1244             SmallPtrSet<Instruction*, 4> > InstsToRewrite;
1245
1246   for (Value::use_iterator UI = AI->use_begin(), UE = AI->use_end();
1247        UI != UE; ++UI) {
1248     User *U = *UI;
1249     if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
1250       if (!LI->isSimple())
1251         return false;
1252       continue;
1253     }
1254
1255     if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
1256       if (SI->getOperand(0) == AI || !SI->isSimple())
1257         return false;   // Don't allow a store OF the AI, only INTO the AI.
1258       continue;
1259     }
1260
1261     if (SelectInst *SI = dyn_cast<SelectInst>(U)) {
1262       // If the condition being selected on is a constant, fold the select, yes
1263       // this does (rarely) happen early on.
1264       if (ConstantInt *CI = dyn_cast<ConstantInt>(SI->getCondition())) {
1265         Value *Result = SI->getOperand(1+CI->isZero());
1266         SI->replaceAllUsesWith(Result);
1267         SI->eraseFromParent();
1268
1269         // This is very rare and we just scrambled the use list of AI, start
1270         // over completely.
1271         return tryToMakeAllocaBePromotable(AI, DL);
1272       }
1273
1274       // If it is safe to turn "load (select c, AI, ptr)" into a select of two
1275       // loads, then we can transform this by rewriting the select.
1276       if (!isSafeSelectToSpeculate(SI, DL))
1277         return false;
1278
1279       InstsToRewrite.insert(SI);
1280       continue;
1281     }
1282
1283     if (PHINode *PN = dyn_cast<PHINode>(U)) {
1284       if (PN->use_empty()) {  // Dead PHIs can be stripped.
1285         InstsToRewrite.insert(PN);
1286         continue;
1287       }
1288
1289       // If it is safe to turn "load (phi [AI, ptr, ...])" into a PHI of loads
1290       // in the pred blocks, then we can transform this by rewriting the PHI.
1291       if (!isSafePHIToSpeculate(PN, DL))
1292         return false;
1293
1294       InstsToRewrite.insert(PN);
1295       continue;
1296     }
1297
1298     if (BitCastInst *BCI = dyn_cast<BitCastInst>(U)) {
1299       if (onlyUsedByLifetimeMarkers(BCI)) {
1300         InstsToRewrite.insert(BCI);
1301         continue;
1302       }
1303     }
1304
1305     return false;
1306   }
1307
1308   // If there are no instructions to rewrite, then all uses are load/stores and
1309   // we're done!
1310   if (InstsToRewrite.empty())
1311     return true;
1312
1313   // If we have instructions that need to be rewritten for this to be promotable
1314   // take care of it now.
1315   for (unsigned i = 0, e = InstsToRewrite.size(); i != e; ++i) {
1316     if (BitCastInst *BCI = dyn_cast<BitCastInst>(InstsToRewrite[i])) {
1317       // This could only be a bitcast used by nothing but lifetime intrinsics.
1318       for (BitCastInst::use_iterator I = BCI->use_begin(), E = BCI->use_end();
1319            I != E;) {
1320         Use &U = I.getUse();
1321         ++I;
1322         cast<Instruction>(U.getUser())->eraseFromParent();
1323       }
1324       BCI->eraseFromParent();
1325       continue;
1326     }
1327
1328     if (SelectInst *SI = dyn_cast<SelectInst>(InstsToRewrite[i])) {
1329       // Selects in InstsToRewrite only have load uses.  Rewrite each as two
1330       // loads with a new select.
1331       while (!SI->use_empty()) {
1332         LoadInst *LI = cast<LoadInst>(SI->use_back());
1333
1334         IRBuilder<> Builder(LI);
1335         LoadInst *TrueLoad =
1336           Builder.CreateLoad(SI->getTrueValue(), LI->getName()+".t");
1337         LoadInst *FalseLoad =
1338           Builder.CreateLoad(SI->getFalseValue(), LI->getName()+".f");
1339
1340         // Transfer alignment and TBAA info if present.
1341         TrueLoad->setAlignment(LI->getAlignment());
1342         FalseLoad->setAlignment(LI->getAlignment());
1343         if (MDNode *Tag = LI->getMetadata(LLVMContext::MD_tbaa)) {
1344           TrueLoad->setMetadata(LLVMContext::MD_tbaa, Tag);
1345           FalseLoad->setMetadata(LLVMContext::MD_tbaa, Tag);
1346         }
1347
1348         Value *V = Builder.CreateSelect(SI->getCondition(), TrueLoad, FalseLoad);
1349         V->takeName(LI);
1350         LI->replaceAllUsesWith(V);
1351         LI->eraseFromParent();
1352       }
1353
1354       // Now that all the loads are gone, the select is gone too.
1355       SI->eraseFromParent();
1356       continue;
1357     }
1358
1359     // Otherwise, we have a PHI node which allows us to push the loads into the
1360     // predecessors.
1361     PHINode *PN = cast<PHINode>(InstsToRewrite[i]);
1362     if (PN->use_empty()) {
1363       PN->eraseFromParent();
1364       continue;
1365     }
1366
1367     Type *LoadTy = cast<PointerType>(PN->getType())->getElementType();
1368     PHINode *NewPN = PHINode::Create(LoadTy, PN->getNumIncomingValues(),
1369                                      PN->getName()+".ld", PN);
1370
1371     // Get the TBAA tag and alignment to use from one of the loads.  It doesn't
1372     // matter which one we get and if any differ, it doesn't matter.
1373     LoadInst *SomeLoad = cast<LoadInst>(PN->use_back());
1374     MDNode *TBAATag = SomeLoad->getMetadata(LLVMContext::MD_tbaa);
1375     unsigned Align = SomeLoad->getAlignment();
1376
1377     // Rewrite all loads of the PN to use the new PHI.
1378     while (!PN->use_empty()) {
1379       LoadInst *LI = cast<LoadInst>(PN->use_back());
1380       LI->replaceAllUsesWith(NewPN);
1381       LI->eraseFromParent();
1382     }
1383
1384     // Inject loads into all of the pred blocks.  Keep track of which blocks we
1385     // insert them into in case we have multiple edges from the same block.
1386     DenseMap<BasicBlock*, LoadInst*> InsertedLoads;
1387
1388     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1389       BasicBlock *Pred = PN->getIncomingBlock(i);
1390       LoadInst *&Load = InsertedLoads[Pred];
1391       if (Load == 0) {
1392         Load = new LoadInst(PN->getIncomingValue(i),
1393                             PN->getName() + "." + Pred->getName(),
1394                             Pred->getTerminator());
1395         Load->setAlignment(Align);
1396         if (TBAATag) Load->setMetadata(LLVMContext::MD_tbaa, TBAATag);
1397       }
1398
1399       NewPN->addIncoming(Load, Pred);
1400     }
1401
1402     PN->eraseFromParent();
1403   }
1404
1405   ++NumAdjusted;
1406   return true;
1407 }
1408
1409 bool SROA::performPromotion(Function &F) {
1410   std::vector<AllocaInst*> Allocas;
1411   DominatorTree *DT = 0;
1412   if (HasDomTree)
1413     DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree();
1414
1415   BasicBlock &BB = F.getEntryBlock();  // Get the entry node for the function
1416   DIBuilder DIB(*F.getParent());
1417   bool Changed = false;
1418   SmallVector<Instruction*, 64> Insts;
1419   while (1) {
1420     Allocas.clear();
1421
1422     // Find allocas that are safe to promote, by looking at all instructions in
1423     // the entry node
1424     for (BasicBlock::iterator I = BB.begin(), E = --BB.end(); I != E; ++I)
1425       if (AllocaInst *AI = dyn_cast<AllocaInst>(I))       // Is it an alloca?
1426         if (tryToMakeAllocaBePromotable(AI, DL))
1427           Allocas.push_back(AI);
1428
1429     if (Allocas.empty()) break;
1430
1431     if (HasDomTree)
1432       PromoteMemToReg(Allocas, *DT);
1433     else {
1434       SSAUpdater SSA;
1435       for (unsigned i = 0, e = Allocas.size(); i != e; ++i) {
1436         AllocaInst *AI = Allocas[i];
1437
1438         // Build list of instructions to promote.
1439         for (Value::use_iterator UI = AI->use_begin(), E = AI->use_end();
1440              UI != E; ++UI)
1441           Insts.push_back(cast<Instruction>(*UI));
1442         AllocaPromoter(Insts, SSA, &DIB).run(AI, Insts);
1443         Insts.clear();
1444       }
1445     }
1446     NumPromoted += Allocas.size();
1447     Changed = true;
1448   }
1449
1450   return Changed;
1451 }
1452
1453
1454 /// ShouldAttemptScalarRepl - Decide if an alloca is a good candidate for
1455 /// SROA.  It must be a struct or array type with a small number of elements.
1456 bool SROA::ShouldAttemptScalarRepl(AllocaInst *AI) {
1457   Type *T = AI->getAllocatedType();
1458   // Do not promote any struct that has too many members.
1459   if (StructType *ST = dyn_cast<StructType>(T))
1460     return ST->getNumElements() <= StructMemberThreshold;
1461   // Do not promote any array that has too many elements.
1462   if (ArrayType *AT = dyn_cast<ArrayType>(T))
1463     return AT->getNumElements() <= ArrayElementThreshold;
1464   return false;
1465 }
1466
1467 // performScalarRepl - This algorithm is a simple worklist driven algorithm,
1468 // which runs on all of the alloca instructions in the entry block, removing
1469 // them if they are only used by getelementptr instructions.
1470 //
1471 bool SROA::performScalarRepl(Function &F) {
1472   std::vector<AllocaInst*> WorkList;
1473
1474   // Scan the entry basic block, adding allocas to the worklist.
1475   BasicBlock &BB = F.getEntryBlock();
1476   for (BasicBlock::iterator I = BB.begin(), E = BB.end(); I != E; ++I)
1477     if (AllocaInst *A = dyn_cast<AllocaInst>(I))
1478       WorkList.push_back(A);
1479
1480   // Process the worklist
1481   bool Changed = false;
1482   while (!WorkList.empty()) {
1483     AllocaInst *AI = WorkList.back();
1484     WorkList.pop_back();
1485
1486     // Handle dead allocas trivially.  These can be formed by SROA'ing arrays
1487     // with unused elements.
1488     if (AI->use_empty()) {
1489       AI->eraseFromParent();
1490       Changed = true;
1491       continue;
1492     }
1493
1494     // If this alloca is impossible for us to promote, reject it early.
1495     if (AI->isArrayAllocation() || !AI->getAllocatedType()->isSized())
1496       continue;
1497
1498     // Check to see if we can perform the core SROA transformation.  We cannot
1499     // transform the allocation instruction if it is an array allocation
1500     // (allocations OF arrays are ok though), and an allocation of a scalar
1501     // value cannot be decomposed at all.
1502     uint64_t AllocaSize = DL->getTypeAllocSize(AI->getAllocatedType());
1503
1504     // Do not promote [0 x %struct].
1505     if (AllocaSize == 0) continue;
1506
1507     // Do not promote any struct whose size is too big.
1508     if (AllocaSize > SRThreshold) continue;
1509
1510     // If the alloca looks like a good candidate for scalar replacement, and if
1511     // all its users can be transformed, then split up the aggregate into its
1512     // separate elements.
1513     if (ShouldAttemptScalarRepl(AI) && isSafeAllocaToScalarRepl(AI)) {
1514       DoScalarReplacement(AI, WorkList);
1515       Changed = true;
1516       continue;
1517     }
1518
1519     // If we can turn this aggregate value (potentially with casts) into a
1520     // simple scalar value that can be mem2reg'd into a register value.
1521     // IsNotTrivial tracks whether this is something that mem2reg could have
1522     // promoted itself.  If so, we don't want to transform it needlessly.  Note
1523     // that we can't just check based on the type: the alloca may be of an i32
1524     // but that has pointer arithmetic to set byte 3 of it or something.
1525     if (AllocaInst *NewAI = ConvertToScalarInfo(
1526               (unsigned)AllocaSize, *DL, ScalarLoadThreshold).TryConvert(AI)) {
1527       NewAI->takeName(AI);
1528       AI->eraseFromParent();
1529       ++NumConverted;
1530       Changed = true;
1531       continue;
1532     }
1533
1534     // Otherwise, couldn't process this alloca.
1535   }
1536
1537   return Changed;
1538 }
1539
1540 /// DoScalarReplacement - This alloca satisfied the isSafeAllocaToScalarRepl
1541 /// predicate, do SROA now.
1542 void SROA::DoScalarReplacement(AllocaInst *AI,
1543                                std::vector<AllocaInst*> &WorkList) {
1544   DEBUG(dbgs() << "Found inst to SROA: " << *AI << '\n');
1545   SmallVector<AllocaInst*, 32> ElementAllocas;
1546   if (StructType *ST = dyn_cast<StructType>(AI->getAllocatedType())) {
1547     ElementAllocas.reserve(ST->getNumContainedTypes());
1548     for (unsigned i = 0, e = ST->getNumContainedTypes(); i != e; ++i) {
1549       AllocaInst *NA = new AllocaInst(ST->getContainedType(i), 0,
1550                                       AI->getAlignment(),
1551                                       AI->getName() + "." + Twine(i), AI);
1552       ElementAllocas.push_back(NA);
1553       WorkList.push_back(NA);  // Add to worklist for recursive processing
1554     }
1555   } else {
1556     ArrayType *AT = cast<ArrayType>(AI->getAllocatedType());
1557     ElementAllocas.reserve(AT->getNumElements());
1558     Type *ElTy = AT->getElementType();
1559     for (unsigned i = 0, e = AT->getNumElements(); i != e; ++i) {
1560       AllocaInst *NA = new AllocaInst(ElTy, 0, AI->getAlignment(),
1561                                       AI->getName() + "." + Twine(i), AI);
1562       ElementAllocas.push_back(NA);
1563       WorkList.push_back(NA);  // Add to worklist for recursive processing
1564     }
1565   }
1566
1567   // Now that we have created the new alloca instructions, rewrite all the
1568   // uses of the old alloca.
1569   RewriteForScalarRepl(AI, AI, 0, ElementAllocas);
1570
1571   // Now erase any instructions that were made dead while rewriting the alloca.
1572   DeleteDeadInstructions();
1573   AI->eraseFromParent();
1574
1575   ++NumReplaced;
1576 }
1577
1578 /// DeleteDeadInstructions - Erase instructions on the DeadInstrs list,
1579 /// recursively including all their operands that become trivially dead.
1580 void SROA::DeleteDeadInstructions() {
1581   while (!DeadInsts.empty()) {
1582     Instruction *I = cast<Instruction>(DeadInsts.pop_back_val());
1583
1584     for (User::op_iterator OI = I->op_begin(), E = I->op_end(); OI != E; ++OI)
1585       if (Instruction *U = dyn_cast<Instruction>(*OI)) {
1586         // Zero out the operand and see if it becomes trivially dead.
1587         // (But, don't add allocas to the dead instruction list -- they are
1588         // already on the worklist and will be deleted separately.)
1589         *OI = 0;
1590         if (isInstructionTriviallyDead(U) && !isa<AllocaInst>(U))
1591           DeadInsts.push_back(U);
1592       }
1593
1594     I->eraseFromParent();
1595   }
1596 }
1597
1598 /// isSafeForScalarRepl - Check if instruction I is a safe use with regard to
1599 /// performing scalar replacement of alloca AI.  The results are flagged in
1600 /// the Info parameter.  Offset indicates the position within AI that is
1601 /// referenced by this instruction.
1602 void SROA::isSafeForScalarRepl(Instruction *I, uint64_t Offset,
1603                                AllocaInfo &Info) {
1604   for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI!=E; ++UI) {
1605     Instruction *User = cast<Instruction>(*UI);
1606
1607     if (BitCastInst *BC = dyn_cast<BitCastInst>(User)) {
1608       isSafeForScalarRepl(BC, Offset, Info);
1609     } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
1610       uint64_t GEPOffset = Offset;
1611       isSafeGEP(GEPI, GEPOffset, Info);
1612       if (!Info.isUnsafe)
1613         isSafeForScalarRepl(GEPI, GEPOffset, Info);
1614     } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(User)) {
1615       ConstantInt *Length = dyn_cast<ConstantInt>(MI->getLength());
1616       if (Length == 0)
1617         return MarkUnsafe(Info, User);
1618       if (Length->isNegative())
1619         return MarkUnsafe(Info, User);
1620
1621       isSafeMemAccess(Offset, Length->getZExtValue(), 0,
1622                       UI.getOperandNo() == 0, Info, MI,
1623                       true /*AllowWholeAccess*/);
1624     } else if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
1625       if (!LI->isSimple())
1626         return MarkUnsafe(Info, User);
1627       Type *LIType = LI->getType();
1628       isSafeMemAccess(Offset, DL->getTypeAllocSize(LIType),
1629                       LIType, false, Info, LI, true /*AllowWholeAccess*/);
1630       Info.hasALoadOrStore = true;
1631
1632     } else if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
1633       // Store is ok if storing INTO the pointer, not storing the pointer
1634       if (!SI->isSimple() || SI->getOperand(0) == I)
1635         return MarkUnsafe(Info, User);
1636
1637       Type *SIType = SI->getOperand(0)->getType();
1638       isSafeMemAccess(Offset, DL->getTypeAllocSize(SIType),
1639                       SIType, true, Info, SI, true /*AllowWholeAccess*/);
1640       Info.hasALoadOrStore = true;
1641     } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(User)) {
1642       if (II->getIntrinsicID() != Intrinsic::lifetime_start &&
1643           II->getIntrinsicID() != Intrinsic::lifetime_end)
1644         return MarkUnsafe(Info, User);
1645     } else if (isa<PHINode>(User) || isa<SelectInst>(User)) {
1646       isSafePHISelectUseForScalarRepl(User, Offset, Info);
1647     } else {
1648       return MarkUnsafe(Info, User);
1649     }
1650     if (Info.isUnsafe) return;
1651   }
1652 }
1653
1654
1655 /// isSafePHIUseForScalarRepl - If we see a PHI node or select using a pointer
1656 /// derived from the alloca, we can often still split the alloca into elements.
1657 /// This is useful if we have a large alloca where one element is phi'd
1658 /// together somewhere: we can SRoA and promote all the other elements even if
1659 /// we end up not being able to promote this one.
1660 ///
1661 /// All we require is that the uses of the PHI do not index into other parts of
1662 /// the alloca.  The most important use case for this is single load and stores
1663 /// that are PHI'd together, which can happen due to code sinking.
1664 void SROA::isSafePHISelectUseForScalarRepl(Instruction *I, uint64_t Offset,
1665                                            AllocaInfo &Info) {
1666   // If we've already checked this PHI, don't do it again.
1667   if (PHINode *PN = dyn_cast<PHINode>(I))
1668     if (!Info.CheckedPHIs.insert(PN))
1669       return;
1670
1671   for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI!=E; ++UI) {
1672     Instruction *User = cast<Instruction>(*UI);
1673
1674     if (BitCastInst *BC = dyn_cast<BitCastInst>(User)) {
1675       isSafePHISelectUseForScalarRepl(BC, Offset, Info);
1676     } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
1677       // Only allow "bitcast" GEPs for simplicity.  We could generalize this,
1678       // but would have to prove that we're staying inside of an element being
1679       // promoted.
1680       if (!GEPI->hasAllZeroIndices())
1681         return MarkUnsafe(Info, User);
1682       isSafePHISelectUseForScalarRepl(GEPI, Offset, Info);
1683     } else if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
1684       if (!LI->isSimple())
1685         return MarkUnsafe(Info, User);
1686       Type *LIType = LI->getType();
1687       isSafeMemAccess(Offset, DL->getTypeAllocSize(LIType),
1688                       LIType, false, Info, LI, false /*AllowWholeAccess*/);
1689       Info.hasALoadOrStore = true;
1690
1691     } else if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
1692       // Store is ok if storing INTO the pointer, not storing the pointer
1693       if (!SI->isSimple() || SI->getOperand(0) == I)
1694         return MarkUnsafe(Info, User);
1695
1696       Type *SIType = SI->getOperand(0)->getType();
1697       isSafeMemAccess(Offset, DL->getTypeAllocSize(SIType),
1698                       SIType, true, Info, SI, false /*AllowWholeAccess*/);
1699       Info.hasALoadOrStore = true;
1700     } else if (isa<PHINode>(User) || isa<SelectInst>(User)) {
1701       isSafePHISelectUseForScalarRepl(User, Offset, Info);
1702     } else {
1703       return MarkUnsafe(Info, User);
1704     }
1705     if (Info.isUnsafe) return;
1706   }
1707 }
1708
1709 /// isSafeGEP - Check if a GEP instruction can be handled for scalar
1710 /// replacement.  It is safe when all the indices are constant, in-bounds
1711 /// references, and when the resulting offset corresponds to an element within
1712 /// the alloca type.  The results are flagged in the Info parameter.  Upon
1713 /// return, Offset is adjusted as specified by the GEP indices.
1714 void SROA::isSafeGEP(GetElementPtrInst *GEPI,
1715                      uint64_t &Offset, AllocaInfo &Info) {
1716   gep_type_iterator GEPIt = gep_type_begin(GEPI), E = gep_type_end(GEPI);
1717   if (GEPIt == E)
1718     return;
1719   bool NonConstant = false;
1720   unsigned NonConstantIdxSize = 0;
1721
1722   // Walk through the GEP type indices, checking the types that this indexes
1723   // into.
1724   for (; GEPIt != E; ++GEPIt) {
1725     // Ignore struct elements, no extra checking needed for these.
1726     if ((*GEPIt)->isStructTy())
1727       continue;
1728
1729     ConstantInt *IdxVal = dyn_cast<ConstantInt>(GEPIt.getOperand());
1730     if (!IdxVal)
1731       return MarkUnsafe(Info, GEPI);
1732   }
1733
1734   // Compute the offset due to this GEP and check if the alloca has a
1735   // component element at that offset.
1736   SmallVector<Value*, 8> Indices(GEPI->op_begin() + 1, GEPI->op_end());
1737   // If this GEP is non-constant then the last operand must have been a
1738   // dynamic index into a vector.  Pop this now as it has no impact on the
1739   // constant part of the offset.
1740   if (NonConstant)
1741     Indices.pop_back();
1742   Offset += DL->getIndexedOffset(GEPI->getPointerOperandType(), Indices);
1743   if (!TypeHasComponent(Info.AI->getAllocatedType(), Offset,
1744                         NonConstantIdxSize))
1745     MarkUnsafe(Info, GEPI);
1746 }
1747
1748 /// isHomogeneousAggregate - Check if type T is a struct or array containing
1749 /// elements of the same type (which is always true for arrays).  If so,
1750 /// return true with NumElts and EltTy set to the number of elements and the
1751 /// element type, respectively.
1752 static bool isHomogeneousAggregate(Type *T, unsigned &NumElts,
1753                                    Type *&EltTy) {
1754   if (ArrayType *AT = dyn_cast<ArrayType>(T)) {
1755     NumElts = AT->getNumElements();
1756     EltTy = (NumElts == 0 ? 0 : AT->getElementType());
1757     return true;
1758   }
1759   if (StructType *ST = dyn_cast<StructType>(T)) {
1760     NumElts = ST->getNumContainedTypes();
1761     EltTy = (NumElts == 0 ? 0 : ST->getContainedType(0));
1762     for (unsigned n = 1; n < NumElts; ++n) {
1763       if (ST->getContainedType(n) != EltTy)
1764         return false;
1765     }
1766     return true;
1767   }
1768   return false;
1769 }
1770
1771 /// isCompatibleAggregate - Check if T1 and T2 are either the same type or are
1772 /// "homogeneous" aggregates with the same element type and number of elements.
1773 static bool isCompatibleAggregate(Type *T1, Type *T2) {
1774   if (T1 == T2)
1775     return true;
1776
1777   unsigned NumElts1, NumElts2;
1778   Type *EltTy1, *EltTy2;
1779   if (isHomogeneousAggregate(T1, NumElts1, EltTy1) &&
1780       isHomogeneousAggregate(T2, NumElts2, EltTy2) &&
1781       NumElts1 == NumElts2 &&
1782       EltTy1 == EltTy2)
1783     return true;
1784
1785   return false;
1786 }
1787
1788 /// isSafeMemAccess - Check if a load/store/memcpy operates on the entire AI
1789 /// alloca or has an offset and size that corresponds to a component element
1790 /// within it.  The offset checked here may have been formed from a GEP with a
1791 /// pointer bitcasted to a different type.
1792 ///
1793 /// If AllowWholeAccess is true, then this allows uses of the entire alloca as a
1794 /// unit.  If false, it only allows accesses known to be in a single element.
1795 void SROA::isSafeMemAccess(uint64_t Offset, uint64_t MemSize,
1796                            Type *MemOpType, bool isStore,
1797                            AllocaInfo &Info, Instruction *TheAccess,
1798                            bool AllowWholeAccess) {
1799   // Check if this is a load/store of the entire alloca.
1800   if (Offset == 0 && AllowWholeAccess &&
1801       MemSize == DL->getTypeAllocSize(Info.AI->getAllocatedType())) {
1802     // This can be safe for MemIntrinsics (where MemOpType is 0) and integer
1803     // loads/stores (which are essentially the same as the MemIntrinsics with
1804     // regard to copying padding between elements).  But, if an alloca is
1805     // flagged as both a source and destination of such operations, we'll need
1806     // to check later for padding between elements.
1807     if (!MemOpType || MemOpType->isIntegerTy()) {
1808       if (isStore)
1809         Info.isMemCpyDst = true;
1810       else
1811         Info.isMemCpySrc = true;
1812       return;
1813     }
1814     // This is also safe for references using a type that is compatible with
1815     // the type of the alloca, so that loads/stores can be rewritten using
1816     // insertvalue/extractvalue.
1817     if (isCompatibleAggregate(MemOpType, Info.AI->getAllocatedType())) {
1818       Info.hasSubelementAccess = true;
1819       return;
1820     }
1821   }
1822   // Check if the offset/size correspond to a component within the alloca type.
1823   Type *T = Info.AI->getAllocatedType();
1824   if (TypeHasComponent(T, Offset, MemSize)) {
1825     Info.hasSubelementAccess = true;
1826     return;
1827   }
1828
1829   return MarkUnsafe(Info, TheAccess);
1830 }
1831
1832 /// TypeHasComponent - Return true if T has a component type with the
1833 /// specified offset and size.  If Size is zero, do not check the size.
1834 bool SROA::TypeHasComponent(Type *T, uint64_t Offset, uint64_t Size) {
1835   Type *EltTy;
1836   uint64_t EltSize;
1837   if (StructType *ST = dyn_cast<StructType>(T)) {
1838     const StructLayout *Layout = DL->getStructLayout(ST);
1839     unsigned EltIdx = Layout->getElementContainingOffset(Offset);
1840     EltTy = ST->getContainedType(EltIdx);
1841     EltSize = DL->getTypeAllocSize(EltTy);
1842     Offset -= Layout->getElementOffset(EltIdx);
1843   } else if (ArrayType *AT = dyn_cast<ArrayType>(T)) {
1844     EltTy = AT->getElementType();
1845     EltSize = DL->getTypeAllocSize(EltTy);
1846     if (Offset >= AT->getNumElements() * EltSize)
1847       return false;
1848     Offset %= EltSize;
1849   } else if (VectorType *VT = dyn_cast<VectorType>(T)) {
1850     EltTy = VT->getElementType();
1851     EltSize = DL->getTypeAllocSize(EltTy);
1852     if (Offset >= VT->getNumElements() * EltSize)
1853       return false;
1854     Offset %= EltSize;
1855   } else {
1856     return false;
1857   }
1858   if (Offset == 0 && (Size == 0 || EltSize == Size))
1859     return true;
1860   // Check if the component spans multiple elements.
1861   if (Offset + Size > EltSize)
1862     return false;
1863   return TypeHasComponent(EltTy, Offset, Size);
1864 }
1865
1866 /// RewriteForScalarRepl - Alloca AI is being split into NewElts, so rewrite
1867 /// the instruction I, which references it, to use the separate elements.
1868 /// Offset indicates the position within AI that is referenced by this
1869 /// instruction.
1870 void SROA::RewriteForScalarRepl(Instruction *I, AllocaInst *AI, uint64_t Offset,
1871                                 SmallVectorImpl<AllocaInst *> &NewElts) {
1872   for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI!=E;) {
1873     Use &TheUse = UI.getUse();
1874     Instruction *User = cast<Instruction>(*UI++);
1875
1876     if (BitCastInst *BC = dyn_cast<BitCastInst>(User)) {
1877       RewriteBitCast(BC, AI, Offset, NewElts);
1878       continue;
1879     }
1880
1881     if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
1882       RewriteGEP(GEPI, AI, Offset, NewElts);
1883       continue;
1884     }
1885
1886     if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(User)) {
1887       ConstantInt *Length = dyn_cast<ConstantInt>(MI->getLength());
1888       uint64_t MemSize = Length->getZExtValue();
1889       if (Offset == 0 &&
1890           MemSize == DL->getTypeAllocSize(AI->getAllocatedType()))
1891         RewriteMemIntrinUserOfAlloca(MI, I, AI, NewElts);
1892       // Otherwise the intrinsic can only touch a single element and the
1893       // address operand will be updated, so nothing else needs to be done.
1894       continue;
1895     }
1896
1897     if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(User)) {
1898       if (II->getIntrinsicID() == Intrinsic::lifetime_start ||
1899           II->getIntrinsicID() == Intrinsic::lifetime_end) {
1900         RewriteLifetimeIntrinsic(II, AI, Offset, NewElts);
1901       }
1902       continue;
1903     }
1904
1905     if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
1906       Type *LIType = LI->getType();
1907
1908       if (isCompatibleAggregate(LIType, AI->getAllocatedType())) {
1909         // Replace:
1910         //   %res = load { i32, i32 }* %alloc
1911         // with:
1912         //   %load.0 = load i32* %alloc.0
1913         //   %insert.0 insertvalue { i32, i32 } zeroinitializer, i32 %load.0, 0
1914         //   %load.1 = load i32* %alloc.1
1915         //   %insert = insertvalue { i32, i32 } %insert.0, i32 %load.1, 1
1916         // (Also works for arrays instead of structs)
1917         Value *Insert = UndefValue::get(LIType);
1918         IRBuilder<> Builder(LI);
1919         for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
1920           Value *Load = Builder.CreateLoad(NewElts[i], "load");
1921           Insert = Builder.CreateInsertValue(Insert, Load, i, "insert");
1922         }
1923         LI->replaceAllUsesWith(Insert);
1924         DeadInsts.push_back(LI);
1925       } else if (LIType->isIntegerTy() &&
1926                  DL->getTypeAllocSize(LIType) ==
1927                  DL->getTypeAllocSize(AI->getAllocatedType())) {
1928         // If this is a load of the entire alloca to an integer, rewrite it.
1929         RewriteLoadUserOfWholeAlloca(LI, AI, NewElts);
1930       }
1931       continue;
1932     }
1933
1934     if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
1935       Value *Val = SI->getOperand(0);
1936       Type *SIType = Val->getType();
1937       if (isCompatibleAggregate(SIType, AI->getAllocatedType())) {
1938         // Replace:
1939         //   store { i32, i32 } %val, { i32, i32 }* %alloc
1940         // with:
1941         //   %val.0 = extractvalue { i32, i32 } %val, 0
1942         //   store i32 %val.0, i32* %alloc.0
1943         //   %val.1 = extractvalue { i32, i32 } %val, 1
1944         //   store i32 %val.1, i32* %alloc.1
1945         // (Also works for arrays instead of structs)
1946         IRBuilder<> Builder(SI);
1947         for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
1948           Value *Extract = Builder.CreateExtractValue(Val, i, Val->getName());
1949           Builder.CreateStore(Extract, NewElts[i]);
1950         }
1951         DeadInsts.push_back(SI);
1952       } else if (SIType->isIntegerTy() &&
1953                  DL->getTypeAllocSize(SIType) ==
1954                  DL->getTypeAllocSize(AI->getAllocatedType())) {
1955         // If this is a store of the entire alloca from an integer, rewrite it.
1956         RewriteStoreUserOfWholeAlloca(SI, AI, NewElts);
1957       }
1958       continue;
1959     }
1960
1961     if (isa<SelectInst>(User) || isa<PHINode>(User)) {
1962       // If we have a PHI user of the alloca itself (as opposed to a GEP or
1963       // bitcast) we have to rewrite it.  GEP and bitcast uses will be RAUW'd to
1964       // the new pointer.
1965       if (!isa<AllocaInst>(I)) continue;
1966
1967       assert(Offset == 0 && NewElts[0] &&
1968              "Direct alloca use should have a zero offset");
1969
1970       // If we have a use of the alloca, we know the derived uses will be
1971       // utilizing just the first element of the scalarized result.  Insert a
1972       // bitcast of the first alloca before the user as required.
1973       AllocaInst *NewAI = NewElts[0];
1974       BitCastInst *BCI = new BitCastInst(NewAI, AI->getType(), "", NewAI);
1975       NewAI->moveBefore(BCI);
1976       TheUse = BCI;
1977       continue;
1978     }
1979   }
1980 }
1981
1982 /// RewriteBitCast - Update a bitcast reference to the alloca being replaced
1983 /// and recursively continue updating all of its uses.
1984 void SROA::RewriteBitCast(BitCastInst *BC, AllocaInst *AI, uint64_t Offset,
1985                           SmallVectorImpl<AllocaInst *> &NewElts) {
1986   RewriteForScalarRepl(BC, AI, Offset, NewElts);
1987   if (BC->getOperand(0) != AI)
1988     return;
1989
1990   // The bitcast references the original alloca.  Replace its uses with
1991   // references to the alloca containing offset zero (which is normally at
1992   // index zero, but might not be in cases involving structs with elements
1993   // of size zero).
1994   Type *T = AI->getAllocatedType();
1995   uint64_t EltOffset = 0;
1996   Type *IdxTy;
1997   uint64_t Idx = FindElementAndOffset(T, EltOffset, IdxTy);
1998   Instruction *Val = NewElts[Idx];
1999   if (Val->getType() != BC->getDestTy()) {
2000     Val = new BitCastInst(Val, BC->getDestTy(), "", BC);
2001     Val->takeName(BC);
2002   }
2003   BC->replaceAllUsesWith(Val);
2004   DeadInsts.push_back(BC);
2005 }
2006
2007 /// FindElementAndOffset - Return the index of the element containing Offset
2008 /// within the specified type, which must be either a struct or an array.
2009 /// Sets T to the type of the element and Offset to the offset within that
2010 /// element.  IdxTy is set to the type of the index result to be used in a
2011 /// GEP instruction.
2012 uint64_t SROA::FindElementAndOffset(Type *&T, uint64_t &Offset,
2013                                     Type *&IdxTy) {
2014   uint64_t Idx = 0;
2015   if (StructType *ST = dyn_cast<StructType>(T)) {
2016     const StructLayout *Layout = DL->getStructLayout(ST);
2017     Idx = Layout->getElementContainingOffset(Offset);
2018     T = ST->getContainedType(Idx);
2019     Offset -= Layout->getElementOffset(Idx);
2020     IdxTy = Type::getInt32Ty(T->getContext());
2021     return Idx;
2022   } else if (ArrayType *AT = dyn_cast<ArrayType>(T)) {
2023     T = AT->getElementType();
2024     uint64_t EltSize = DL->getTypeAllocSize(T);
2025     Idx = Offset / EltSize;
2026     Offset -= Idx * EltSize;
2027     IdxTy = Type::getInt64Ty(T->getContext());
2028     return Idx;
2029   }
2030   VectorType *VT = cast<VectorType>(T);
2031   T = VT->getElementType();
2032   uint64_t EltSize = DL->getTypeAllocSize(T);
2033   Idx = Offset / EltSize;
2034   Offset -= Idx * EltSize;
2035   IdxTy = Type::getInt64Ty(T->getContext());
2036   return Idx;
2037 }
2038
2039 /// RewriteGEP - Check if this GEP instruction moves the pointer across
2040 /// elements of the alloca that are being split apart, and if so, rewrite
2041 /// the GEP to be relative to the new element.
2042 void SROA::RewriteGEP(GetElementPtrInst *GEPI, AllocaInst *AI, uint64_t Offset,
2043                       SmallVectorImpl<AllocaInst *> &NewElts) {
2044   uint64_t OldOffset = Offset;
2045   SmallVector<Value*, 8> Indices(GEPI->op_begin() + 1, GEPI->op_end());
2046   // If the GEP was dynamic then it must have been a dynamic vector lookup.
2047   // In this case, it must be the last GEP operand which is dynamic so keep that
2048   // aside until we've found the constant GEP offset then add it back in at the
2049   // end.
2050   Value* NonConstantIdx = 0;
2051   if (!GEPI->hasAllConstantIndices())
2052     NonConstantIdx = Indices.pop_back_val();
2053   Offset += DL->getIndexedOffset(GEPI->getPointerOperandType(), Indices);
2054
2055   RewriteForScalarRepl(GEPI, AI, Offset, NewElts);
2056
2057   Type *T = AI->getAllocatedType();
2058   Type *IdxTy;
2059   uint64_t OldIdx = FindElementAndOffset(T, OldOffset, IdxTy);
2060   if (GEPI->getOperand(0) == AI)
2061     OldIdx = ~0ULL; // Force the GEP to be rewritten.
2062
2063   T = AI->getAllocatedType();
2064   uint64_t EltOffset = Offset;
2065   uint64_t Idx = FindElementAndOffset(T, EltOffset, IdxTy);
2066
2067   // If this GEP does not move the pointer across elements of the alloca
2068   // being split, then it does not needs to be rewritten.
2069   if (Idx == OldIdx)
2070     return;
2071
2072   Type *i32Ty = Type::getInt32Ty(AI->getContext());
2073   SmallVector<Value*, 8> NewArgs;
2074   NewArgs.push_back(Constant::getNullValue(i32Ty));
2075   while (EltOffset != 0) {
2076     uint64_t EltIdx = FindElementAndOffset(T, EltOffset, IdxTy);
2077     NewArgs.push_back(ConstantInt::get(IdxTy, EltIdx));
2078   }
2079   if (NonConstantIdx) {
2080     Type* GepTy = T;
2081     // This GEP has a dynamic index.  We need to add "i32 0" to index through
2082     // any structs or arrays in the original type until we get to the vector
2083     // to index.
2084     while (!isa<VectorType>(GepTy)) {
2085       NewArgs.push_back(Constant::getNullValue(i32Ty));
2086       GepTy = cast<CompositeType>(GepTy)->getTypeAtIndex(0U);
2087     }
2088     NewArgs.push_back(NonConstantIdx);
2089   }
2090   Instruction *Val = NewElts[Idx];
2091   if (NewArgs.size() > 1) {
2092     Val = GetElementPtrInst::CreateInBounds(Val, NewArgs, "", GEPI);
2093     Val->takeName(GEPI);
2094   }
2095   if (Val->getType() != GEPI->getType())
2096     Val = new BitCastInst(Val, GEPI->getType(), Val->getName(), GEPI);
2097   GEPI->replaceAllUsesWith(Val);
2098   DeadInsts.push_back(GEPI);
2099 }
2100
2101 /// RewriteLifetimeIntrinsic - II is a lifetime.start/lifetime.end. Rewrite it
2102 /// to mark the lifetime of the scalarized memory.
2103 void SROA::RewriteLifetimeIntrinsic(IntrinsicInst *II, AllocaInst *AI,
2104                                     uint64_t Offset,
2105                                     SmallVectorImpl<AllocaInst *> &NewElts) {
2106   ConstantInt *OldSize = cast<ConstantInt>(II->getArgOperand(0));
2107   // Put matching lifetime markers on everything from Offset up to
2108   // Offset+OldSize.
2109   Type *AIType = AI->getAllocatedType();
2110   uint64_t NewOffset = Offset;
2111   Type *IdxTy;
2112   uint64_t Idx = FindElementAndOffset(AIType, NewOffset, IdxTy);
2113
2114   IRBuilder<> Builder(II);
2115   uint64_t Size = OldSize->getLimitedValue();
2116
2117   if (NewOffset) {
2118     // Splice the first element and index 'NewOffset' bytes in.  SROA will
2119     // split the alloca again later.
2120     Value *V = Builder.CreateBitCast(NewElts[Idx], Builder.getInt8PtrTy());
2121     V = Builder.CreateGEP(V, Builder.getInt64(NewOffset));
2122
2123     IdxTy = NewElts[Idx]->getAllocatedType();
2124     uint64_t EltSize = DL->getTypeAllocSize(IdxTy) - NewOffset;
2125     if (EltSize > Size) {
2126       EltSize = Size;
2127       Size = 0;
2128     } else {
2129       Size -= EltSize;
2130     }
2131     if (II->getIntrinsicID() == Intrinsic::lifetime_start)
2132       Builder.CreateLifetimeStart(V, Builder.getInt64(EltSize));
2133     else
2134       Builder.CreateLifetimeEnd(V, Builder.getInt64(EltSize));
2135     ++Idx;
2136   }
2137
2138   for (; Idx != NewElts.size() && Size; ++Idx) {
2139     IdxTy = NewElts[Idx]->getAllocatedType();
2140     uint64_t EltSize = DL->getTypeAllocSize(IdxTy);
2141     if (EltSize > Size) {
2142       EltSize = Size;
2143       Size = 0;
2144     } else {
2145       Size -= EltSize;
2146     }
2147     if (II->getIntrinsicID() == Intrinsic::lifetime_start)
2148       Builder.CreateLifetimeStart(NewElts[Idx],
2149                                   Builder.getInt64(EltSize));
2150     else
2151       Builder.CreateLifetimeEnd(NewElts[Idx],
2152                                 Builder.getInt64(EltSize));
2153   }
2154   DeadInsts.push_back(II);
2155 }
2156
2157 /// RewriteMemIntrinUserOfAlloca - MI is a memcpy/memset/memmove from or to AI.
2158 /// Rewrite it to copy or set the elements of the scalarized memory.
2159 void
2160 SROA::RewriteMemIntrinUserOfAlloca(MemIntrinsic *MI, Instruction *Inst,
2161                                    AllocaInst *AI,
2162                                    SmallVectorImpl<AllocaInst *> &NewElts) {
2163   // If this is a memcpy/memmove, construct the other pointer as the
2164   // appropriate type.  The "Other" pointer is the pointer that goes to memory
2165   // that doesn't have anything to do with the alloca that we are promoting. For
2166   // memset, this Value* stays null.
2167   Value *OtherPtr = 0;
2168   unsigned MemAlignment = MI->getAlignment();
2169   if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(MI)) { // memmove/memcopy
2170     if (Inst == MTI->getRawDest())
2171       OtherPtr = MTI->getRawSource();
2172     else {
2173       assert(Inst == MTI->getRawSource());
2174       OtherPtr = MTI->getRawDest();
2175     }
2176   }
2177
2178   // If there is an other pointer, we want to convert it to the same pointer
2179   // type as AI has, so we can GEP through it safely.
2180   if (OtherPtr) {
2181     unsigned AddrSpace =
2182       cast<PointerType>(OtherPtr->getType())->getAddressSpace();
2183
2184     // Remove bitcasts and all-zero GEPs from OtherPtr.  This is an
2185     // optimization, but it's also required to detect the corner case where
2186     // both pointer operands are referencing the same memory, and where
2187     // OtherPtr may be a bitcast or GEP that currently being rewritten.  (This
2188     // function is only called for mem intrinsics that access the whole
2189     // aggregate, so non-zero GEPs are not an issue here.)
2190     OtherPtr = OtherPtr->stripPointerCasts();
2191
2192     // Copying the alloca to itself is a no-op: just delete it.
2193     if (OtherPtr == AI || OtherPtr == NewElts[0]) {
2194       // This code will run twice for a no-op memcpy -- once for each operand.
2195       // Put only one reference to MI on the DeadInsts list.
2196       for (SmallVectorImpl<Value *>::const_iterator I = DeadInsts.begin(),
2197              E = DeadInsts.end(); I != E; ++I)
2198         if (*I == MI) return;
2199       DeadInsts.push_back(MI);
2200       return;
2201     }
2202
2203     // If the pointer is not the right type, insert a bitcast to the right
2204     // type.
2205     Type *NewTy =
2206       PointerType::get(AI->getType()->getElementType(), AddrSpace);
2207
2208     if (OtherPtr->getType() != NewTy)
2209       OtherPtr = new BitCastInst(OtherPtr, NewTy, OtherPtr->getName(), MI);
2210   }
2211
2212   // Process each element of the aggregate.
2213   bool SROADest = MI->getRawDest() == Inst;
2214
2215   Constant *Zero = Constant::getNullValue(Type::getInt32Ty(MI->getContext()));
2216
2217   for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
2218     // If this is a memcpy/memmove, emit a GEP of the other element address.
2219     Value *OtherElt = 0;
2220     unsigned OtherEltAlign = MemAlignment;
2221
2222     if (OtherPtr) {
2223       Value *Idx[2] = { Zero,
2224                       ConstantInt::get(Type::getInt32Ty(MI->getContext()), i) };
2225       OtherElt = GetElementPtrInst::CreateInBounds(OtherPtr, Idx,
2226                                               OtherPtr->getName()+"."+Twine(i),
2227                                                    MI);
2228       uint64_t EltOffset;
2229       PointerType *OtherPtrTy = cast<PointerType>(OtherPtr->getType());
2230       Type *OtherTy = OtherPtrTy->getElementType();
2231       if (StructType *ST = dyn_cast<StructType>(OtherTy)) {
2232         EltOffset = DL->getStructLayout(ST)->getElementOffset(i);
2233       } else {
2234         Type *EltTy = cast<SequentialType>(OtherTy)->getElementType();
2235         EltOffset = DL->getTypeAllocSize(EltTy)*i;
2236       }
2237
2238       // The alignment of the other pointer is the guaranteed alignment of the
2239       // element, which is affected by both the known alignment of the whole
2240       // mem intrinsic and the alignment of the element.  If the alignment of
2241       // the memcpy (f.e.) is 32 but the element is at a 4-byte offset, then the
2242       // known alignment is just 4 bytes.
2243       OtherEltAlign = (unsigned)MinAlign(OtherEltAlign, EltOffset);
2244     }
2245
2246     Value *EltPtr = NewElts[i];
2247     Type *EltTy = cast<PointerType>(EltPtr->getType())->getElementType();
2248
2249     // If we got down to a scalar, insert a load or store as appropriate.
2250     if (EltTy->isSingleValueType()) {
2251       if (isa<MemTransferInst>(MI)) {
2252         if (SROADest) {
2253           // From Other to Alloca.
2254           Value *Elt = new LoadInst(OtherElt, "tmp", false, OtherEltAlign, MI);
2255           new StoreInst(Elt, EltPtr, MI);
2256         } else {
2257           // From Alloca to Other.
2258           Value *Elt = new LoadInst(EltPtr, "tmp", MI);
2259           new StoreInst(Elt, OtherElt, false, OtherEltAlign, MI);
2260         }
2261         continue;
2262       }
2263       assert(isa<MemSetInst>(MI));
2264
2265       // If the stored element is zero (common case), just store a null
2266       // constant.
2267       Constant *StoreVal;
2268       if (ConstantInt *CI = dyn_cast<ConstantInt>(MI->getArgOperand(1))) {
2269         if (CI->isZero()) {
2270           StoreVal = Constant::getNullValue(EltTy);  // 0.0, null, 0, <0,0>
2271         } else {
2272           // If EltTy is a vector type, get the element type.
2273           Type *ValTy = EltTy->getScalarType();
2274
2275           // Construct an integer with the right value.
2276           unsigned EltSize = DL->getTypeSizeInBits(ValTy);
2277           APInt OneVal(EltSize, CI->getZExtValue());
2278           APInt TotalVal(OneVal);
2279           // Set each byte.
2280           for (unsigned i = 0; 8*i < EltSize; ++i) {
2281             TotalVal = TotalVal.shl(8);
2282             TotalVal |= OneVal;
2283           }
2284
2285           // Convert the integer value to the appropriate type.
2286           StoreVal = ConstantInt::get(CI->getContext(), TotalVal);
2287           if (ValTy->isPointerTy())
2288             StoreVal = ConstantExpr::getIntToPtr(StoreVal, ValTy);
2289           else if (ValTy->isFloatingPointTy())
2290             StoreVal = ConstantExpr::getBitCast(StoreVal, ValTy);
2291           assert(StoreVal->getType() == ValTy && "Type mismatch!");
2292
2293           // If the requested value was a vector constant, create it.
2294           if (EltTy->isVectorTy()) {
2295             unsigned NumElts = cast<VectorType>(EltTy)->getNumElements();
2296             StoreVal = ConstantVector::getSplat(NumElts, StoreVal);
2297           }
2298         }
2299         new StoreInst(StoreVal, EltPtr, MI);
2300         continue;
2301       }
2302       // Otherwise, if we're storing a byte variable, use a memset call for
2303       // this element.
2304     }
2305
2306     unsigned EltSize = DL->getTypeAllocSize(EltTy);
2307     if (!EltSize)
2308       continue;
2309
2310     IRBuilder<> Builder(MI);
2311
2312     // Finally, insert the meminst for this element.
2313     if (isa<MemSetInst>(MI)) {
2314       Builder.CreateMemSet(EltPtr, MI->getArgOperand(1), EltSize,
2315                            MI->isVolatile());
2316     } else {
2317       assert(isa<MemTransferInst>(MI));
2318       Value *Dst = SROADest ? EltPtr : OtherElt;  // Dest ptr
2319       Value *Src = SROADest ? OtherElt : EltPtr;  // Src ptr
2320
2321       if (isa<MemCpyInst>(MI))
2322         Builder.CreateMemCpy(Dst, Src, EltSize, OtherEltAlign,MI->isVolatile());
2323       else
2324         Builder.CreateMemMove(Dst, Src, EltSize,OtherEltAlign,MI->isVolatile());
2325     }
2326   }
2327   DeadInsts.push_back(MI);
2328 }
2329
2330 /// RewriteStoreUserOfWholeAlloca - We found a store of an integer that
2331 /// overwrites the entire allocation.  Extract out the pieces of the stored
2332 /// integer and store them individually.
2333 void
2334 SROA::RewriteStoreUserOfWholeAlloca(StoreInst *SI, AllocaInst *AI,
2335                                     SmallVectorImpl<AllocaInst *> &NewElts) {
2336   // Extract each element out of the integer according to its structure offset
2337   // and store the element value to the individual alloca.
2338   Value *SrcVal = SI->getOperand(0);
2339   Type *AllocaEltTy = AI->getAllocatedType();
2340   uint64_t AllocaSizeBits = DL->getTypeAllocSizeInBits(AllocaEltTy);
2341
2342   IRBuilder<> Builder(SI);
2343
2344   // Handle tail padding by extending the operand
2345   if (DL->getTypeSizeInBits(SrcVal->getType()) != AllocaSizeBits)
2346     SrcVal = Builder.CreateZExt(SrcVal,
2347                             IntegerType::get(SI->getContext(), AllocaSizeBits));
2348
2349   DEBUG(dbgs() << "PROMOTING STORE TO WHOLE ALLOCA: " << *AI << '\n' << *SI
2350                << '\n');
2351
2352   // There are two forms here: AI could be an array or struct.  Both cases
2353   // have different ways to compute the element offset.
2354   if (StructType *EltSTy = dyn_cast<StructType>(AllocaEltTy)) {
2355     const StructLayout *Layout = DL->getStructLayout(EltSTy);
2356
2357     for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
2358       // Get the number of bits to shift SrcVal to get the value.
2359       Type *FieldTy = EltSTy->getElementType(i);
2360       uint64_t Shift = Layout->getElementOffsetInBits(i);
2361
2362       if (DL->isBigEndian())
2363         Shift = AllocaSizeBits-Shift-DL->getTypeAllocSizeInBits(FieldTy);
2364
2365       Value *EltVal = SrcVal;
2366       if (Shift) {
2367         Value *ShiftVal = ConstantInt::get(EltVal->getType(), Shift);
2368         EltVal = Builder.CreateLShr(EltVal, ShiftVal, "sroa.store.elt");
2369       }
2370
2371       // Truncate down to an integer of the right size.
2372       uint64_t FieldSizeBits = DL->getTypeSizeInBits(FieldTy);
2373
2374       // Ignore zero sized fields like {}, they obviously contain no data.
2375       if (FieldSizeBits == 0) continue;
2376
2377       if (FieldSizeBits != AllocaSizeBits)
2378         EltVal = Builder.CreateTrunc(EltVal,
2379                              IntegerType::get(SI->getContext(), FieldSizeBits));
2380       Value *DestField = NewElts[i];
2381       if (EltVal->getType() == FieldTy) {
2382         // Storing to an integer field of this size, just do it.
2383       } else if (FieldTy->isFloatingPointTy() || FieldTy->isVectorTy()) {
2384         // Bitcast to the right element type (for fp/vector values).
2385         EltVal = Builder.CreateBitCast(EltVal, FieldTy);
2386       } else {
2387         // Otherwise, bitcast the dest pointer (for aggregates).
2388         DestField = Builder.CreateBitCast(DestField,
2389                                      PointerType::getUnqual(EltVal->getType()));
2390       }
2391       new StoreInst(EltVal, DestField, SI);
2392     }
2393
2394   } else {
2395     ArrayType *ATy = cast<ArrayType>(AllocaEltTy);
2396     Type *ArrayEltTy = ATy->getElementType();
2397     uint64_t ElementOffset = DL->getTypeAllocSizeInBits(ArrayEltTy);
2398     uint64_t ElementSizeBits = DL->getTypeSizeInBits(ArrayEltTy);
2399
2400     uint64_t Shift;
2401
2402     if (DL->isBigEndian())
2403       Shift = AllocaSizeBits-ElementOffset;
2404     else
2405       Shift = 0;
2406
2407     for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
2408       // Ignore zero sized fields like {}, they obviously contain no data.
2409       if (ElementSizeBits == 0) continue;
2410
2411       Value *EltVal = SrcVal;
2412       if (Shift) {
2413         Value *ShiftVal = ConstantInt::get(EltVal->getType(), Shift);
2414         EltVal = Builder.CreateLShr(EltVal, ShiftVal, "sroa.store.elt");
2415       }
2416
2417       // Truncate down to an integer of the right size.
2418       if (ElementSizeBits != AllocaSizeBits)
2419         EltVal = Builder.CreateTrunc(EltVal,
2420                                      IntegerType::get(SI->getContext(),
2421                                                       ElementSizeBits));
2422       Value *DestField = NewElts[i];
2423       if (EltVal->getType() == ArrayEltTy) {
2424         // Storing to an integer field of this size, just do it.
2425       } else if (ArrayEltTy->isFloatingPointTy() ||
2426                  ArrayEltTy->isVectorTy()) {
2427         // Bitcast to the right element type (for fp/vector values).
2428         EltVal = Builder.CreateBitCast(EltVal, ArrayEltTy);
2429       } else {
2430         // Otherwise, bitcast the dest pointer (for aggregates).
2431         DestField = Builder.CreateBitCast(DestField,
2432                                      PointerType::getUnqual(EltVal->getType()));
2433       }
2434       new StoreInst(EltVal, DestField, SI);
2435
2436       if (DL->isBigEndian())
2437         Shift -= ElementOffset;
2438       else
2439         Shift += ElementOffset;
2440     }
2441   }
2442
2443   DeadInsts.push_back(SI);
2444 }
2445
2446 /// RewriteLoadUserOfWholeAlloca - We found a load of the entire allocation to
2447 /// an integer.  Load the individual pieces to form the aggregate value.
2448 void
2449 SROA::RewriteLoadUserOfWholeAlloca(LoadInst *LI, AllocaInst *AI,
2450                                    SmallVectorImpl<AllocaInst *> &NewElts) {
2451   // Extract each element out of the NewElts according to its structure offset
2452   // and form the result value.
2453   Type *AllocaEltTy = AI->getAllocatedType();
2454   uint64_t AllocaSizeBits = DL->getTypeAllocSizeInBits(AllocaEltTy);
2455
2456   DEBUG(dbgs() << "PROMOTING LOAD OF WHOLE ALLOCA: " << *AI << '\n' << *LI
2457                << '\n');
2458
2459   // There are two forms here: AI could be an array or struct.  Both cases
2460   // have different ways to compute the element offset.
2461   const StructLayout *Layout = 0;
2462   uint64_t ArrayEltBitOffset = 0;
2463   if (StructType *EltSTy = dyn_cast<StructType>(AllocaEltTy)) {
2464     Layout = DL->getStructLayout(EltSTy);
2465   } else {
2466     Type *ArrayEltTy = cast<ArrayType>(AllocaEltTy)->getElementType();
2467     ArrayEltBitOffset = DL->getTypeAllocSizeInBits(ArrayEltTy);
2468   }
2469
2470   Value *ResultVal =
2471     Constant::getNullValue(IntegerType::get(LI->getContext(), AllocaSizeBits));
2472
2473   for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
2474     // Load the value from the alloca.  If the NewElt is an aggregate, cast
2475     // the pointer to an integer of the same size before doing the load.
2476     Value *SrcField = NewElts[i];
2477     Type *FieldTy =
2478       cast<PointerType>(SrcField->getType())->getElementType();
2479     uint64_t FieldSizeBits = DL->getTypeSizeInBits(FieldTy);
2480
2481     // Ignore zero sized fields like {}, they obviously contain no data.
2482     if (FieldSizeBits == 0) continue;
2483
2484     IntegerType *FieldIntTy = IntegerType::get(LI->getContext(),
2485                                                      FieldSizeBits);
2486     if (!FieldTy->isIntegerTy() && !FieldTy->isFloatingPointTy() &&
2487         !FieldTy->isVectorTy())
2488       SrcField = new BitCastInst(SrcField,
2489                                  PointerType::getUnqual(FieldIntTy),
2490                                  "", LI);
2491     SrcField = new LoadInst(SrcField, "sroa.load.elt", LI);
2492
2493     // If SrcField is a fp or vector of the right size but that isn't an
2494     // integer type, bitcast to an integer so we can shift it.
2495     if (SrcField->getType() != FieldIntTy)
2496       SrcField = new BitCastInst(SrcField, FieldIntTy, "", LI);
2497
2498     // Zero extend the field to be the same size as the final alloca so that
2499     // we can shift and insert it.
2500     if (SrcField->getType() != ResultVal->getType())
2501       SrcField = new ZExtInst(SrcField, ResultVal->getType(), "", LI);
2502
2503     // Determine the number of bits to shift SrcField.
2504     uint64_t Shift;
2505     if (Layout) // Struct case.
2506       Shift = Layout->getElementOffsetInBits(i);
2507     else  // Array case.
2508       Shift = i*ArrayEltBitOffset;
2509
2510     if (DL->isBigEndian())
2511       Shift = AllocaSizeBits-Shift-FieldIntTy->getBitWidth();
2512
2513     if (Shift) {
2514       Value *ShiftVal = ConstantInt::get(SrcField->getType(), Shift);
2515       SrcField = BinaryOperator::CreateShl(SrcField, ShiftVal, "", LI);
2516     }
2517
2518     // Don't create an 'or x, 0' on the first iteration.
2519     if (!isa<Constant>(ResultVal) ||
2520         !cast<Constant>(ResultVal)->isNullValue())
2521       ResultVal = BinaryOperator::CreateOr(SrcField, ResultVal, "", LI);
2522     else
2523       ResultVal = SrcField;
2524   }
2525
2526   // Handle tail padding by truncating the result
2527   if (DL->getTypeSizeInBits(LI->getType()) != AllocaSizeBits)
2528     ResultVal = new TruncInst(ResultVal, LI->getType(), "", LI);
2529
2530   LI->replaceAllUsesWith(ResultVal);
2531   DeadInsts.push_back(LI);
2532 }
2533
2534 /// HasPadding - Return true if the specified type has any structure or
2535 /// alignment padding in between the elements that would be split apart
2536 /// by SROA; return false otherwise.
2537 static bool HasPadding(Type *Ty, const DataLayout &DL) {
2538   if (ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
2539     Ty = ATy->getElementType();
2540     return DL.getTypeSizeInBits(Ty) != DL.getTypeAllocSizeInBits(Ty);
2541   }
2542
2543   // SROA currently handles only Arrays and Structs.
2544   StructType *STy = cast<StructType>(Ty);
2545   const StructLayout *SL = DL.getStructLayout(STy);
2546   unsigned PrevFieldBitOffset = 0;
2547   for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2548     unsigned FieldBitOffset = SL->getElementOffsetInBits(i);
2549
2550     // Check to see if there is any padding between this element and the
2551     // previous one.
2552     if (i) {
2553       unsigned PrevFieldEnd =
2554         PrevFieldBitOffset+DL.getTypeSizeInBits(STy->getElementType(i-1));
2555       if (PrevFieldEnd < FieldBitOffset)
2556         return true;
2557     }
2558     PrevFieldBitOffset = FieldBitOffset;
2559   }
2560   // Check for tail padding.
2561   if (unsigned EltCount = STy->getNumElements()) {
2562     unsigned PrevFieldEnd = PrevFieldBitOffset +
2563       DL.getTypeSizeInBits(STy->getElementType(EltCount-1));
2564     if (PrevFieldEnd < SL->getSizeInBits())
2565       return true;
2566   }
2567   return false;
2568 }
2569
2570 /// isSafeStructAllocaToScalarRepl - Check to see if the specified allocation of
2571 /// an aggregate can be broken down into elements.  Return 0 if not, 3 if safe,
2572 /// or 1 if safe after canonicalization has been performed.
2573 bool SROA::isSafeAllocaToScalarRepl(AllocaInst *AI) {
2574   // Loop over the use list of the alloca.  We can only transform it if all of
2575   // the users are safe to transform.
2576   AllocaInfo Info(AI);
2577
2578   isSafeForScalarRepl(AI, 0, Info);
2579   if (Info.isUnsafe) {
2580     DEBUG(dbgs() << "Cannot transform: " << *AI << '\n');
2581     return false;
2582   }
2583
2584   // Okay, we know all the users are promotable.  If the aggregate is a memcpy
2585   // source and destination, we have to be careful.  In particular, the memcpy
2586   // could be moving around elements that live in structure padding of the LLVM
2587   // types, but may actually be used.  In these cases, we refuse to promote the
2588   // struct.
2589   if (Info.isMemCpySrc && Info.isMemCpyDst &&
2590       HasPadding(AI->getAllocatedType(), *DL))
2591     return false;
2592
2593   // If the alloca never has an access to just *part* of it, but is accessed
2594   // via loads and stores, then we should use ConvertToScalarInfo to promote
2595   // the alloca instead of promoting each piece at a time and inserting fission
2596   // and fusion code.
2597   if (!Info.hasSubelementAccess && Info.hasALoadOrStore) {
2598     // If the struct/array just has one element, use basic SRoA.
2599     if (StructType *ST = dyn_cast<StructType>(AI->getAllocatedType())) {
2600       if (ST->getNumElements() > 1) return false;
2601     } else {
2602       if (cast<ArrayType>(AI->getAllocatedType())->getNumElements() > 1)
2603         return false;
2604     }
2605   }
2606
2607   return true;
2608 }