Trivial cleanup: reuse existing variable.
[oota-llvm.git] / lib / Transforms / Scalar / SROA.cpp
1 //===- SROA.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 /// \file
10 /// This transformation implements the well known scalar replacement of
11 /// aggregates transformation. It tries to identify promotable elements of an
12 /// aggregate alloca, and promote them to registers. It will also try to
13 /// convert uses of an element (or set of elements) of an alloca into a vector
14 /// or bitfield-style integer scalar if appropriate.
15 ///
16 /// It works to do this with minimal slicing of the alloca so that regions
17 /// which are merely transferred in and out of external memory remain unchanged
18 /// and are not decomposed to scalar code.
19 ///
20 /// Because this also performs alloca promotion, it can be thought of as also
21 /// serving the purpose of SSA formation. The algorithm iterates on the
22 /// function until all opportunities for promotion have been realized.
23 ///
24 //===----------------------------------------------------------------------===//
25
26 #define DEBUG_TYPE "sroa"
27 #include "llvm/Transforms/Scalar.h"
28 #include "llvm/ADT/STLExtras.h"
29 #include "llvm/ADT/SetVector.h"
30 #include "llvm/ADT/SmallVector.h"
31 #include "llvm/ADT/Statistic.h"
32 #include "llvm/Analysis/Loads.h"
33 #include "llvm/Analysis/PtrUseVisitor.h"
34 #include "llvm/Analysis/ValueTracking.h"
35 #include "llvm/DIBuilder.h"
36 #include "llvm/DebugInfo.h"
37 #include "llvm/IR/Constants.h"
38 #include "llvm/IR/DataLayout.h"
39 #include "llvm/IR/DerivedTypes.h"
40 #include "llvm/IR/Dominators.h"
41 #include "llvm/IR/Function.h"
42 #include "llvm/IR/IRBuilder.h"
43 #include "llvm/IR/Instructions.h"
44 #include "llvm/IR/IntrinsicInst.h"
45 #include "llvm/IR/LLVMContext.h"
46 #include "llvm/IR/Operator.h"
47 #include "llvm/InstVisitor.h"
48 #include "llvm/Pass.h"
49 #include "llvm/Support/CommandLine.h"
50 #include "llvm/Support/Compiler.h"
51 #include "llvm/Support/Debug.h"
52 #include "llvm/Support/ErrorHandling.h"
53 #include "llvm/Support/MathExtras.h"
54 #include "llvm/Support/raw_ostream.h"
55 #include "llvm/Transforms/Utils/Local.h"
56 #include "llvm/Transforms/Utils/PromoteMemToReg.h"
57 #include "llvm/Transforms/Utils/SSAUpdater.h"
58 using namespace llvm;
59
60 STATISTIC(NumAllocasAnalyzed, "Number of allocas analyzed for replacement");
61 STATISTIC(NumAllocaPartitions, "Number of alloca partitions formed");
62 STATISTIC(MaxPartitionsPerAlloca, "Maximum number of partitions per alloca");
63 STATISTIC(NumAllocaPartitionUses, "Number of alloca partition uses rewritten");
64 STATISTIC(MaxUsesPerAllocaPartition, "Maximum number of uses of a partition");
65 STATISTIC(NumNewAllocas, "Number of new, smaller allocas introduced");
66 STATISTIC(NumPromoted, "Number of allocas promoted to SSA values");
67 STATISTIC(NumLoadsSpeculated, "Number of loads speculated to allow promotion");
68 STATISTIC(NumDeleted, "Number of instructions deleted");
69 STATISTIC(NumVectorized, "Number of vectorized aggregates");
70
71 /// Hidden option to force the pass to not use DomTree and mem2reg, instead
72 /// forming SSA values through the SSAUpdater infrastructure.
73 static cl::opt<bool>
74 ForceSSAUpdater("force-ssa-updater", cl::init(false), cl::Hidden);
75
76 namespace {
77 /// \brief A custom IRBuilder inserter which prefixes all names if they are
78 /// preserved.
79 template <bool preserveNames = true>
80 class IRBuilderPrefixedInserter :
81     public IRBuilderDefaultInserter<preserveNames> {
82   std::string Prefix;
83
84 public:
85   void SetNamePrefix(const Twine &P) { Prefix = P.str(); }
86
87 protected:
88   void InsertHelper(Instruction *I, const Twine &Name, BasicBlock *BB,
89                     BasicBlock::iterator InsertPt) const {
90     IRBuilderDefaultInserter<preserveNames>::InsertHelper(
91         I, Name.isTriviallyEmpty() ? Name : Prefix + Name, BB, InsertPt);
92   }
93 };
94
95 // Specialization for not preserving the name is trivial.
96 template <>
97 class IRBuilderPrefixedInserter<false> :
98     public IRBuilderDefaultInserter<false> {
99 public:
100   void SetNamePrefix(const Twine &P) {}
101 };
102
103 /// \brief Provide a typedef for IRBuilder that drops names in release builds.
104 #ifndef NDEBUG
105 typedef llvm::IRBuilder<true, ConstantFolder,
106                         IRBuilderPrefixedInserter<true> > IRBuilderTy;
107 #else
108 typedef llvm::IRBuilder<false, ConstantFolder,
109                         IRBuilderPrefixedInserter<false> > IRBuilderTy;
110 #endif
111 }
112
113 namespace {
114 /// \brief A used slice of an alloca.
115 ///
116 /// This structure represents a slice of an alloca used by some instruction. It
117 /// stores both the begin and end offsets of this use, a pointer to the use
118 /// itself, and a flag indicating whether we can classify the use as splittable
119 /// or not when forming partitions of the alloca.
120 class Slice {
121   /// \brief The beginning offset of the range.
122   uint64_t BeginOffset;
123
124   /// \brief The ending offset, not included in the range.
125   uint64_t EndOffset;
126
127   /// \brief Storage for both the use of this slice and whether it can be
128   /// split.
129   PointerIntPair<Use *, 1, bool> UseAndIsSplittable;
130
131 public:
132   Slice() : BeginOffset(), EndOffset() {}
133   Slice(uint64_t BeginOffset, uint64_t EndOffset, Use *U, bool IsSplittable)
134       : BeginOffset(BeginOffset), EndOffset(EndOffset),
135         UseAndIsSplittable(U, IsSplittable) {}
136
137   uint64_t beginOffset() const { return BeginOffset; }
138   uint64_t endOffset() const { return EndOffset; }
139
140   bool isSplittable() const { return UseAndIsSplittable.getInt(); }
141   void makeUnsplittable() { UseAndIsSplittable.setInt(false); }
142
143   Use *getUse() const { return UseAndIsSplittable.getPointer(); }
144
145   bool isDead() const { return getUse() == 0; }
146   void kill() { UseAndIsSplittable.setPointer(0); }
147
148   /// \brief Support for ordering ranges.
149   ///
150   /// This provides an ordering over ranges such that start offsets are
151   /// always increasing, and within equal start offsets, the end offsets are
152   /// decreasing. Thus the spanning range comes first in a cluster with the
153   /// same start position.
154   bool operator<(const Slice &RHS) const {
155     if (beginOffset() < RHS.beginOffset()) return true;
156     if (beginOffset() > RHS.beginOffset()) return false;
157     if (isSplittable() != RHS.isSplittable()) return !isSplittable();
158     if (endOffset() > RHS.endOffset()) return true;
159     return false;
160   }
161
162   /// \brief Support comparison with a single offset to allow binary searches.
163   friend LLVM_ATTRIBUTE_UNUSED bool operator<(const Slice &LHS,
164                                               uint64_t RHSOffset) {
165     return LHS.beginOffset() < RHSOffset;
166   }
167   friend LLVM_ATTRIBUTE_UNUSED bool operator<(uint64_t LHSOffset,
168                                               const Slice &RHS) {
169     return LHSOffset < RHS.beginOffset();
170   }
171
172   bool operator==(const Slice &RHS) const {
173     return isSplittable() == RHS.isSplittable() &&
174            beginOffset() == RHS.beginOffset() && endOffset() == RHS.endOffset();
175   }
176   bool operator!=(const Slice &RHS) const { return !operator==(RHS); }
177 };
178 } // end anonymous namespace
179
180 namespace llvm {
181 template <typename T> struct isPodLike;
182 template <> struct isPodLike<Slice> {
183    static const bool value = true;
184 };
185 }
186
187 namespace {
188 /// \brief Representation of the alloca slices.
189 ///
190 /// This class represents the slices of an alloca which are formed by its
191 /// various uses. If a pointer escapes, we can't fully build a representation
192 /// for the slices used and we reflect that in this structure. The uses are
193 /// stored, sorted by increasing beginning offset and with unsplittable slices
194 /// starting at a particular offset before splittable slices.
195 class AllocaSlices {
196 public:
197   /// \brief Construct the slices of a particular alloca.
198   AllocaSlices(const DataLayout &DL, AllocaInst &AI);
199
200   /// \brief Test whether a pointer to the allocation escapes our analysis.
201   ///
202   /// If this is true, the slices are never fully built and should be
203   /// ignored.
204   bool isEscaped() const { return PointerEscapingInstr; }
205
206   /// \brief Support for iterating over the slices.
207   /// @{
208   typedef SmallVectorImpl<Slice>::iterator iterator;
209   iterator begin() { return Slices.begin(); }
210   iterator end() { return Slices.end(); }
211
212   typedef SmallVectorImpl<Slice>::const_iterator const_iterator;
213   const_iterator begin() const { return Slices.begin(); }
214   const_iterator end() const { return Slices.end(); }
215   /// @}
216
217   /// \brief Allow iterating the dead users for this alloca.
218   ///
219   /// These are instructions which will never actually use the alloca as they
220   /// are outside the allocated range. They are safe to replace with undef and
221   /// delete.
222   /// @{
223   typedef SmallVectorImpl<Instruction *>::const_iterator dead_user_iterator;
224   dead_user_iterator dead_user_begin() const { return DeadUsers.begin(); }
225   dead_user_iterator dead_user_end() const { return DeadUsers.end(); }
226   /// @}
227
228   /// \brief Allow iterating the dead expressions referring to this alloca.
229   ///
230   /// These are operands which have cannot actually be used to refer to the
231   /// alloca as they are outside its range and the user doesn't correct for
232   /// that. These mostly consist of PHI node inputs and the like which we just
233   /// need to replace with undef.
234   /// @{
235   typedef SmallVectorImpl<Use *>::const_iterator dead_op_iterator;
236   dead_op_iterator dead_op_begin() const { return DeadOperands.begin(); }
237   dead_op_iterator dead_op_end() const { return DeadOperands.end(); }
238   /// @}
239
240 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
241   void print(raw_ostream &OS, const_iterator I, StringRef Indent = "  ") const;
242   void printSlice(raw_ostream &OS, const_iterator I,
243                   StringRef Indent = "  ") const;
244   void printUse(raw_ostream &OS, const_iterator I,
245                 StringRef Indent = "  ") const;
246   void print(raw_ostream &OS) const;
247   void dump(const_iterator I) const;
248   void dump() const;
249 #endif
250
251 private:
252   template <typename DerivedT, typename RetT = void> class BuilderBase;
253   class SliceBuilder;
254   friend class AllocaSlices::SliceBuilder;
255
256 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
257   /// \brief Handle to alloca instruction to simplify method interfaces.
258   AllocaInst &AI;
259 #endif
260
261   /// \brief The instruction responsible for this alloca not having a known set
262   /// of slices.
263   ///
264   /// When an instruction (potentially) escapes the pointer to the alloca, we
265   /// store a pointer to that here and abort trying to form slices of the
266   /// alloca. This will be null if the alloca slices are analyzed successfully.
267   Instruction *PointerEscapingInstr;
268
269   /// \brief The slices of the alloca.
270   ///
271   /// We store a vector of the slices formed by uses of the alloca here. This
272   /// vector is sorted by increasing begin offset, and then the unsplittable
273   /// slices before the splittable ones. See the Slice inner class for more
274   /// details.
275   SmallVector<Slice, 8> Slices;
276
277   /// \brief Instructions which will become dead if we rewrite the alloca.
278   ///
279   /// Note that these are not separated by slice. This is because we expect an
280   /// alloca to be completely rewritten or not rewritten at all. If rewritten,
281   /// all these instructions can simply be removed and replaced with undef as
282   /// they come from outside of the allocated space.
283   SmallVector<Instruction *, 8> DeadUsers;
284
285   /// \brief Operands which will become dead if we rewrite the alloca.
286   ///
287   /// These are operands that in their particular use can be replaced with
288   /// undef when we rewrite the alloca. These show up in out-of-bounds inputs
289   /// to PHI nodes and the like. They aren't entirely dead (there might be
290   /// a GEP back into the bounds using it elsewhere) and nor is the PHI, but we
291   /// want to swap this particular input for undef to simplify the use lists of
292   /// the alloca.
293   SmallVector<Use *, 8> DeadOperands;
294 };
295 }
296
297 static Value *foldSelectInst(SelectInst &SI) {
298   // If the condition being selected on is a constant or the same value is
299   // being selected between, fold the select. Yes this does (rarely) happen
300   // early on.
301   if (ConstantInt *CI = dyn_cast<ConstantInt>(SI.getCondition()))
302     return SI.getOperand(1+CI->isZero());
303   if (SI.getOperand(1) == SI.getOperand(2))
304     return SI.getOperand(1);
305
306   return 0;
307 }
308
309 /// \brief Builder for the alloca slices.
310 ///
311 /// This class builds a set of alloca slices by recursively visiting the uses
312 /// of an alloca and making a slice for each load and store at each offset.
313 class AllocaSlices::SliceBuilder : public PtrUseVisitor<SliceBuilder> {
314   friend class PtrUseVisitor<SliceBuilder>;
315   friend class InstVisitor<SliceBuilder>;
316   typedef PtrUseVisitor<SliceBuilder> Base;
317
318   const uint64_t AllocSize;
319   AllocaSlices &S;
320
321   SmallDenseMap<Instruction *, unsigned> MemTransferSliceMap;
322   SmallDenseMap<Instruction *, uint64_t> PHIOrSelectSizes;
323
324   /// \brief Set to de-duplicate dead instructions found in the use walk.
325   SmallPtrSet<Instruction *, 4> VisitedDeadInsts;
326
327 public:
328   SliceBuilder(const DataLayout &DL, AllocaInst &AI, AllocaSlices &S)
329       : PtrUseVisitor<SliceBuilder>(DL),
330         AllocSize(DL.getTypeAllocSize(AI.getAllocatedType())), S(S) {}
331
332 private:
333   void markAsDead(Instruction &I) {
334     if (VisitedDeadInsts.insert(&I))
335       S.DeadUsers.push_back(&I);
336   }
337
338   void insertUse(Instruction &I, const APInt &Offset, uint64_t Size,
339                  bool IsSplittable = false) {
340     // Completely skip uses which have a zero size or start either before or
341     // past the end of the allocation.
342     if (Size == 0 || Offset.isNegative() || Offset.uge(AllocSize)) {
343       DEBUG(dbgs() << "WARNING: Ignoring " << Size << " byte use @" << Offset
344                    << " which has zero size or starts outside of the "
345                    << AllocSize << " byte alloca:\n"
346                    << "    alloca: " << S.AI << "\n"
347                    << "       use: " << I << "\n");
348       return markAsDead(I);
349     }
350
351     uint64_t BeginOffset = Offset.getZExtValue();
352     uint64_t EndOffset = BeginOffset + Size;
353
354     // Clamp the end offset to the end of the allocation. Note that this is
355     // formulated to handle even the case where "BeginOffset + Size" overflows.
356     // This may appear superficially to be something we could ignore entirely,
357     // but that is not so! There may be widened loads or PHI-node uses where
358     // some instructions are dead but not others. We can't completely ignore
359     // them, and so have to record at least the information here.
360     assert(AllocSize >= BeginOffset); // Established above.
361     if (Size > AllocSize - BeginOffset) {
362       DEBUG(dbgs() << "WARNING: Clamping a " << Size << " byte use @" << Offset
363                    << " to remain within the " << AllocSize << " byte alloca:\n"
364                    << "    alloca: " << S.AI << "\n"
365                    << "       use: " << I << "\n");
366       EndOffset = AllocSize;
367     }
368
369     S.Slices.push_back(Slice(BeginOffset, EndOffset, U, IsSplittable));
370   }
371
372   void visitBitCastInst(BitCastInst &BC) {
373     if (BC.use_empty())
374       return markAsDead(BC);
375
376     return Base::visitBitCastInst(BC);
377   }
378
379   void visitGetElementPtrInst(GetElementPtrInst &GEPI) {
380     if (GEPI.use_empty())
381       return markAsDead(GEPI);
382
383     return Base::visitGetElementPtrInst(GEPI);
384   }
385
386   void handleLoadOrStore(Type *Ty, Instruction &I, const APInt &Offset,
387                          uint64_t Size, bool IsVolatile) {
388     // We allow splitting of loads and stores where the type is an integer type
389     // and cover the entire alloca. This prevents us from splitting over
390     // eagerly.
391     // FIXME: In the great blue eventually, we should eagerly split all integer
392     // loads and stores, and then have a separate step that merges adjacent
393     // alloca partitions into a single partition suitable for integer widening.
394     // Or we should skip the merge step and rely on GVN and other passes to
395     // merge adjacent loads and stores that survive mem2reg.
396     bool IsSplittable =
397         Ty->isIntegerTy() && !IsVolatile && Offset == 0 && Size >= AllocSize;
398
399     insertUse(I, Offset, Size, IsSplittable);
400   }
401
402   void visitLoadInst(LoadInst &LI) {
403     assert((!LI.isSimple() || LI.getType()->isSingleValueType()) &&
404            "All simple FCA loads should have been pre-split");
405
406     if (!IsOffsetKnown)
407       return PI.setAborted(&LI);
408
409     uint64_t Size = DL.getTypeStoreSize(LI.getType());
410     return handleLoadOrStore(LI.getType(), LI, Offset, Size, LI.isVolatile());
411   }
412
413   void visitStoreInst(StoreInst &SI) {
414     Value *ValOp = SI.getValueOperand();
415     if (ValOp == *U)
416       return PI.setEscapedAndAborted(&SI);
417     if (!IsOffsetKnown)
418       return PI.setAborted(&SI);
419
420     uint64_t Size = DL.getTypeStoreSize(ValOp->getType());
421
422     // If this memory access can be shown to *statically* extend outside the
423     // bounds of of the allocation, it's behavior is undefined, so simply
424     // ignore it. Note that this is more strict than the generic clamping
425     // behavior of insertUse. We also try to handle cases which might run the
426     // risk of overflow.
427     // FIXME: We should instead consider the pointer to have escaped if this
428     // function is being instrumented for addressing bugs or race conditions.
429     if (Offset.isNegative() || Size > AllocSize ||
430         Offset.ugt(AllocSize - Size)) {
431       DEBUG(dbgs() << "WARNING: Ignoring " << Size << " byte store @" << Offset
432                    << " which extends past the end of the " << AllocSize
433                    << " byte alloca:\n"
434                    << "    alloca: " << S.AI << "\n"
435                    << "       use: " << SI << "\n");
436       return markAsDead(SI);
437     }
438
439     assert((!SI.isSimple() || ValOp->getType()->isSingleValueType()) &&
440            "All simple FCA stores should have been pre-split");
441     handleLoadOrStore(ValOp->getType(), SI, Offset, Size, SI.isVolatile());
442   }
443
444
445   void visitMemSetInst(MemSetInst &II) {
446     assert(II.getRawDest() == *U && "Pointer use is not the destination?");
447     ConstantInt *Length = dyn_cast<ConstantInt>(II.getLength());
448     if ((Length && Length->getValue() == 0) ||
449         (IsOffsetKnown && !Offset.isNegative() && Offset.uge(AllocSize)))
450       // Zero-length mem transfer intrinsics can be ignored entirely.
451       return markAsDead(II);
452
453     if (!IsOffsetKnown)
454       return PI.setAborted(&II);
455
456     insertUse(II, Offset,
457               Length ? Length->getLimitedValue()
458                      : AllocSize - Offset.getLimitedValue(),
459               (bool)Length);
460   }
461
462   void visitMemTransferInst(MemTransferInst &II) {
463     ConstantInt *Length = dyn_cast<ConstantInt>(II.getLength());
464     if (Length && Length->getValue() == 0)
465       // Zero-length mem transfer intrinsics can be ignored entirely.
466       return markAsDead(II);
467
468     // Because we can visit these intrinsics twice, also check to see if the
469     // first time marked this instruction as dead. If so, skip it.
470     if (VisitedDeadInsts.count(&II))
471       return;
472
473     if (!IsOffsetKnown)
474       return PI.setAborted(&II);
475
476     // This side of the transfer is completely out-of-bounds, and so we can
477     // nuke the entire transfer. However, we also need to nuke the other side
478     // if already added to our partitions.
479     // FIXME: Yet another place we really should bypass this when
480     // instrumenting for ASan.
481     if (!Offset.isNegative() && Offset.uge(AllocSize)) {
482       SmallDenseMap<Instruction *, unsigned>::iterator MTPI = MemTransferSliceMap.find(&II);
483       if (MTPI != MemTransferSliceMap.end())
484         S.Slices[MTPI->second].kill();
485       return markAsDead(II);
486     }
487
488     uint64_t RawOffset = Offset.getLimitedValue();
489     uint64_t Size = Length ? Length->getLimitedValue()
490                            : AllocSize - RawOffset;
491
492     // Check for the special case where the same exact value is used for both
493     // source and dest.
494     if (*U == II.getRawDest() && *U == II.getRawSource()) {
495       // For non-volatile transfers this is a no-op.
496       if (!II.isVolatile())
497         return markAsDead(II);
498
499       return insertUse(II, Offset, Size, /*IsSplittable=*/false);
500     }
501
502     // If we have seen both source and destination for a mem transfer, then
503     // they both point to the same alloca.
504     bool Inserted;
505     SmallDenseMap<Instruction *, unsigned>::iterator MTPI;
506     llvm::tie(MTPI, Inserted) =
507         MemTransferSliceMap.insert(std::make_pair(&II, S.Slices.size()));
508     unsigned PrevIdx = MTPI->second;
509     if (!Inserted) {
510       Slice &PrevP = S.Slices[PrevIdx];
511
512       // Check if the begin offsets match and this is a non-volatile transfer.
513       // In that case, we can completely elide the transfer.
514       if (!II.isVolatile() && PrevP.beginOffset() == RawOffset) {
515         PrevP.kill();
516         return markAsDead(II);
517       }
518
519       // Otherwise we have an offset transfer within the same alloca. We can't
520       // split those.
521       PrevP.makeUnsplittable();
522     }
523
524     // Insert the use now that we've fixed up the splittable nature.
525     insertUse(II, Offset, Size, /*IsSplittable=*/Inserted && Length);
526
527     // Check that we ended up with a valid index in the map.
528     assert(S.Slices[PrevIdx].getUse()->getUser() == &II &&
529            "Map index doesn't point back to a slice with this user.");
530   }
531
532   // Disable SRoA for any intrinsics except for lifetime invariants.
533   // FIXME: What about debug intrinsics? This matches old behavior, but
534   // doesn't make sense.
535   void visitIntrinsicInst(IntrinsicInst &II) {
536     if (!IsOffsetKnown)
537       return PI.setAborted(&II);
538
539     if (II.getIntrinsicID() == Intrinsic::lifetime_start ||
540         II.getIntrinsicID() == Intrinsic::lifetime_end) {
541       ConstantInt *Length = cast<ConstantInt>(II.getArgOperand(0));
542       uint64_t Size = std::min(AllocSize - Offset.getLimitedValue(),
543                                Length->getLimitedValue());
544       insertUse(II, Offset, Size, true);
545       return;
546     }
547
548     Base::visitIntrinsicInst(II);
549   }
550
551   Instruction *hasUnsafePHIOrSelectUse(Instruction *Root, uint64_t &Size) {
552     // We consider any PHI or select that results in a direct load or store of
553     // the same offset to be a viable use for slicing purposes. These uses
554     // are considered unsplittable and the size is the maximum loaded or stored
555     // size.
556     SmallPtrSet<Instruction *, 4> Visited;
557     SmallVector<std::pair<Instruction *, Instruction *>, 4> Uses;
558     Visited.insert(Root);
559     Uses.push_back(std::make_pair(cast<Instruction>(*U), Root));
560     // If there are no loads or stores, the access is dead. We mark that as
561     // a size zero access.
562     Size = 0;
563     do {
564       Instruction *I, *UsedI;
565       llvm::tie(UsedI, I) = Uses.pop_back_val();
566
567       if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
568         Size = std::max(Size, DL.getTypeStoreSize(LI->getType()));
569         continue;
570       }
571       if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
572         Value *Op = SI->getOperand(0);
573         if (Op == UsedI)
574           return SI;
575         Size = std::max(Size, DL.getTypeStoreSize(Op->getType()));
576         continue;
577       }
578
579       if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(I)) {
580         if (!GEP->hasAllZeroIndices())
581           return GEP;
582       } else if (!isa<BitCastInst>(I) && !isa<PHINode>(I) &&
583                  !isa<SelectInst>(I)) {
584         return I;
585       }
586
587       for (Value::use_iterator UI = I->use_begin(), UE = I->use_end(); UI != UE;
588            ++UI)
589         if (Visited.insert(cast<Instruction>(*UI)))
590           Uses.push_back(std::make_pair(I, cast<Instruction>(*UI)));
591     } while (!Uses.empty());
592
593     return 0;
594   }
595
596   void visitPHINode(PHINode &PN) {
597     if (PN.use_empty())
598       return markAsDead(PN);
599     if (!IsOffsetKnown)
600       return PI.setAborted(&PN);
601
602     // See if we already have computed info on this node.
603     uint64_t &PHISize = PHIOrSelectSizes[&PN];
604     if (!PHISize) {
605       // This is a new PHI node, check for an unsafe use of the PHI node.
606       if (Instruction *UnsafeI = hasUnsafePHIOrSelectUse(&PN, PHISize))
607         return PI.setAborted(UnsafeI);
608     }
609
610     // For PHI and select operands outside the alloca, we can't nuke the entire
611     // phi or select -- the other side might still be relevant, so we special
612     // case them here and use a separate structure to track the operands
613     // themselves which should be replaced with undef.
614     // FIXME: This should instead be escaped in the event we're instrumenting
615     // for address sanitization.
616     if ((Offset.isNegative() && (-Offset).uge(PHISize)) ||
617         (!Offset.isNegative() && Offset.uge(AllocSize))) {
618       S.DeadOperands.push_back(U);
619       return;
620     }
621
622     insertUse(PN, Offset, PHISize);
623   }
624
625   void visitSelectInst(SelectInst &SI) {
626     if (SI.use_empty())
627       return markAsDead(SI);
628     if (Value *Result = foldSelectInst(SI)) {
629       if (Result == *U)
630         // If the result of the constant fold will be the pointer, recurse
631         // through the select as if we had RAUW'ed it.
632         enqueueUsers(SI);
633       else
634         // Otherwise the operand to the select is dead, and we can replace it
635         // with undef.
636         S.DeadOperands.push_back(U);
637
638       return;
639     }
640     if (!IsOffsetKnown)
641       return PI.setAborted(&SI);
642
643     // See if we already have computed info on this node.
644     uint64_t &SelectSize = PHIOrSelectSizes[&SI];
645     if (!SelectSize) {
646       // This is a new Select, check for an unsafe use of it.
647       if (Instruction *UnsafeI = hasUnsafePHIOrSelectUse(&SI, SelectSize))
648         return PI.setAborted(UnsafeI);
649     }
650
651     // For PHI and select operands outside the alloca, we can't nuke the entire
652     // phi or select -- the other side might still be relevant, so we special
653     // case them here and use a separate structure to track the operands
654     // themselves which should be replaced with undef.
655     // FIXME: This should instead be escaped in the event we're instrumenting
656     // for address sanitization.
657     if ((Offset.isNegative() && Offset.uge(SelectSize)) ||
658         (!Offset.isNegative() && Offset.uge(AllocSize))) {
659       S.DeadOperands.push_back(U);
660       return;
661     }
662
663     insertUse(SI, Offset, SelectSize);
664   }
665
666   /// \brief Disable SROA entirely if there are unhandled users of the alloca.
667   void visitInstruction(Instruction &I) {
668     PI.setAborted(&I);
669   }
670 };
671
672 AllocaSlices::AllocaSlices(const DataLayout &DL, AllocaInst &AI)
673     :
674 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
675       AI(AI),
676 #endif
677       PointerEscapingInstr(0) {
678   SliceBuilder PB(DL, AI, *this);
679   SliceBuilder::PtrInfo PtrI = PB.visitPtr(AI);
680   if (PtrI.isEscaped() || PtrI.isAborted()) {
681     // FIXME: We should sink the escape vs. abort info into the caller nicely,
682     // possibly by just storing the PtrInfo in the AllocaSlices.
683     PointerEscapingInstr = PtrI.getEscapingInst() ? PtrI.getEscapingInst()
684                                                   : PtrI.getAbortingInst();
685     assert(PointerEscapingInstr && "Did not track a bad instruction");
686     return;
687   }
688
689   Slices.erase(std::remove_if(Slices.begin(), Slices.end(),
690                               std::mem_fun_ref(&Slice::isDead)),
691                Slices.end());
692
693   // Sort the uses. This arranges for the offsets to be in ascending order,
694   // and the sizes to be in descending order.
695   std::sort(Slices.begin(), Slices.end());
696 }
697
698 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
699
700 void AllocaSlices::print(raw_ostream &OS, const_iterator I,
701                          StringRef Indent) const {
702   printSlice(OS, I, Indent);
703   printUse(OS, I, Indent);
704 }
705
706 void AllocaSlices::printSlice(raw_ostream &OS, const_iterator I,
707                               StringRef Indent) const {
708   OS << Indent << "[" << I->beginOffset() << "," << I->endOffset() << ")"
709      << " slice #" << (I - begin())
710      << (I->isSplittable() ? " (splittable)" : "") << "\n";
711 }
712
713 void AllocaSlices::printUse(raw_ostream &OS, const_iterator I,
714                             StringRef Indent) const {
715   OS << Indent << "  used by: " << *I->getUse()->getUser() << "\n";
716 }
717
718 void AllocaSlices::print(raw_ostream &OS) const {
719   if (PointerEscapingInstr) {
720     OS << "Can't analyze slices for alloca: " << AI << "\n"
721        << "  A pointer to this alloca escaped by:\n"
722        << "  " << *PointerEscapingInstr << "\n";
723     return;
724   }
725
726   OS << "Slices of alloca: " << AI << "\n";
727   for (const_iterator I = begin(), E = end(); I != E; ++I)
728     print(OS, I);
729 }
730
731 LLVM_DUMP_METHOD void AllocaSlices::dump(const_iterator I) const {
732   print(dbgs(), I);
733 }
734 LLVM_DUMP_METHOD void AllocaSlices::dump() const { print(dbgs()); }
735
736 #endif // !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
737
738 namespace {
739 /// \brief Implementation of LoadAndStorePromoter for promoting allocas.
740 ///
741 /// This subclass of LoadAndStorePromoter adds overrides to handle promoting
742 /// the loads and stores of an alloca instruction, as well as updating its
743 /// debug information. This is used when a domtree is unavailable and thus
744 /// mem2reg in its full form can't be used to handle promotion of allocas to
745 /// scalar values.
746 class AllocaPromoter : public LoadAndStorePromoter {
747   AllocaInst &AI;
748   DIBuilder &DIB;
749
750   SmallVector<DbgDeclareInst *, 4> DDIs;
751   SmallVector<DbgValueInst *, 4> DVIs;
752
753 public:
754   AllocaPromoter(const SmallVectorImpl<Instruction *> &Insts, SSAUpdater &S,
755                  AllocaInst &AI, DIBuilder &DIB)
756       : LoadAndStorePromoter(Insts, S), AI(AI), DIB(DIB) {}
757
758   void run(const SmallVectorImpl<Instruction*> &Insts) {
759     // Retain the debug information attached to the alloca for use when
760     // rewriting loads and stores.
761     if (MDNode *DebugNode = MDNode::getIfExists(AI.getContext(), &AI)) {
762       for (Value::use_iterator UI = DebugNode->use_begin(),
763                                UE = DebugNode->use_end();
764            UI != UE; ++UI)
765         if (DbgDeclareInst *DDI = dyn_cast<DbgDeclareInst>(*UI))
766           DDIs.push_back(DDI);
767         else if (DbgValueInst *DVI = dyn_cast<DbgValueInst>(*UI))
768           DVIs.push_back(DVI);
769     }
770
771     LoadAndStorePromoter::run(Insts);
772
773     // While we have the debug information, clear it off of the alloca. The
774     // caller takes care of deleting the alloca.
775     while (!DDIs.empty())
776       DDIs.pop_back_val()->eraseFromParent();
777     while (!DVIs.empty())
778       DVIs.pop_back_val()->eraseFromParent();
779   }
780
781   virtual bool isInstInList(Instruction *I,
782                             const SmallVectorImpl<Instruction*> &Insts) const {
783     Value *Ptr;
784     if (LoadInst *LI = dyn_cast<LoadInst>(I))
785       Ptr = LI->getOperand(0);
786     else
787       Ptr = cast<StoreInst>(I)->getPointerOperand();
788
789     // Only used to detect cycles, which will be rare and quickly found as
790     // we're walking up a chain of defs rather than down through uses.
791     SmallPtrSet<Value *, 4> Visited;
792
793     do {
794       if (Ptr == &AI)
795         return true;
796
797       if (BitCastInst *BCI = dyn_cast<BitCastInst>(Ptr))
798         Ptr = BCI->getOperand(0);
799       else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(Ptr))
800         Ptr = GEPI->getPointerOperand();
801       else
802         return false;
803
804     } while (Visited.insert(Ptr));
805
806     return false;
807   }
808
809   virtual void updateDebugInfo(Instruction *Inst) const {
810     for (SmallVectorImpl<DbgDeclareInst *>::const_iterator I = DDIs.begin(),
811            E = DDIs.end(); I != E; ++I) {
812       DbgDeclareInst *DDI = *I;
813       if (StoreInst *SI = dyn_cast<StoreInst>(Inst))
814         ConvertDebugDeclareToDebugValue(DDI, SI, DIB);
815       else if (LoadInst *LI = dyn_cast<LoadInst>(Inst))
816         ConvertDebugDeclareToDebugValue(DDI, LI, DIB);
817     }
818     for (SmallVectorImpl<DbgValueInst *>::const_iterator I = DVIs.begin(),
819            E = DVIs.end(); I != E; ++I) {
820       DbgValueInst *DVI = *I;
821       Value *Arg = 0;
822       if (StoreInst *SI = dyn_cast<StoreInst>(Inst)) {
823         // If an argument is zero extended then use argument directly. The ZExt
824         // may be zapped by an optimization pass in future.
825         if (ZExtInst *ZExt = dyn_cast<ZExtInst>(SI->getOperand(0)))
826           Arg = dyn_cast<Argument>(ZExt->getOperand(0));
827         else if (SExtInst *SExt = dyn_cast<SExtInst>(SI->getOperand(0)))
828           Arg = dyn_cast<Argument>(SExt->getOperand(0));
829         if (!Arg)
830           Arg = SI->getValueOperand();
831       } else if (LoadInst *LI = dyn_cast<LoadInst>(Inst)) {
832         Arg = LI->getPointerOperand();
833       } else {
834         continue;
835       }
836       Instruction *DbgVal =
837         DIB.insertDbgValueIntrinsic(Arg, 0, DIVariable(DVI->getVariable()),
838                                      Inst);
839       DbgVal->setDebugLoc(DVI->getDebugLoc());
840     }
841   }
842 };
843 } // end anon namespace
844
845
846 namespace {
847 /// \brief An optimization pass providing Scalar Replacement of Aggregates.
848 ///
849 /// This pass takes allocations which can be completely analyzed (that is, they
850 /// don't escape) and tries to turn them into scalar SSA values. There are
851 /// a few steps to this process.
852 ///
853 /// 1) It takes allocations of aggregates and analyzes the ways in which they
854 ///    are used to try to split them into smaller allocations, ideally of
855 ///    a single scalar data type. It will split up memcpy and memset accesses
856 ///    as necessary and try to isolate individual scalar accesses.
857 /// 2) It will transform accesses into forms which are suitable for SSA value
858 ///    promotion. This can be replacing a memset with a scalar store of an
859 ///    integer value, or it can involve speculating operations on a PHI or
860 ///    select to be a PHI or select of the results.
861 /// 3) Finally, this will try to detect a pattern of accesses which map cleanly
862 ///    onto insert and extract operations on a vector value, and convert them to
863 ///    this form. By doing so, it will enable promotion of vector aggregates to
864 ///    SSA vector values.
865 class SROA : public FunctionPass {
866   const bool RequiresDomTree;
867
868   LLVMContext *C;
869   const DataLayout *DL;
870   DominatorTree *DT;
871
872   /// \brief Worklist of alloca instructions to simplify.
873   ///
874   /// Each alloca in the function is added to this. Each new alloca formed gets
875   /// added to it as well to recursively simplify unless that alloca can be
876   /// directly promoted. Finally, each time we rewrite a use of an alloca other
877   /// the one being actively rewritten, we add it back onto the list if not
878   /// already present to ensure it is re-visited.
879   SetVector<AllocaInst *, SmallVector<AllocaInst *, 16> > Worklist;
880
881   /// \brief A collection of instructions to delete.
882   /// We try to batch deletions to simplify code and make things a bit more
883   /// efficient.
884   SetVector<Instruction *, SmallVector<Instruction *, 8> > DeadInsts;
885
886   /// \brief Post-promotion worklist.
887   ///
888   /// Sometimes we discover an alloca which has a high probability of becoming
889   /// viable for SROA after a round of promotion takes place. In those cases,
890   /// the alloca is enqueued here for re-processing.
891   ///
892   /// Note that we have to be very careful to clear allocas out of this list in
893   /// the event they are deleted.
894   SetVector<AllocaInst *, SmallVector<AllocaInst *, 16> > PostPromotionWorklist;
895
896   /// \brief A collection of alloca instructions we can directly promote.
897   std::vector<AllocaInst *> PromotableAllocas;
898
899   /// \brief A worklist of PHIs to speculate prior to promoting allocas.
900   ///
901   /// All of these PHIs have been checked for the safety of speculation and by
902   /// being speculated will allow promoting allocas currently in the promotable
903   /// queue.
904   SetVector<PHINode *, SmallVector<PHINode *, 2> > SpeculatablePHIs;
905
906   /// \brief A worklist of select instructions to speculate prior to promoting
907   /// allocas.
908   ///
909   /// All of these select instructions have been checked for the safety of
910   /// speculation and by being speculated will allow promoting allocas
911   /// currently in the promotable queue.
912   SetVector<SelectInst *, SmallVector<SelectInst *, 2> > SpeculatableSelects;
913
914 public:
915   SROA(bool RequiresDomTree = true)
916       : FunctionPass(ID), RequiresDomTree(RequiresDomTree),
917         C(0), DL(0), DT(0) {
918     initializeSROAPass(*PassRegistry::getPassRegistry());
919   }
920   bool runOnFunction(Function &F);
921   void getAnalysisUsage(AnalysisUsage &AU) const;
922
923   const char *getPassName() const { return "SROA"; }
924   static char ID;
925
926 private:
927   friend class PHIOrSelectSpeculator;
928   friend class AllocaSliceRewriter;
929
930   bool rewritePartition(AllocaInst &AI, AllocaSlices &S,
931                         AllocaSlices::iterator B, AllocaSlices::iterator E,
932                         int64_t BeginOffset, int64_t EndOffset,
933                         ArrayRef<AllocaSlices::iterator> SplitUses);
934   bool splitAlloca(AllocaInst &AI, AllocaSlices &S);
935   bool runOnAlloca(AllocaInst &AI);
936   void clobberUse(Use &U);
937   void deleteDeadInstructions(SmallPtrSet<AllocaInst *, 4> &DeletedAllocas);
938   bool promoteAllocas(Function &F);
939 };
940 }
941
942 char SROA::ID = 0;
943
944 FunctionPass *llvm::createSROAPass(bool RequiresDomTree) {
945   return new SROA(RequiresDomTree);
946 }
947
948 INITIALIZE_PASS_BEGIN(SROA, "sroa", "Scalar Replacement Of Aggregates",
949                       false, false)
950 INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
951 INITIALIZE_PASS_END(SROA, "sroa", "Scalar Replacement Of Aggregates",
952                     false, false)
953
954 /// Walk the range of a partitioning looking for a common type to cover this
955 /// sequence of slices.
956 static Type *findCommonType(AllocaSlices::const_iterator B,
957                             AllocaSlices::const_iterator E,
958                             uint64_t EndOffset) {
959   Type *Ty = 0;
960   bool TyIsCommon = true;
961   IntegerType *ITy = 0;
962
963   // Note that we need to look at *every* alloca slice's Use to ensure we
964   // always get consistent results regardless of the order of slices.
965   for (AllocaSlices::const_iterator I = B; I != E; ++I) {
966     Use *U = I->getUse();
967     if (isa<IntrinsicInst>(*U->getUser()))
968       continue;
969     if (I->beginOffset() != B->beginOffset() || I->endOffset() != EndOffset)
970       continue;
971
972     Type *UserTy = 0;
973     if (LoadInst *LI = dyn_cast<LoadInst>(U->getUser())) {
974       UserTy = LI->getType();
975     } else if (StoreInst *SI = dyn_cast<StoreInst>(U->getUser())) {
976       UserTy = SI->getValueOperand()->getType();
977     }
978
979     if (!UserTy || (Ty && Ty != UserTy))
980       TyIsCommon = false; // Give up on anything but an iN type.
981     else
982       Ty = UserTy;
983
984     if (IntegerType *UserITy = dyn_cast_or_null<IntegerType>(UserTy)) {
985       // If the type is larger than the partition, skip it. We only encounter
986       // this for split integer operations where we want to use the type of the
987       // entity causing the split. Also skip if the type is not a byte width
988       // multiple.
989       if (UserITy->getBitWidth() % 8 != 0 ||
990           UserITy->getBitWidth() / 8 > (EndOffset - B->beginOffset()))
991         continue;
992
993       // Track the largest bitwidth integer type used in this way in case there
994       // is no common type.
995       if (!ITy || ITy->getBitWidth() < UserITy->getBitWidth())
996         ITy = UserITy;
997     }
998   }
999
1000   return TyIsCommon ? Ty : ITy;
1001 }
1002
1003 /// PHI instructions that use an alloca and are subsequently loaded can be
1004 /// rewritten to load both input pointers in the pred blocks and then PHI the
1005 /// results, allowing the load of the alloca to be promoted.
1006 /// From this:
1007 ///   %P2 = phi [i32* %Alloca, i32* %Other]
1008 ///   %V = load i32* %P2
1009 /// to:
1010 ///   %V1 = load i32* %Alloca      -> will be mem2reg'd
1011 ///   ...
1012 ///   %V2 = load i32* %Other
1013 ///   ...
1014 ///   %V = phi [i32 %V1, i32 %V2]
1015 ///
1016 /// We can do this to a select if its only uses are loads and if the operands
1017 /// to the select can be loaded unconditionally.
1018 ///
1019 /// FIXME: This should be hoisted into a generic utility, likely in
1020 /// Transforms/Util/Local.h
1021 static bool isSafePHIToSpeculate(PHINode &PN,
1022                                  const DataLayout *DL = 0) {
1023   // For now, we can only do this promotion if the load is in the same block
1024   // as the PHI, and if there are no stores between the phi and load.
1025   // TODO: Allow recursive phi users.
1026   // TODO: Allow stores.
1027   BasicBlock *BB = PN.getParent();
1028   unsigned MaxAlign = 0;
1029   bool HaveLoad = false;
1030   for (Value::use_iterator UI = PN.use_begin(), UE = PN.use_end(); UI != UE;
1031        ++UI) {
1032     LoadInst *LI = dyn_cast<LoadInst>(*UI);
1033     if (LI == 0 || !LI->isSimple())
1034       return false;
1035
1036     // For now we only allow loads in the same block as the PHI.  This is
1037     // a common case that happens when instcombine merges two loads through
1038     // a PHI.
1039     if (LI->getParent() != BB)
1040       return false;
1041
1042     // Ensure that there are no instructions between the PHI and the load that
1043     // could store.
1044     for (BasicBlock::iterator BBI = &PN; &*BBI != LI; ++BBI)
1045       if (BBI->mayWriteToMemory())
1046         return false;
1047
1048     MaxAlign = std::max(MaxAlign, LI->getAlignment());
1049     HaveLoad = true;
1050   }
1051
1052   if (!HaveLoad)
1053     return false;
1054
1055   // We can only transform this if it is safe to push the loads into the
1056   // predecessor blocks. The only thing to watch out for is that we can't put
1057   // a possibly trapping load in the predecessor if it is a critical edge.
1058   for (unsigned Idx = 0, Num = PN.getNumIncomingValues(); Idx != Num; ++Idx) {
1059     TerminatorInst *TI = PN.getIncomingBlock(Idx)->getTerminator();
1060     Value *InVal = PN.getIncomingValue(Idx);
1061
1062     // If the value is produced by the terminator of the predecessor (an
1063     // invoke) or it has side-effects, there is no valid place to put a load
1064     // in the predecessor.
1065     if (TI == InVal || TI->mayHaveSideEffects())
1066       return false;
1067
1068     // If the predecessor has a single successor, then the edge isn't
1069     // critical.
1070     if (TI->getNumSuccessors() == 1)
1071       continue;
1072
1073     // If this pointer is always safe to load, or if we can prove that there
1074     // is already a load in the block, then we can move the load to the pred
1075     // block.
1076     if (InVal->isDereferenceablePointer() ||
1077         isSafeToLoadUnconditionally(InVal, TI, MaxAlign, DL))
1078       continue;
1079
1080     return false;
1081   }
1082
1083   return true;
1084 }
1085
1086 static void speculatePHINodeLoads(PHINode &PN) {
1087   DEBUG(dbgs() << "    original: " << PN << "\n");
1088
1089   Type *LoadTy = cast<PointerType>(PN.getType())->getElementType();
1090   IRBuilderTy PHIBuilder(&PN);
1091   PHINode *NewPN = PHIBuilder.CreatePHI(LoadTy, PN.getNumIncomingValues(),
1092                                         PN.getName() + ".sroa.speculated");
1093
1094   // Get the TBAA tag and alignment to use from one of the loads.  It doesn't
1095   // matter which one we get and if any differ.
1096   LoadInst *SomeLoad = cast<LoadInst>(*PN.use_begin());
1097   MDNode *TBAATag = SomeLoad->getMetadata(LLVMContext::MD_tbaa);
1098   unsigned Align = SomeLoad->getAlignment();
1099
1100   // Rewrite all loads of the PN to use the new PHI.
1101   while (!PN.use_empty()) {
1102     LoadInst *LI = cast<LoadInst>(*PN.use_begin());
1103     LI->replaceAllUsesWith(NewPN);
1104     LI->eraseFromParent();
1105   }
1106
1107   // Inject loads into all of the pred blocks.
1108   for (unsigned Idx = 0, Num = PN.getNumIncomingValues(); Idx != Num; ++Idx) {
1109     BasicBlock *Pred = PN.getIncomingBlock(Idx);
1110     TerminatorInst *TI = Pred->getTerminator();
1111     Value *InVal = PN.getIncomingValue(Idx);
1112     IRBuilderTy PredBuilder(TI);
1113
1114     LoadInst *Load = PredBuilder.CreateLoad(
1115         InVal, (PN.getName() + ".sroa.speculate.load." + Pred->getName()));
1116     ++NumLoadsSpeculated;
1117     Load->setAlignment(Align);
1118     if (TBAATag)
1119       Load->setMetadata(LLVMContext::MD_tbaa, TBAATag);
1120     NewPN->addIncoming(Load, Pred);
1121   }
1122
1123   DEBUG(dbgs() << "          speculated to: " << *NewPN << "\n");
1124   PN.eraseFromParent();
1125 }
1126
1127 /// Select instructions that use an alloca and are subsequently loaded can be
1128 /// rewritten to load both input pointers and then select between the result,
1129 /// 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
1139 /// to the select can be loaded unconditionally.
1140 static bool isSafeSelectToSpeculate(SelectInst &SI, const DataLayout *DL = 0) {
1141   Value *TValue = SI.getTrueValue();
1142   Value *FValue = SI.getFalseValue();
1143   bool TDerefable = TValue->isDereferenceablePointer();
1144   bool FDerefable = FValue->isDereferenceablePointer();
1145
1146   for (Value::use_iterator UI = SI.use_begin(), UE = SI.use_end(); UI != UE;
1147        ++UI) {
1148     LoadInst *LI = dyn_cast<LoadInst>(*UI);
1149     if (LI == 0 || !LI->isSimple())
1150       return false;
1151
1152     // Both operands to the select need to be dereferencable, either
1153     // absolutely (e.g. allocas) or at this point because we can see other
1154     // accesses to it.
1155     if (!TDerefable &&
1156         !isSafeToLoadUnconditionally(TValue, LI, LI->getAlignment(), DL))
1157       return false;
1158     if (!FDerefable &&
1159         !isSafeToLoadUnconditionally(FValue, LI, LI->getAlignment(), DL))
1160       return false;
1161   }
1162
1163   return true;
1164 }
1165
1166 static void speculateSelectInstLoads(SelectInst &SI) {
1167   DEBUG(dbgs() << "    original: " << SI << "\n");
1168
1169   IRBuilderTy IRB(&SI);
1170   Value *TV = SI.getTrueValue();
1171   Value *FV = SI.getFalseValue();
1172   // Replace the loads of the select with a select of two loads.
1173   while (!SI.use_empty()) {
1174     LoadInst *LI = cast<LoadInst>(*SI.use_begin());
1175     assert(LI->isSimple() && "We only speculate simple loads");
1176
1177     IRB.SetInsertPoint(LI);
1178     LoadInst *TL =
1179         IRB.CreateLoad(TV, LI->getName() + ".sroa.speculate.load.true");
1180     LoadInst *FL =
1181         IRB.CreateLoad(FV, LI->getName() + ".sroa.speculate.load.false");
1182     NumLoadsSpeculated += 2;
1183
1184     // Transfer alignment and TBAA info if present.
1185     TL->setAlignment(LI->getAlignment());
1186     FL->setAlignment(LI->getAlignment());
1187     if (MDNode *Tag = LI->getMetadata(LLVMContext::MD_tbaa)) {
1188       TL->setMetadata(LLVMContext::MD_tbaa, Tag);
1189       FL->setMetadata(LLVMContext::MD_tbaa, Tag);
1190     }
1191
1192     Value *V = IRB.CreateSelect(SI.getCondition(), TL, FL,
1193                                 LI->getName() + ".sroa.speculated");
1194
1195     DEBUG(dbgs() << "          speculated to: " << *V << "\n");
1196     LI->replaceAllUsesWith(V);
1197     LI->eraseFromParent();
1198   }
1199   SI.eraseFromParent();
1200 }
1201
1202 /// \brief Build a GEP out of a base pointer and indices.
1203 ///
1204 /// This will return the BasePtr if that is valid, or build a new GEP
1205 /// instruction using the IRBuilder if GEP-ing is needed.
1206 static Value *buildGEP(IRBuilderTy &IRB, Value *BasePtr,
1207                        SmallVectorImpl<Value *> &Indices) {
1208   if (Indices.empty())
1209     return BasePtr;
1210
1211   // A single zero index is a no-op, so check for this and avoid building a GEP
1212   // in that case.
1213   if (Indices.size() == 1 && cast<ConstantInt>(Indices.back())->isZero())
1214     return BasePtr;
1215
1216   return IRB.CreateInBoundsGEP(BasePtr, Indices, "idx");
1217 }
1218
1219 /// \brief Get a natural GEP off of the BasePtr walking through Ty toward
1220 /// TargetTy without changing the offset of the pointer.
1221 ///
1222 /// This routine assumes we've already established a properly offset GEP with
1223 /// Indices, and arrived at the Ty type. The goal is to continue to GEP with
1224 /// zero-indices down through type layers until we find one the same as
1225 /// TargetTy. If we can't find one with the same type, we at least try to use
1226 /// one with the same size. If none of that works, we just produce the GEP as
1227 /// indicated by Indices to have the correct offset.
1228 static Value *getNaturalGEPWithType(IRBuilderTy &IRB, const DataLayout &DL,
1229                                     Value *BasePtr, Type *Ty, Type *TargetTy,
1230                                     SmallVectorImpl<Value *> &Indices) {
1231   if (Ty == TargetTy)
1232     return buildGEP(IRB, BasePtr, Indices);
1233
1234   // See if we can descend into a struct and locate a field with the correct
1235   // type.
1236   unsigned NumLayers = 0;
1237   Type *ElementTy = Ty;
1238   do {
1239     if (ElementTy->isPointerTy())
1240       break;
1241     if (SequentialType *SeqTy = dyn_cast<SequentialType>(ElementTy)) {
1242       ElementTy = SeqTy->getElementType();
1243       // Note that we use the default address space as this index is over an
1244       // array or a vector, not a pointer.
1245       Indices.push_back(IRB.getInt(APInt(DL.getPointerSizeInBits(0), 0)));
1246     } else if (StructType *STy = dyn_cast<StructType>(ElementTy)) {
1247       if (STy->element_begin() == STy->element_end())
1248         break; // Nothing left to descend into.
1249       ElementTy = *STy->element_begin();
1250       Indices.push_back(IRB.getInt32(0));
1251     } else {
1252       break;
1253     }
1254     ++NumLayers;
1255   } while (ElementTy != TargetTy);
1256   if (ElementTy != TargetTy)
1257     Indices.erase(Indices.end() - NumLayers, Indices.end());
1258
1259   return buildGEP(IRB, BasePtr, Indices);
1260 }
1261
1262 /// \brief Recursively compute indices for a natural GEP.
1263 ///
1264 /// This is the recursive step for getNaturalGEPWithOffset that walks down the
1265 /// element types adding appropriate indices for the GEP.
1266 static Value *getNaturalGEPRecursively(IRBuilderTy &IRB, const DataLayout &DL,
1267                                        Value *Ptr, Type *Ty, APInt &Offset,
1268                                        Type *TargetTy,
1269                                        SmallVectorImpl<Value *> &Indices) {
1270   if (Offset == 0)
1271     return getNaturalGEPWithType(IRB, DL, Ptr, Ty, TargetTy, Indices);
1272
1273   // We can't recurse through pointer types.
1274   if (Ty->isPointerTy())
1275     return 0;
1276
1277   // We try to analyze GEPs over vectors here, but note that these GEPs are
1278   // extremely poorly defined currently. The long-term goal is to remove GEPing
1279   // over a vector from the IR completely.
1280   if (VectorType *VecTy = dyn_cast<VectorType>(Ty)) {
1281     unsigned ElementSizeInBits = DL.getTypeSizeInBits(VecTy->getScalarType());
1282     if (ElementSizeInBits % 8)
1283       return 0; // GEPs over non-multiple of 8 size vector elements are invalid.
1284     APInt ElementSize(Offset.getBitWidth(), ElementSizeInBits / 8);
1285     APInt NumSkippedElements = Offset.sdiv(ElementSize);
1286     if (NumSkippedElements.ugt(VecTy->getNumElements()))
1287       return 0;
1288     Offset -= NumSkippedElements * ElementSize;
1289     Indices.push_back(IRB.getInt(NumSkippedElements));
1290     return getNaturalGEPRecursively(IRB, DL, Ptr, VecTy->getElementType(),
1291                                     Offset, TargetTy, Indices);
1292   }
1293
1294   if (ArrayType *ArrTy = dyn_cast<ArrayType>(Ty)) {
1295     Type *ElementTy = ArrTy->getElementType();
1296     APInt ElementSize(Offset.getBitWidth(), DL.getTypeAllocSize(ElementTy));
1297     APInt NumSkippedElements = Offset.sdiv(ElementSize);
1298     if (NumSkippedElements.ugt(ArrTy->getNumElements()))
1299       return 0;
1300
1301     Offset -= NumSkippedElements * ElementSize;
1302     Indices.push_back(IRB.getInt(NumSkippedElements));
1303     return getNaturalGEPRecursively(IRB, DL, Ptr, ElementTy, Offset, TargetTy,
1304                                     Indices);
1305   }
1306
1307   StructType *STy = dyn_cast<StructType>(Ty);
1308   if (!STy)
1309     return 0;
1310
1311   const StructLayout *SL = DL.getStructLayout(STy);
1312   uint64_t StructOffset = Offset.getZExtValue();
1313   if (StructOffset >= SL->getSizeInBytes())
1314     return 0;
1315   unsigned Index = SL->getElementContainingOffset(StructOffset);
1316   Offset -= APInt(Offset.getBitWidth(), SL->getElementOffset(Index));
1317   Type *ElementTy = STy->getElementType(Index);
1318   if (Offset.uge(DL.getTypeAllocSize(ElementTy)))
1319     return 0; // The offset points into alignment padding.
1320
1321   Indices.push_back(IRB.getInt32(Index));
1322   return getNaturalGEPRecursively(IRB, DL, Ptr, ElementTy, Offset, TargetTy,
1323                                   Indices);
1324 }
1325
1326 /// \brief Get a natural GEP from a base pointer to a particular offset and
1327 /// resulting in a particular type.
1328 ///
1329 /// The goal is to produce a "natural" looking GEP that works with the existing
1330 /// composite types to arrive at the appropriate offset and element type for
1331 /// a pointer. TargetTy is the element type the returned GEP should point-to if
1332 /// possible. We recurse by decreasing Offset, adding the appropriate index to
1333 /// Indices, and setting Ty to the result subtype.
1334 ///
1335 /// If no natural GEP can be constructed, this function returns null.
1336 static Value *getNaturalGEPWithOffset(IRBuilderTy &IRB, const DataLayout &DL,
1337                                       Value *Ptr, APInt Offset, Type *TargetTy,
1338                                       SmallVectorImpl<Value *> &Indices) {
1339   PointerType *Ty = cast<PointerType>(Ptr->getType());
1340
1341   // Don't consider any GEPs through an i8* as natural unless the TargetTy is
1342   // an i8.
1343   if (Ty == IRB.getInt8PtrTy() && TargetTy->isIntegerTy(8))
1344     return 0;
1345
1346   Type *ElementTy = Ty->getElementType();
1347   if (!ElementTy->isSized())
1348     return 0; // We can't GEP through an unsized element.
1349   APInt ElementSize(Offset.getBitWidth(), DL.getTypeAllocSize(ElementTy));
1350   if (ElementSize == 0)
1351     return 0; // Zero-length arrays can't help us build a natural GEP.
1352   APInt NumSkippedElements = Offset.sdiv(ElementSize);
1353
1354   Offset -= NumSkippedElements * ElementSize;
1355   Indices.push_back(IRB.getInt(NumSkippedElements));
1356   return getNaturalGEPRecursively(IRB, DL, Ptr, ElementTy, Offset, TargetTy,
1357                                   Indices);
1358 }
1359
1360 /// \brief Compute an adjusted pointer from Ptr by Offset bytes where the
1361 /// resulting pointer has PointerTy.
1362 ///
1363 /// This tries very hard to compute a "natural" GEP which arrives at the offset
1364 /// and produces the pointer type desired. Where it cannot, it will try to use
1365 /// the natural GEP to arrive at the offset and bitcast to the type. Where that
1366 /// fails, it will try to use an existing i8* and GEP to the byte offset and
1367 /// bitcast to the type.
1368 ///
1369 /// The strategy for finding the more natural GEPs is to peel off layers of the
1370 /// pointer, walking back through bit casts and GEPs, searching for a base
1371 /// pointer from which we can compute a natural GEP with the desired
1372 /// properties. The algorithm tries to fold as many constant indices into
1373 /// a single GEP as possible, thus making each GEP more independent of the
1374 /// surrounding code.
1375 static Value *getAdjustedPtr(IRBuilderTy &IRB, const DataLayout &DL,
1376                              Value *Ptr, APInt Offset, Type *PointerTy) {
1377   // Even though we don't look through PHI nodes, we could be called on an
1378   // instruction in an unreachable block, which may be on a cycle.
1379   SmallPtrSet<Value *, 4> Visited;
1380   Visited.insert(Ptr);
1381   SmallVector<Value *, 4> Indices;
1382
1383   // We may end up computing an offset pointer that has the wrong type. If we
1384   // never are able to compute one directly that has the correct type, we'll
1385   // fall back to it, so keep it around here.
1386   Value *OffsetPtr = 0;
1387
1388   // Remember any i8 pointer we come across to re-use if we need to do a raw
1389   // byte offset.
1390   Value *Int8Ptr = 0;
1391   APInt Int8PtrOffset(Offset.getBitWidth(), 0);
1392
1393   Type *TargetTy = PointerTy->getPointerElementType();
1394
1395   do {
1396     // First fold any existing GEPs into the offset.
1397     while (GEPOperator *GEP = dyn_cast<GEPOperator>(Ptr)) {
1398       APInt GEPOffset(Offset.getBitWidth(), 0);
1399       if (!GEP->accumulateConstantOffset(DL, GEPOffset))
1400         break;
1401       Offset += GEPOffset;
1402       Ptr = GEP->getPointerOperand();
1403       if (!Visited.insert(Ptr))
1404         break;
1405     }
1406
1407     // See if we can perform a natural GEP here.
1408     Indices.clear();
1409     if (Value *P = getNaturalGEPWithOffset(IRB, DL, Ptr, Offset, TargetTy,
1410                                            Indices)) {
1411       if (P->getType() == PointerTy) {
1412         // Zap any offset pointer that we ended up computing in previous rounds.
1413         if (OffsetPtr && OffsetPtr->use_empty())
1414           if (Instruction *I = dyn_cast<Instruction>(OffsetPtr))
1415             I->eraseFromParent();
1416         return P;
1417       }
1418       if (!OffsetPtr) {
1419         OffsetPtr = P;
1420       }
1421     }
1422
1423     // Stash this pointer if we've found an i8*.
1424     if (Ptr->getType()->isIntegerTy(8)) {
1425       Int8Ptr = Ptr;
1426       Int8PtrOffset = Offset;
1427     }
1428
1429     // Peel off a layer of the pointer and update the offset appropriately.
1430     if (Operator::getOpcode(Ptr) == Instruction::BitCast) {
1431       Ptr = cast<Operator>(Ptr)->getOperand(0);
1432     } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(Ptr)) {
1433       if (GA->mayBeOverridden())
1434         break;
1435       Ptr = GA->getAliasee();
1436     } else {
1437       break;
1438     }
1439     assert(Ptr->getType()->isPointerTy() && "Unexpected operand type!");
1440   } while (Visited.insert(Ptr));
1441
1442   if (!OffsetPtr) {
1443     if (!Int8Ptr) {
1444       Int8Ptr = IRB.CreateBitCast(Ptr, IRB.getInt8PtrTy(),
1445                                   "raw_cast");
1446       Int8PtrOffset = Offset;
1447     }
1448
1449     OffsetPtr = Int8PtrOffset == 0 ? Int8Ptr :
1450       IRB.CreateInBoundsGEP(Int8Ptr, IRB.getInt(Int8PtrOffset),
1451                             "raw_idx");
1452   }
1453   Ptr = OffsetPtr;
1454
1455   // On the off chance we were targeting i8*, guard the bitcast here.
1456   if (Ptr->getType() != PointerTy)
1457     Ptr = IRB.CreateBitCast(Ptr, PointerTy, "cast");
1458
1459   return Ptr;
1460 }
1461
1462 /// \brief Test whether we can convert a value from the old to the new type.
1463 ///
1464 /// This predicate should be used to guard calls to convertValue in order to
1465 /// ensure that we only try to convert viable values. The strategy is that we
1466 /// will peel off single element struct and array wrappings to get to an
1467 /// underlying value, and convert that value.
1468 static bool canConvertValue(const DataLayout &DL, Type *OldTy, Type *NewTy) {
1469   if (OldTy == NewTy)
1470     return true;
1471   if (IntegerType *OldITy = dyn_cast<IntegerType>(OldTy))
1472     if (IntegerType *NewITy = dyn_cast<IntegerType>(NewTy))
1473       if (NewITy->getBitWidth() >= OldITy->getBitWidth())
1474         return true;
1475   if (DL.getTypeSizeInBits(NewTy) != DL.getTypeSizeInBits(OldTy))
1476     return false;
1477   if (!NewTy->isSingleValueType() || !OldTy->isSingleValueType())
1478     return false;
1479
1480   // We can convert pointers to integers and vice-versa. Same for vectors
1481   // of pointers and integers.
1482   OldTy = OldTy->getScalarType();
1483   NewTy = NewTy->getScalarType();
1484   if (NewTy->isPointerTy() || OldTy->isPointerTy()) {
1485     if (NewTy->isPointerTy() && OldTy->isPointerTy())
1486       return true;
1487     if (NewTy->isIntegerTy() || OldTy->isIntegerTy())
1488       return true;
1489     return false;
1490   }
1491
1492   return true;
1493 }
1494
1495 /// \brief Generic routine to convert an SSA value to a value of a different
1496 /// type.
1497 ///
1498 /// This will try various different casting techniques, such as bitcasts,
1499 /// inttoptr, and ptrtoint casts. Use the \c canConvertValue predicate to test
1500 /// two types for viability with this routine.
1501 static Value *convertValue(const DataLayout &DL, IRBuilderTy &IRB, Value *V,
1502                            Type *NewTy) {
1503   Type *OldTy = V->getType();
1504   assert(canConvertValue(DL, OldTy, NewTy) && "Value not convertable to type");
1505
1506   if (OldTy == NewTy)
1507     return V;
1508
1509   if (IntegerType *OldITy = dyn_cast<IntegerType>(OldTy))
1510     if (IntegerType *NewITy = dyn_cast<IntegerType>(NewTy))
1511       if (NewITy->getBitWidth() > OldITy->getBitWidth())
1512         return IRB.CreateZExt(V, NewITy);
1513
1514   // See if we need inttoptr for this type pair. A cast involving both scalars
1515   // and vectors requires and additional bitcast.
1516   if (OldTy->getScalarType()->isIntegerTy() &&
1517       NewTy->getScalarType()->isPointerTy()) {
1518     // Expand <2 x i32> to i8* --> <2 x i32> to i64 to i8*
1519     if (OldTy->isVectorTy() && !NewTy->isVectorTy())
1520       return IRB.CreateIntToPtr(IRB.CreateBitCast(V, DL.getIntPtrType(NewTy)),
1521                                 NewTy);
1522
1523     // Expand i128 to <2 x i8*> --> i128 to <2 x i64> to <2 x i8*>
1524     if (!OldTy->isVectorTy() && NewTy->isVectorTy())
1525       return IRB.CreateIntToPtr(IRB.CreateBitCast(V, DL.getIntPtrType(NewTy)),
1526                                 NewTy);
1527
1528     return IRB.CreateIntToPtr(V, NewTy);
1529   }
1530
1531   // See if we need ptrtoint for this type pair. A cast involving both scalars
1532   // and vectors requires and additional bitcast.
1533   if (OldTy->getScalarType()->isPointerTy() &&
1534       NewTy->getScalarType()->isIntegerTy()) {
1535     // Expand <2 x i8*> to i128 --> <2 x i8*> to <2 x i64> to i128
1536     if (OldTy->isVectorTy() && !NewTy->isVectorTy())
1537       return IRB.CreateBitCast(IRB.CreatePtrToInt(V, DL.getIntPtrType(OldTy)),
1538                                NewTy);
1539
1540     // Expand i8* to <2 x i32> --> i8* to i64 to <2 x i32>
1541     if (!OldTy->isVectorTy() && NewTy->isVectorTy())
1542       return IRB.CreateBitCast(IRB.CreatePtrToInt(V, DL.getIntPtrType(OldTy)),
1543                                NewTy);
1544
1545     return IRB.CreatePtrToInt(V, NewTy);
1546   }
1547
1548   return IRB.CreateBitCast(V, NewTy);
1549 }
1550
1551 /// \brief Test whether the given slice use can be promoted to a vector.
1552 ///
1553 /// This function is called to test each entry in a partioning which is slated
1554 /// for a single slice.
1555 static bool isVectorPromotionViableForSlice(
1556     const DataLayout &DL, AllocaSlices &S, uint64_t SliceBeginOffset,
1557     uint64_t SliceEndOffset, VectorType *Ty, uint64_t ElementSize,
1558     AllocaSlices::const_iterator I) {
1559   // First validate the slice offsets.
1560   uint64_t BeginOffset =
1561       std::max(I->beginOffset(), SliceBeginOffset) - SliceBeginOffset;
1562   uint64_t BeginIndex = BeginOffset / ElementSize;
1563   if (BeginIndex * ElementSize != BeginOffset ||
1564       BeginIndex >= Ty->getNumElements())
1565     return false;
1566   uint64_t EndOffset =
1567       std::min(I->endOffset(), SliceEndOffset) - SliceBeginOffset;
1568   uint64_t EndIndex = EndOffset / ElementSize;
1569   if (EndIndex * ElementSize != EndOffset || EndIndex > Ty->getNumElements())
1570     return false;
1571
1572   assert(EndIndex > BeginIndex && "Empty vector!");
1573   uint64_t NumElements = EndIndex - BeginIndex;
1574   Type *SliceTy =
1575       (NumElements == 1) ? Ty->getElementType()
1576                          : VectorType::get(Ty->getElementType(), NumElements);
1577
1578   Type *SplitIntTy =
1579       Type::getIntNTy(Ty->getContext(), NumElements * ElementSize * 8);
1580
1581   Use *U = I->getUse();
1582
1583   if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(U->getUser())) {
1584     if (MI->isVolatile())
1585       return false;
1586     if (!I->isSplittable())
1587       return false; // Skip any unsplittable intrinsics.
1588   } else if (U->get()->getType()->getPointerElementType()->isStructTy()) {
1589     // Disable vector promotion when there are loads or stores of an FCA.
1590     return false;
1591   } else if (LoadInst *LI = dyn_cast<LoadInst>(U->getUser())) {
1592     if (LI->isVolatile())
1593       return false;
1594     Type *LTy = LI->getType();
1595     if (SliceBeginOffset > I->beginOffset() ||
1596         SliceEndOffset < I->endOffset()) {
1597       assert(LTy->isIntegerTy());
1598       LTy = SplitIntTy;
1599     }
1600     if (!canConvertValue(DL, SliceTy, LTy))
1601       return false;
1602   } else if (StoreInst *SI = dyn_cast<StoreInst>(U->getUser())) {
1603     if (SI->isVolatile())
1604       return false;
1605     Type *STy = SI->getValueOperand()->getType();
1606     if (SliceBeginOffset > I->beginOffset() ||
1607         SliceEndOffset < I->endOffset()) {
1608       assert(STy->isIntegerTy());
1609       STy = SplitIntTy;
1610     }
1611     if (!canConvertValue(DL, STy, SliceTy))
1612       return false;
1613   } else {
1614     return false;
1615   }
1616
1617   return true;
1618 }
1619
1620 /// \brief Test whether the given alloca partitioning and range of slices can be
1621 /// promoted to a vector.
1622 ///
1623 /// This is a quick test to check whether we can rewrite a particular alloca
1624 /// partition (and its newly formed alloca) into a vector alloca with only
1625 /// whole-vector loads and stores such that it could be promoted to a vector
1626 /// SSA value. We only can ensure this for a limited set of operations, and we
1627 /// don't want to do the rewrites unless we are confident that the result will
1628 /// be promotable, so we have an early test here.
1629 static bool
1630 isVectorPromotionViable(const DataLayout &DL, Type *AllocaTy, AllocaSlices &S,
1631                         uint64_t SliceBeginOffset, uint64_t SliceEndOffset,
1632                         AllocaSlices::const_iterator I,
1633                         AllocaSlices::const_iterator E,
1634                         ArrayRef<AllocaSlices::iterator> SplitUses) {
1635   VectorType *Ty = dyn_cast<VectorType>(AllocaTy);
1636   if (!Ty)
1637     return false;
1638
1639   uint64_t ElementSize = DL.getTypeSizeInBits(Ty->getScalarType());
1640
1641   // While the definition of LLVM vectors is bitpacked, we don't support sizes
1642   // that aren't byte sized.
1643   if (ElementSize % 8)
1644     return false;
1645   assert((DL.getTypeSizeInBits(Ty) % 8) == 0 &&
1646          "vector size not a multiple of element size?");
1647   ElementSize /= 8;
1648
1649   for (; I != E; ++I)
1650     if (!isVectorPromotionViableForSlice(DL, S, SliceBeginOffset,
1651                                          SliceEndOffset, Ty, ElementSize, I))
1652       return false;
1653
1654   for (ArrayRef<AllocaSlices::iterator>::const_iterator SUI = SplitUses.begin(),
1655                                                         SUE = SplitUses.end();
1656        SUI != SUE; ++SUI)
1657     if (!isVectorPromotionViableForSlice(DL, S, SliceBeginOffset,
1658                                          SliceEndOffset, Ty, ElementSize, *SUI))
1659       return false;
1660
1661   return true;
1662 }
1663
1664 /// \brief Test whether a slice of an alloca is valid for integer widening.
1665 ///
1666 /// This implements the necessary checking for the \c isIntegerWideningViable
1667 /// test below on a single slice of the alloca.
1668 static bool isIntegerWideningViableForSlice(const DataLayout &DL,
1669                                             Type *AllocaTy,
1670                                             uint64_t AllocBeginOffset,
1671                                             uint64_t Size, AllocaSlices &S,
1672                                             AllocaSlices::const_iterator I,
1673                                             bool &WholeAllocaOp) {
1674   uint64_t RelBegin = I->beginOffset() - AllocBeginOffset;
1675   uint64_t RelEnd = I->endOffset() - AllocBeginOffset;
1676
1677   // We can't reasonably handle cases where the load or store extends past
1678   // the end of the aloca's type and into its padding.
1679   if (RelEnd > Size)
1680     return false;
1681
1682   Use *U = I->getUse();
1683
1684   if (LoadInst *LI = dyn_cast<LoadInst>(U->getUser())) {
1685     if (LI->isVolatile())
1686       return false;
1687     if (RelBegin == 0 && RelEnd == Size)
1688       WholeAllocaOp = true;
1689     if (IntegerType *ITy = dyn_cast<IntegerType>(LI->getType())) {
1690       if (ITy->getBitWidth() < DL.getTypeStoreSizeInBits(ITy))
1691         return false;
1692     } else if (RelBegin != 0 || RelEnd != Size ||
1693                !canConvertValue(DL, AllocaTy, LI->getType())) {
1694       // Non-integer loads need to be convertible from the alloca type so that
1695       // they are promotable.
1696       return false;
1697     }
1698   } else if (StoreInst *SI = dyn_cast<StoreInst>(U->getUser())) {
1699     Type *ValueTy = SI->getValueOperand()->getType();
1700     if (SI->isVolatile())
1701       return false;
1702     if (RelBegin == 0 && RelEnd == Size)
1703       WholeAllocaOp = true;
1704     if (IntegerType *ITy = dyn_cast<IntegerType>(ValueTy)) {
1705       if (ITy->getBitWidth() < DL.getTypeStoreSizeInBits(ITy))
1706         return false;
1707     } else if (RelBegin != 0 || RelEnd != Size ||
1708                !canConvertValue(DL, ValueTy, AllocaTy)) {
1709       // Non-integer stores need to be convertible to the alloca type so that
1710       // they are promotable.
1711       return false;
1712     }
1713   } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(U->getUser())) {
1714     if (MI->isVolatile() || !isa<Constant>(MI->getLength()))
1715       return false;
1716     if (!I->isSplittable())
1717       return false; // Skip any unsplittable intrinsics.
1718   } else if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(U->getUser())) {
1719     if (II->getIntrinsicID() != Intrinsic::lifetime_start &&
1720         II->getIntrinsicID() != Intrinsic::lifetime_end)
1721       return false;
1722   } else {
1723     return false;
1724   }
1725
1726   return true;
1727 }
1728
1729 /// \brief Test whether the given alloca partition's integer operations can be
1730 /// widened to promotable ones.
1731 ///
1732 /// This is a quick test to check whether we can rewrite the integer loads and
1733 /// stores to a particular alloca into wider loads and stores and be able to
1734 /// promote the resulting alloca.
1735 static bool
1736 isIntegerWideningViable(const DataLayout &DL, Type *AllocaTy,
1737                         uint64_t AllocBeginOffset, AllocaSlices &S,
1738                         AllocaSlices::const_iterator I,
1739                         AllocaSlices::const_iterator E,
1740                         ArrayRef<AllocaSlices::iterator> SplitUses) {
1741   uint64_t SizeInBits = DL.getTypeSizeInBits(AllocaTy);
1742   // Don't create integer types larger than the maximum bitwidth.
1743   if (SizeInBits > IntegerType::MAX_INT_BITS)
1744     return false;
1745
1746   // Don't try to handle allocas with bit-padding.
1747   if (SizeInBits != DL.getTypeStoreSizeInBits(AllocaTy))
1748     return false;
1749
1750   // We need to ensure that an integer type with the appropriate bitwidth can
1751   // be converted to the alloca type, whatever that is. We don't want to force
1752   // the alloca itself to have an integer type if there is a more suitable one.
1753   Type *IntTy = Type::getIntNTy(AllocaTy->getContext(), SizeInBits);
1754   if (!canConvertValue(DL, AllocaTy, IntTy) ||
1755       !canConvertValue(DL, IntTy, AllocaTy))
1756     return false;
1757
1758   uint64_t Size = DL.getTypeStoreSize(AllocaTy);
1759
1760   // While examining uses, we ensure that the alloca has a covering load or
1761   // store. We don't want to widen the integer operations only to fail to
1762   // promote due to some other unsplittable entry (which we may make splittable
1763   // later). However, if there are only splittable uses, go ahead and assume
1764   // that we cover the alloca.
1765   bool WholeAllocaOp = (I != E) ? false : DL.isLegalInteger(SizeInBits);
1766
1767   for (; I != E; ++I)
1768     if (!isIntegerWideningViableForSlice(DL, AllocaTy, AllocBeginOffset, Size,
1769                                          S, I, WholeAllocaOp))
1770       return false;
1771
1772   for (ArrayRef<AllocaSlices::iterator>::const_iterator SUI = SplitUses.begin(),
1773                                                         SUE = SplitUses.end();
1774        SUI != SUE; ++SUI)
1775     if (!isIntegerWideningViableForSlice(DL, AllocaTy, AllocBeginOffset, Size,
1776                                          S, *SUI, WholeAllocaOp))
1777       return false;
1778
1779   return WholeAllocaOp;
1780 }
1781
1782 static Value *extractInteger(const DataLayout &DL, IRBuilderTy &IRB, Value *V,
1783                              IntegerType *Ty, uint64_t Offset,
1784                              const Twine &Name) {
1785   DEBUG(dbgs() << "       start: " << *V << "\n");
1786   IntegerType *IntTy = cast<IntegerType>(V->getType());
1787   assert(DL.getTypeStoreSize(Ty) + Offset <= DL.getTypeStoreSize(IntTy) &&
1788          "Element extends past full value");
1789   uint64_t ShAmt = 8*Offset;
1790   if (DL.isBigEndian())
1791     ShAmt = 8*(DL.getTypeStoreSize(IntTy) - DL.getTypeStoreSize(Ty) - Offset);
1792   if (ShAmt) {
1793     V = IRB.CreateLShr(V, ShAmt, Name + ".shift");
1794     DEBUG(dbgs() << "     shifted: " << *V << "\n");
1795   }
1796   assert(Ty->getBitWidth() <= IntTy->getBitWidth() &&
1797          "Cannot extract to a larger integer!");
1798   if (Ty != IntTy) {
1799     V = IRB.CreateTrunc(V, Ty, Name + ".trunc");
1800     DEBUG(dbgs() << "     trunced: " << *V << "\n");
1801   }
1802   return V;
1803 }
1804
1805 static Value *insertInteger(const DataLayout &DL, IRBuilderTy &IRB, Value *Old,
1806                             Value *V, uint64_t Offset, const Twine &Name) {
1807   IntegerType *IntTy = cast<IntegerType>(Old->getType());
1808   IntegerType *Ty = cast<IntegerType>(V->getType());
1809   assert(Ty->getBitWidth() <= IntTy->getBitWidth() &&
1810          "Cannot insert a larger integer!");
1811   DEBUG(dbgs() << "       start: " << *V << "\n");
1812   if (Ty != IntTy) {
1813     V = IRB.CreateZExt(V, IntTy, Name + ".ext");
1814     DEBUG(dbgs() << "    extended: " << *V << "\n");
1815   }
1816   assert(DL.getTypeStoreSize(Ty) + Offset <= DL.getTypeStoreSize(IntTy) &&
1817          "Element store outside of alloca store");
1818   uint64_t ShAmt = 8*Offset;
1819   if (DL.isBigEndian())
1820     ShAmt = 8*(DL.getTypeStoreSize(IntTy) - DL.getTypeStoreSize(Ty) - Offset);
1821   if (ShAmt) {
1822     V = IRB.CreateShl(V, ShAmt, Name + ".shift");
1823     DEBUG(dbgs() << "     shifted: " << *V << "\n");
1824   }
1825
1826   if (ShAmt || Ty->getBitWidth() < IntTy->getBitWidth()) {
1827     APInt Mask = ~Ty->getMask().zext(IntTy->getBitWidth()).shl(ShAmt);
1828     Old = IRB.CreateAnd(Old, Mask, Name + ".mask");
1829     DEBUG(dbgs() << "      masked: " << *Old << "\n");
1830     V = IRB.CreateOr(Old, V, Name + ".insert");
1831     DEBUG(dbgs() << "    inserted: " << *V << "\n");
1832   }
1833   return V;
1834 }
1835
1836 static Value *extractVector(IRBuilderTy &IRB, Value *V,
1837                             unsigned BeginIndex, unsigned EndIndex,
1838                             const Twine &Name) {
1839   VectorType *VecTy = cast<VectorType>(V->getType());
1840   unsigned NumElements = EndIndex - BeginIndex;
1841   assert(NumElements <= VecTy->getNumElements() && "Too many elements!");
1842
1843   if (NumElements == VecTy->getNumElements())
1844     return V;
1845
1846   if (NumElements == 1) {
1847     V = IRB.CreateExtractElement(V, IRB.getInt32(BeginIndex),
1848                                  Name + ".extract");
1849     DEBUG(dbgs() << "     extract: " << *V << "\n");
1850     return V;
1851   }
1852
1853   SmallVector<Constant*, 8> Mask;
1854   Mask.reserve(NumElements);
1855   for (unsigned i = BeginIndex; i != EndIndex; ++i)
1856     Mask.push_back(IRB.getInt32(i));
1857   V = IRB.CreateShuffleVector(V, UndefValue::get(V->getType()),
1858                               ConstantVector::get(Mask),
1859                               Name + ".extract");
1860   DEBUG(dbgs() << "     shuffle: " << *V << "\n");
1861   return V;
1862 }
1863
1864 static Value *insertVector(IRBuilderTy &IRB, Value *Old, Value *V,
1865                            unsigned BeginIndex, const Twine &Name) {
1866   VectorType *VecTy = cast<VectorType>(Old->getType());
1867   assert(VecTy && "Can only insert a vector into a vector");
1868
1869   VectorType *Ty = dyn_cast<VectorType>(V->getType());
1870   if (!Ty) {
1871     // Single element to insert.
1872     V = IRB.CreateInsertElement(Old, V, IRB.getInt32(BeginIndex),
1873                                 Name + ".insert");
1874     DEBUG(dbgs() <<  "     insert: " << *V << "\n");
1875     return V;
1876   }
1877
1878   assert(Ty->getNumElements() <= VecTy->getNumElements() &&
1879          "Too many elements!");
1880   if (Ty->getNumElements() == VecTy->getNumElements()) {
1881     assert(V->getType() == VecTy && "Vector type mismatch");
1882     return V;
1883   }
1884   unsigned EndIndex = BeginIndex + Ty->getNumElements();
1885
1886   // When inserting a smaller vector into the larger to store, we first
1887   // use a shuffle vector to widen it with undef elements, and then
1888   // a second shuffle vector to select between the loaded vector and the
1889   // incoming vector.
1890   SmallVector<Constant*, 8> Mask;
1891   Mask.reserve(VecTy->getNumElements());
1892   for (unsigned i = 0; i != VecTy->getNumElements(); ++i)
1893     if (i >= BeginIndex && i < EndIndex)
1894       Mask.push_back(IRB.getInt32(i - BeginIndex));
1895     else
1896       Mask.push_back(UndefValue::get(IRB.getInt32Ty()));
1897   V = IRB.CreateShuffleVector(V, UndefValue::get(V->getType()),
1898                               ConstantVector::get(Mask),
1899                               Name + ".expand");
1900   DEBUG(dbgs() << "    shuffle: " << *V << "\n");
1901
1902   Mask.clear();
1903   for (unsigned i = 0; i != VecTy->getNumElements(); ++i)
1904     Mask.push_back(IRB.getInt1(i >= BeginIndex && i < EndIndex));
1905
1906   V = IRB.CreateSelect(ConstantVector::get(Mask), V, Old, Name + "blend");
1907
1908   DEBUG(dbgs() << "    blend: " << *V << "\n");
1909   return V;
1910 }
1911
1912 namespace {
1913 /// \brief Visitor to rewrite instructions using p particular slice of an alloca
1914 /// to use a new alloca.
1915 ///
1916 /// Also implements the rewriting to vector-based accesses when the partition
1917 /// passes the isVectorPromotionViable predicate. Most of the rewriting logic
1918 /// lives here.
1919 class AllocaSliceRewriter : public InstVisitor<AllocaSliceRewriter, bool> {
1920   // Befriend the base class so it can delegate to private visit methods.
1921   friend class llvm::InstVisitor<AllocaSliceRewriter, bool>;
1922   typedef llvm::InstVisitor<AllocaSliceRewriter, bool> Base;
1923
1924   const DataLayout &DL;
1925   AllocaSlices &S;
1926   SROA &Pass;
1927   AllocaInst &OldAI, &NewAI;
1928   const uint64_t NewAllocaBeginOffset, NewAllocaEndOffset;
1929   Type *NewAllocaTy;
1930
1931   // If we are rewriting an alloca partition which can be written as pure
1932   // vector operations, we stash extra information here. When VecTy is
1933   // non-null, we have some strict guarantees about the rewritten alloca:
1934   //   - The new alloca is exactly the size of the vector type here.
1935   //   - The accesses all either map to the entire vector or to a single
1936   //     element.
1937   //   - The set of accessing instructions is only one of those handled above
1938   //     in isVectorPromotionViable. Generally these are the same access kinds
1939   //     which are promotable via mem2reg.
1940   VectorType *VecTy;
1941   Type *ElementTy;
1942   uint64_t ElementSize;
1943
1944   // This is a convenience and flag variable that will be null unless the new
1945   // alloca's integer operations should be widened to this integer type due to
1946   // passing isIntegerWideningViable above. If it is non-null, the desired
1947   // integer type will be stored here for easy access during rewriting.
1948   IntegerType *IntTy;
1949
1950   // The offset of the slice currently being rewritten.
1951   uint64_t BeginOffset, EndOffset;
1952   bool IsSplittable;
1953   bool IsSplit;
1954   Use *OldUse;
1955   Instruction *OldPtr;
1956
1957   // Output members carrying state about the result of visiting and rewriting
1958   // the slice of the alloca.
1959   bool IsUsedByRewrittenSpeculatableInstructions;
1960
1961   // Utility IR builder, whose name prefix is setup for each visited use, and
1962   // the insertion point is set to point to the user.
1963   IRBuilderTy IRB;
1964
1965 public:
1966   AllocaSliceRewriter(const DataLayout &DL, AllocaSlices &S, SROA &Pass,
1967                       AllocaInst &OldAI, AllocaInst &NewAI,
1968                       uint64_t NewBeginOffset, uint64_t NewEndOffset,
1969                       bool IsVectorPromotable = false,
1970                       bool IsIntegerPromotable = false)
1971       : DL(DL), S(S), Pass(Pass), OldAI(OldAI), NewAI(NewAI),
1972         NewAllocaBeginOffset(NewBeginOffset), NewAllocaEndOffset(NewEndOffset),
1973         NewAllocaTy(NewAI.getAllocatedType()),
1974         VecTy(IsVectorPromotable ? cast<VectorType>(NewAllocaTy) : 0),
1975         ElementTy(VecTy ? VecTy->getElementType() : 0),
1976         ElementSize(VecTy ? DL.getTypeSizeInBits(ElementTy) / 8 : 0),
1977         IntTy(IsIntegerPromotable
1978                   ? Type::getIntNTy(
1979                         NewAI.getContext(),
1980                         DL.getTypeSizeInBits(NewAI.getAllocatedType()))
1981                   : 0),
1982         BeginOffset(), EndOffset(), IsSplittable(), IsSplit(), OldUse(),
1983         OldPtr(), IsUsedByRewrittenSpeculatableInstructions(false),
1984         IRB(NewAI.getContext(), ConstantFolder()) {
1985     if (VecTy) {
1986       assert((DL.getTypeSizeInBits(ElementTy) % 8) == 0 &&
1987              "Only multiple-of-8 sized vector elements are viable");
1988       ++NumVectorized;
1989     }
1990     assert((!IsVectorPromotable && !IsIntegerPromotable) ||
1991            IsVectorPromotable != IsIntegerPromotable);
1992   }
1993
1994   bool visit(AllocaSlices::const_iterator I) {
1995     bool CanSROA = true;
1996     BeginOffset = I->beginOffset();
1997     EndOffset = I->endOffset();
1998     IsSplittable = I->isSplittable();
1999     IsSplit =
2000         BeginOffset < NewAllocaBeginOffset || EndOffset > NewAllocaEndOffset;
2001
2002     OldUse = I->getUse();
2003     OldPtr = cast<Instruction>(OldUse->get());
2004
2005     Instruction *OldUserI = cast<Instruction>(OldUse->getUser());
2006     IRB.SetInsertPoint(OldUserI);
2007     IRB.SetCurrentDebugLocation(OldUserI->getDebugLoc());
2008     IRB.SetNamePrefix(Twine(NewAI.getName()) + "." + Twine(BeginOffset) + ".");
2009
2010     CanSROA &= visit(cast<Instruction>(OldUse->getUser()));
2011     if (VecTy || IntTy)
2012       assert(CanSROA);
2013     return CanSROA;
2014   }
2015
2016   /// \brief Query whether this slice is used by speculatable instructions after
2017   /// rewriting.
2018   ///
2019   /// These instructions (PHIs and Selects currently) require the alloca slice
2020   /// to run back through the rewriter. Thus, they are promotable, but not on
2021   /// this iteration. This is distinct from a slice which is unpromotable for
2022   /// some other reason, in which case we don't even want to perform the
2023   /// speculation. This can be querried at any time and reflects whether (at
2024   /// that point) a visit call has rewritten a speculatable instruction on the
2025   /// current slice.
2026   bool isUsedByRewrittenSpeculatableInstructions() const {
2027     return IsUsedByRewrittenSpeculatableInstructions;
2028   }
2029
2030 private:
2031   // Make sure the other visit overloads are visible.
2032   using Base::visit;
2033
2034   // Every instruction which can end up as a user must have a rewrite rule.
2035   bool visitInstruction(Instruction &I) {
2036     DEBUG(dbgs() << "    !!!! Cannot rewrite: " << I << "\n");
2037     llvm_unreachable("No rewrite rule for this instruction!");
2038   }
2039
2040   Value *getAdjustedAllocaPtr(IRBuilderTy &IRB, uint64_t Offset,
2041                               Type *PointerTy) {
2042     assert(Offset >= NewAllocaBeginOffset);
2043     return getAdjustedPtr(IRB, DL, &NewAI, APInt(DL.getPointerSizeInBits(),
2044                                                  Offset - NewAllocaBeginOffset),
2045                           PointerTy);
2046   }
2047
2048   /// \brief Compute suitable alignment to access an offset into the new alloca.
2049   unsigned getOffsetAlign(uint64_t Offset) {
2050     unsigned NewAIAlign = NewAI.getAlignment();
2051     if (!NewAIAlign)
2052       NewAIAlign = DL.getABITypeAlignment(NewAI.getAllocatedType());
2053     return MinAlign(NewAIAlign, Offset);
2054   }
2055
2056   /// \brief Compute suitable alignment to access a type at an offset of the
2057   /// new alloca.
2058   ///
2059   /// \returns zero if the type's ABI alignment is a suitable alignment,
2060   /// otherwise returns the maximal suitable alignment.
2061   unsigned getOffsetTypeAlign(Type *Ty, uint64_t Offset) {
2062     unsigned Align = getOffsetAlign(Offset);
2063     return Align == DL.getABITypeAlignment(Ty) ? 0 : Align;
2064   }
2065
2066   unsigned getIndex(uint64_t Offset) {
2067     assert(VecTy && "Can only call getIndex when rewriting a vector");
2068     uint64_t RelOffset = Offset - NewAllocaBeginOffset;
2069     assert(RelOffset / ElementSize < UINT32_MAX && "Index out of bounds");
2070     uint32_t Index = RelOffset / ElementSize;
2071     assert(Index * ElementSize == RelOffset);
2072     return Index;
2073   }
2074
2075   void deleteIfTriviallyDead(Value *V) {
2076     Instruction *I = cast<Instruction>(V);
2077     if (isInstructionTriviallyDead(I))
2078       Pass.DeadInsts.insert(I);
2079   }
2080
2081   Value *rewriteVectorizedLoadInst(uint64_t NewBeginOffset,
2082                                    uint64_t NewEndOffset) {
2083     unsigned BeginIndex = getIndex(NewBeginOffset);
2084     unsigned EndIndex = getIndex(NewEndOffset);
2085     assert(EndIndex > BeginIndex && "Empty vector!");
2086
2087     Value *V = IRB.CreateAlignedLoad(&NewAI, NewAI.getAlignment(),
2088                                      "load");
2089     return extractVector(IRB, V, BeginIndex, EndIndex, "vec");
2090   }
2091
2092   Value *rewriteIntegerLoad(LoadInst &LI, uint64_t NewBeginOffset,
2093                             uint64_t NewEndOffset) {
2094     assert(IntTy && "We cannot insert an integer to the alloca");
2095     assert(!LI.isVolatile());
2096     Value *V = IRB.CreateAlignedLoad(&NewAI, NewAI.getAlignment(),
2097                                      "load");
2098     V = convertValue(DL, IRB, V, IntTy);
2099     assert(NewBeginOffset >= NewAllocaBeginOffset && "Out of bounds offset");
2100     uint64_t Offset = NewBeginOffset - NewAllocaBeginOffset;
2101     if (Offset > 0 || NewEndOffset < NewAllocaEndOffset)
2102       V = extractInteger(DL, IRB, V, cast<IntegerType>(LI.getType()), Offset,
2103                          "extract");
2104     return V;
2105   }
2106
2107   bool visitLoadInst(LoadInst &LI) {
2108     DEBUG(dbgs() << "    original: " << LI << "\n");
2109     Value *OldOp = LI.getOperand(0);
2110     assert(OldOp == OldPtr);
2111
2112     // Compute the intersecting offset range.
2113     assert(BeginOffset < NewAllocaEndOffset);
2114     assert(EndOffset > NewAllocaBeginOffset);
2115     uint64_t NewBeginOffset = std::max(BeginOffset, NewAllocaBeginOffset);
2116     uint64_t NewEndOffset = std::min(EndOffset, NewAllocaEndOffset);
2117
2118     uint64_t Size = NewEndOffset - NewBeginOffset;
2119
2120     Type *TargetTy = IsSplit ? Type::getIntNTy(LI.getContext(), Size * 8)
2121                              : LI.getType();
2122     bool IsPtrAdjusted = false;
2123     Value *V;
2124     if (VecTy) {
2125       V = rewriteVectorizedLoadInst(NewBeginOffset, NewEndOffset);
2126     } else if (IntTy && LI.getType()->isIntegerTy()) {
2127       V = rewriteIntegerLoad(LI, NewBeginOffset, NewEndOffset);
2128     } else if (NewBeginOffset == NewAllocaBeginOffset &&
2129                canConvertValue(DL, NewAllocaTy, LI.getType())) {
2130       V = IRB.CreateAlignedLoad(&NewAI, NewAI.getAlignment(),
2131                                 LI.isVolatile(), "load");
2132     } else {
2133       Type *LTy = TargetTy->getPointerTo();
2134       V = IRB.CreateAlignedLoad(
2135           getAdjustedAllocaPtr(IRB, NewBeginOffset, LTy),
2136           getOffsetTypeAlign(TargetTy, NewBeginOffset - NewAllocaBeginOffset),
2137           LI.isVolatile(), "load");
2138       IsPtrAdjusted = true;
2139     }
2140     V = convertValue(DL, IRB, V, TargetTy);
2141
2142     if (IsSplit) {
2143       assert(!LI.isVolatile());
2144       assert(LI.getType()->isIntegerTy() &&
2145              "Only integer type loads and stores are split");
2146       assert(Size < DL.getTypeStoreSize(LI.getType()) &&
2147              "Split load isn't smaller than original load");
2148       assert(LI.getType()->getIntegerBitWidth() ==
2149              DL.getTypeStoreSizeInBits(LI.getType()) &&
2150              "Non-byte-multiple bit width");
2151       // Move the insertion point just past the load so that we can refer to it.
2152       IRB.SetInsertPoint(llvm::next(BasicBlock::iterator(&LI)));
2153       // Create a placeholder value with the same type as LI to use as the
2154       // basis for the new value. This allows us to replace the uses of LI with
2155       // the computed value, and then replace the placeholder with LI, leaving
2156       // LI only used for this computation.
2157       Value *Placeholder
2158         = new LoadInst(UndefValue::get(LI.getType()->getPointerTo()));
2159       V = insertInteger(DL, IRB, Placeholder, V, NewBeginOffset,
2160                         "insert");
2161       LI.replaceAllUsesWith(V);
2162       Placeholder->replaceAllUsesWith(&LI);
2163       delete Placeholder;
2164     } else {
2165       LI.replaceAllUsesWith(V);
2166     }
2167
2168     Pass.DeadInsts.insert(&LI);
2169     deleteIfTriviallyDead(OldOp);
2170     DEBUG(dbgs() << "          to: " << *V << "\n");
2171     return !LI.isVolatile() && !IsPtrAdjusted;
2172   }
2173
2174   bool rewriteVectorizedStoreInst(Value *V, StoreInst &SI, Value *OldOp,
2175                                   uint64_t NewBeginOffset,
2176                                   uint64_t NewEndOffset) {
2177     if (V->getType() != VecTy) {
2178       unsigned BeginIndex = getIndex(NewBeginOffset);
2179       unsigned EndIndex = getIndex(NewEndOffset);
2180       assert(EndIndex > BeginIndex && "Empty vector!");
2181       unsigned NumElements = EndIndex - BeginIndex;
2182       assert(NumElements <= VecTy->getNumElements() && "Too many elements!");
2183       Type *SliceTy =
2184           (NumElements == 1) ? ElementTy
2185                              : VectorType::get(ElementTy, NumElements);
2186       if (V->getType() != SliceTy)
2187         V = convertValue(DL, IRB, V, SliceTy);
2188
2189       // Mix in the existing elements.
2190       Value *Old = IRB.CreateAlignedLoad(&NewAI, NewAI.getAlignment(),
2191                                          "load");
2192       V = insertVector(IRB, Old, V, BeginIndex, "vec");
2193     }
2194     StoreInst *Store = IRB.CreateAlignedStore(V, &NewAI, NewAI.getAlignment());
2195     Pass.DeadInsts.insert(&SI);
2196
2197     (void)Store;
2198     DEBUG(dbgs() << "          to: " << *Store << "\n");
2199     return true;
2200   }
2201
2202   bool rewriteIntegerStore(Value *V, StoreInst &SI,
2203                            uint64_t NewBeginOffset, uint64_t NewEndOffset) {
2204     assert(IntTy && "We cannot extract an integer from the alloca");
2205     assert(!SI.isVolatile());
2206     if (DL.getTypeSizeInBits(V->getType()) != IntTy->getBitWidth()) {
2207       Value *Old = IRB.CreateAlignedLoad(&NewAI, NewAI.getAlignment(),
2208                                          "oldload");
2209       Old = convertValue(DL, IRB, Old, IntTy);
2210       assert(BeginOffset >= NewAllocaBeginOffset && "Out of bounds offset");
2211       uint64_t Offset = BeginOffset - NewAllocaBeginOffset;
2212       V = insertInteger(DL, IRB, Old, SI.getValueOperand(), Offset,
2213                         "insert");
2214     }
2215     V = convertValue(DL, IRB, V, NewAllocaTy);
2216     StoreInst *Store = IRB.CreateAlignedStore(V, &NewAI, NewAI.getAlignment());
2217     Pass.DeadInsts.insert(&SI);
2218     (void)Store;
2219     DEBUG(dbgs() << "          to: " << *Store << "\n");
2220     return true;
2221   }
2222
2223   bool visitStoreInst(StoreInst &SI) {
2224     DEBUG(dbgs() << "    original: " << SI << "\n");
2225     Value *OldOp = SI.getOperand(1);
2226     assert(OldOp == OldPtr);
2227
2228     Value *V = SI.getValueOperand();
2229
2230     // Strip all inbounds GEPs and pointer casts to try to dig out any root
2231     // alloca that should be re-examined after promoting this alloca.
2232     if (V->getType()->isPointerTy())
2233       if (AllocaInst *AI = dyn_cast<AllocaInst>(V->stripInBoundsOffsets()))
2234         Pass.PostPromotionWorklist.insert(AI);
2235
2236     // Compute the intersecting offset range.
2237     assert(BeginOffset < NewAllocaEndOffset);
2238     assert(EndOffset > NewAllocaBeginOffset);
2239     uint64_t NewBeginOffset = std::max(BeginOffset, NewAllocaBeginOffset);
2240     uint64_t NewEndOffset = std::min(EndOffset, NewAllocaEndOffset);
2241
2242     uint64_t Size = NewEndOffset - NewBeginOffset;
2243     if (Size < DL.getTypeStoreSize(V->getType())) {
2244       assert(!SI.isVolatile());
2245       assert(V->getType()->isIntegerTy() &&
2246              "Only integer type loads and stores are split");
2247       assert(V->getType()->getIntegerBitWidth() ==
2248              DL.getTypeStoreSizeInBits(V->getType()) &&
2249              "Non-byte-multiple bit width");
2250       IntegerType *NarrowTy = Type::getIntNTy(SI.getContext(), Size * 8);
2251       V = extractInteger(DL, IRB, V, NarrowTy, NewBeginOffset,
2252                          "extract");
2253     }
2254
2255     if (VecTy)
2256       return rewriteVectorizedStoreInst(V, SI, OldOp, NewBeginOffset,
2257                                         NewEndOffset);
2258     if (IntTy && V->getType()->isIntegerTy())
2259       return rewriteIntegerStore(V, SI, NewBeginOffset, NewEndOffset);
2260
2261     StoreInst *NewSI;
2262     if (NewBeginOffset == NewAllocaBeginOffset &&
2263         NewEndOffset == NewAllocaEndOffset &&
2264         canConvertValue(DL, V->getType(), NewAllocaTy)) {
2265       V = convertValue(DL, IRB, V, NewAllocaTy);
2266       NewSI = IRB.CreateAlignedStore(V, &NewAI, NewAI.getAlignment(),
2267                                      SI.isVolatile());
2268     } else {
2269       Value *NewPtr = getAdjustedAllocaPtr(IRB, NewBeginOffset,
2270                                            V->getType()->getPointerTo());
2271       NewSI = IRB.CreateAlignedStore(
2272           V, NewPtr, getOffsetTypeAlign(
2273                          V->getType(), NewBeginOffset - NewAllocaBeginOffset),
2274           SI.isVolatile());
2275     }
2276     (void)NewSI;
2277     Pass.DeadInsts.insert(&SI);
2278     deleteIfTriviallyDead(OldOp);
2279
2280     DEBUG(dbgs() << "          to: " << *NewSI << "\n");
2281     return NewSI->getPointerOperand() == &NewAI && !SI.isVolatile();
2282   }
2283
2284   /// \brief Compute an integer value from splatting an i8 across the given
2285   /// number of bytes.
2286   ///
2287   /// Note that this routine assumes an i8 is a byte. If that isn't true, don't
2288   /// call this routine.
2289   /// FIXME: Heed the advice above.
2290   ///
2291   /// \param V The i8 value to splat.
2292   /// \param Size The number of bytes in the output (assuming i8 is one byte)
2293   Value *getIntegerSplat(Value *V, unsigned Size) {
2294     assert(Size > 0 && "Expected a positive number of bytes.");
2295     IntegerType *VTy = cast<IntegerType>(V->getType());
2296     assert(VTy->getBitWidth() == 8 && "Expected an i8 value for the byte");
2297     if (Size == 1)
2298       return V;
2299
2300     Type *SplatIntTy = Type::getIntNTy(VTy->getContext(), Size*8);
2301     V = IRB.CreateMul(IRB.CreateZExt(V, SplatIntTy, "zext"),
2302                       ConstantExpr::getUDiv(
2303                         Constant::getAllOnesValue(SplatIntTy),
2304                         ConstantExpr::getZExt(
2305                           Constant::getAllOnesValue(V->getType()),
2306                           SplatIntTy)),
2307                       "isplat");
2308     return V;
2309   }
2310
2311   /// \brief Compute a vector splat for a given element value.
2312   Value *getVectorSplat(Value *V, unsigned NumElements) {
2313     V = IRB.CreateVectorSplat(NumElements, V, "vsplat");
2314     DEBUG(dbgs() << "       splat: " << *V << "\n");
2315     return V;
2316   }
2317
2318   bool visitMemSetInst(MemSetInst &II) {
2319     DEBUG(dbgs() << "    original: " << II << "\n");
2320     assert(II.getRawDest() == OldPtr);
2321
2322     // If the memset has a variable size, it cannot be split, just adjust the
2323     // pointer to the new alloca.
2324     if (!isa<Constant>(II.getLength())) {
2325       assert(!IsSplit);
2326       assert(BeginOffset >= NewAllocaBeginOffset);
2327       II.setDest(
2328           getAdjustedAllocaPtr(IRB, BeginOffset, II.getRawDest()->getType()));
2329       Type *CstTy = II.getAlignmentCst()->getType();
2330       II.setAlignment(ConstantInt::get(CstTy, getOffsetAlign(BeginOffset)));
2331
2332       deleteIfTriviallyDead(OldPtr);
2333       return false;
2334     }
2335
2336     // Record this instruction for deletion.
2337     Pass.DeadInsts.insert(&II);
2338
2339     Type *AllocaTy = NewAI.getAllocatedType();
2340     Type *ScalarTy = AllocaTy->getScalarType();
2341
2342     // Compute the intersecting offset range.
2343     assert(BeginOffset < NewAllocaEndOffset);
2344     assert(EndOffset > NewAllocaBeginOffset);
2345     uint64_t NewBeginOffset = std::max(BeginOffset, NewAllocaBeginOffset);
2346     uint64_t NewEndOffset = std::min(EndOffset, NewAllocaEndOffset);
2347     uint64_t SliceOffset = NewBeginOffset - NewAllocaBeginOffset;
2348
2349     // If this doesn't map cleanly onto the alloca type, and that type isn't
2350     // a single value type, just emit a memset.
2351     if (!VecTy && !IntTy &&
2352         (BeginOffset > NewAllocaBeginOffset ||
2353          EndOffset < NewAllocaEndOffset ||
2354          !AllocaTy->isSingleValueType() ||
2355          !DL.isLegalInteger(DL.getTypeSizeInBits(ScalarTy)) ||
2356          DL.getTypeSizeInBits(ScalarTy)%8 != 0)) {
2357       Type *SizeTy = II.getLength()->getType();
2358       Constant *Size = ConstantInt::get(SizeTy, NewEndOffset - NewBeginOffset);
2359       CallInst *New = IRB.CreateMemSet(
2360           getAdjustedAllocaPtr(IRB, NewBeginOffset, II.getRawDest()->getType()),
2361           II.getValue(), Size, getOffsetAlign(SliceOffset), II.isVolatile());
2362       (void)New;
2363       DEBUG(dbgs() << "          to: " << *New << "\n");
2364       return false;
2365     }
2366
2367     // If we can represent this as a simple value, we have to build the actual
2368     // value to store, which requires expanding the byte present in memset to
2369     // a sensible representation for the alloca type. This is essentially
2370     // splatting the byte to a sufficiently wide integer, splatting it across
2371     // any desired vector width, and bitcasting to the final type.
2372     Value *V;
2373
2374     if (VecTy) {
2375       // If this is a memset of a vectorized alloca, insert it.
2376       assert(ElementTy == ScalarTy);
2377
2378       unsigned BeginIndex = getIndex(NewBeginOffset);
2379       unsigned EndIndex = getIndex(NewEndOffset);
2380       assert(EndIndex > BeginIndex && "Empty vector!");
2381       unsigned NumElements = EndIndex - BeginIndex;
2382       assert(NumElements <= VecTy->getNumElements() && "Too many elements!");
2383
2384       Value *Splat =
2385           getIntegerSplat(II.getValue(), DL.getTypeSizeInBits(ElementTy) / 8);
2386       Splat = convertValue(DL, IRB, Splat, ElementTy);
2387       if (NumElements > 1)
2388         Splat = getVectorSplat(Splat, NumElements);
2389
2390       Value *Old = IRB.CreateAlignedLoad(&NewAI, NewAI.getAlignment(),
2391                                          "oldload");
2392       V = insertVector(IRB, Old, Splat, BeginIndex, "vec");
2393     } else if (IntTy) {
2394       // If this is a memset on an alloca where we can widen stores, insert the
2395       // set integer.
2396       assert(!II.isVolatile());
2397
2398       uint64_t Size = NewEndOffset - NewBeginOffset;
2399       V = getIntegerSplat(II.getValue(), Size);
2400
2401       if (IntTy && (BeginOffset != NewAllocaBeginOffset ||
2402                     EndOffset != NewAllocaBeginOffset)) {
2403         Value *Old = IRB.CreateAlignedLoad(&NewAI, NewAI.getAlignment(),
2404                                            "oldload");
2405         Old = convertValue(DL, IRB, Old, IntTy);
2406         uint64_t Offset = NewBeginOffset - NewAllocaBeginOffset;
2407         V = insertInteger(DL, IRB, Old, V, Offset, "insert");
2408       } else {
2409         assert(V->getType() == IntTy &&
2410                "Wrong type for an alloca wide integer!");
2411       }
2412       V = convertValue(DL, IRB, V, AllocaTy);
2413     } else {
2414       // Established these invariants above.
2415       assert(NewBeginOffset == NewAllocaBeginOffset);
2416       assert(NewEndOffset == NewAllocaEndOffset);
2417
2418       V = getIntegerSplat(II.getValue(), DL.getTypeSizeInBits(ScalarTy) / 8);
2419       if (VectorType *AllocaVecTy = dyn_cast<VectorType>(AllocaTy))
2420         V = getVectorSplat(V, AllocaVecTy->getNumElements());
2421
2422       V = convertValue(DL, IRB, V, AllocaTy);
2423     }
2424
2425     Value *New = IRB.CreateAlignedStore(V, &NewAI, NewAI.getAlignment(),
2426                                         II.isVolatile());
2427     (void)New;
2428     DEBUG(dbgs() << "          to: " << *New << "\n");
2429     return !II.isVolatile();
2430   }
2431
2432   bool visitMemTransferInst(MemTransferInst &II) {
2433     // Rewriting of memory transfer instructions can be a bit tricky. We break
2434     // them into two categories: split intrinsics and unsplit intrinsics.
2435
2436     DEBUG(dbgs() << "    original: " << II << "\n");
2437
2438     // Compute the intersecting offset range.
2439     assert(BeginOffset < NewAllocaEndOffset);
2440     assert(EndOffset > NewAllocaBeginOffset);
2441     uint64_t NewBeginOffset = std::max(BeginOffset, NewAllocaBeginOffset);
2442     uint64_t NewEndOffset = std::min(EndOffset, NewAllocaEndOffset);
2443
2444     assert(II.getRawSource() == OldPtr || II.getRawDest() == OldPtr);
2445     bool IsDest = II.getRawDest() == OldPtr;
2446
2447     // Compute the relative offset within the transfer.
2448     unsigned IntPtrWidth = DL.getPointerSizeInBits();
2449     APInt RelOffset(IntPtrWidth, NewBeginOffset - BeginOffset);
2450
2451     unsigned Align = II.getAlignment();
2452     uint64_t SliceOffset = NewBeginOffset - NewAllocaBeginOffset;
2453     if (Align > 1)
2454       Align =
2455           MinAlign(RelOffset.zextOrTrunc(64).getZExtValue(),
2456                    MinAlign(II.getAlignment(), getOffsetAlign(SliceOffset)));
2457
2458     // For unsplit intrinsics, we simply modify the source and destination
2459     // pointers in place. This isn't just an optimization, it is a matter of
2460     // correctness. With unsplit intrinsics we may be dealing with transfers
2461     // within a single alloca before SROA ran, or with transfers that have
2462     // a variable length. We may also be dealing with memmove instead of
2463     // memcpy, and so simply updating the pointers is the necessary for us to
2464     // update both source and dest of a single call.
2465     if (!IsSplittable) {
2466       Value *OldOp = IsDest ? II.getRawDest() : II.getRawSource();
2467       if (IsDest)
2468         II.setDest(
2469             getAdjustedAllocaPtr(IRB, BeginOffset, II.getRawDest()->getType()));
2470       else
2471         II.setSource(getAdjustedAllocaPtr(IRB, BeginOffset,
2472                                           II.getRawSource()->getType()));
2473
2474       Type *CstTy = II.getAlignmentCst()->getType();
2475       II.setAlignment(ConstantInt::get(CstTy, Align));
2476
2477       DEBUG(dbgs() << "          to: " << II << "\n");
2478       deleteIfTriviallyDead(OldOp);
2479       return false;
2480     }
2481     // For split transfer intrinsics we have an incredibly useful assurance:
2482     // the source and destination do not reside within the same alloca, and at
2483     // least one of them does not escape. This means that we can replace
2484     // memmove with memcpy, and we don't need to worry about all manner of
2485     // downsides to splitting and transforming the operations.
2486
2487     // If this doesn't map cleanly onto the alloca type, and that type isn't
2488     // a single value type, just emit a memcpy.
2489     bool EmitMemCpy
2490       = !VecTy && !IntTy && (BeginOffset > NewAllocaBeginOffset ||
2491                              EndOffset < NewAllocaEndOffset ||
2492                              !NewAI.getAllocatedType()->isSingleValueType());
2493
2494     // If we're just going to emit a memcpy, the alloca hasn't changed, and the
2495     // size hasn't been shrunk based on analysis of the viable range, this is
2496     // a no-op.
2497     if (EmitMemCpy && &OldAI == &NewAI) {
2498       // Ensure the start lines up.
2499       assert(NewBeginOffset == BeginOffset);
2500
2501       // Rewrite the size as needed.
2502       if (NewEndOffset != EndOffset)
2503         II.setLength(ConstantInt::get(II.getLength()->getType(),
2504                                       NewEndOffset - NewBeginOffset));
2505       return false;
2506     }
2507     // Record this instruction for deletion.
2508     Pass.DeadInsts.insert(&II);
2509
2510     // Strip all inbounds GEPs and pointer casts to try to dig out any root
2511     // alloca that should be re-examined after rewriting this instruction.
2512     Value *OtherPtr = IsDest ? II.getRawSource() : II.getRawDest();
2513     if (AllocaInst *AI
2514           = dyn_cast<AllocaInst>(OtherPtr->stripInBoundsOffsets())) {
2515       assert(AI != &OldAI && AI != &NewAI &&
2516              "Splittable transfers cannot reach the same alloca on both ends.");
2517       Pass.Worklist.insert(AI);
2518     }
2519
2520     if (EmitMemCpy) {
2521       Type *OtherPtrTy = OtherPtr->getType();
2522
2523       // Compute the other pointer, folding as much as possible to produce
2524       // a single, simple GEP in most cases.
2525       OtherPtr = getAdjustedPtr(IRB, DL, OtherPtr, RelOffset, OtherPtrTy);
2526
2527       Value *OurPtr = getAdjustedAllocaPtr(
2528           IRB, NewBeginOffset,
2529           IsDest ? II.getRawDest()->getType() : II.getRawSource()->getType());
2530       Type *SizeTy = II.getLength()->getType();
2531       Constant *Size = ConstantInt::get(SizeTy, NewEndOffset - NewBeginOffset);
2532
2533       CallInst *New = IRB.CreateMemCpy(IsDest ? OurPtr : OtherPtr,
2534                                        IsDest ? OtherPtr : OurPtr,
2535                                        Size, Align, II.isVolatile());
2536       (void)New;
2537       DEBUG(dbgs() << "          to: " << *New << "\n");
2538       return false;
2539     }
2540
2541     // Note that we clamp the alignment to 1 here as a 0 alignment for a memcpy
2542     // is equivalent to 1, but that isn't true if we end up rewriting this as
2543     // a load or store.
2544     if (!Align)
2545       Align = 1;
2546
2547     bool IsWholeAlloca = NewBeginOffset == NewAllocaBeginOffset &&
2548                          NewEndOffset == NewAllocaEndOffset;
2549     uint64_t Size = NewEndOffset - NewBeginOffset;
2550     unsigned BeginIndex = VecTy ? getIndex(NewBeginOffset) : 0;
2551     unsigned EndIndex = VecTy ? getIndex(NewEndOffset) : 0;
2552     unsigned NumElements = EndIndex - BeginIndex;
2553     IntegerType *SubIntTy
2554       = IntTy ? Type::getIntNTy(IntTy->getContext(), Size*8) : 0;
2555
2556     Type *OtherPtrTy = NewAI.getType();
2557     if (VecTy && !IsWholeAlloca) {
2558       if (NumElements == 1)
2559         OtherPtrTy = VecTy->getElementType();
2560       else
2561         OtherPtrTy = VectorType::get(VecTy->getElementType(), NumElements);
2562
2563       OtherPtrTy = OtherPtrTy->getPointerTo();
2564     } else if (IntTy && !IsWholeAlloca) {
2565       OtherPtrTy = SubIntTy->getPointerTo();
2566     }
2567
2568     Value *SrcPtr = getAdjustedPtr(IRB, DL, OtherPtr, RelOffset, OtherPtrTy);
2569     Value *DstPtr = &NewAI;
2570     if (!IsDest)
2571       std::swap(SrcPtr, DstPtr);
2572
2573     Value *Src;
2574     if (VecTy && !IsWholeAlloca && !IsDest) {
2575       Src = IRB.CreateAlignedLoad(&NewAI, NewAI.getAlignment(),
2576                                   "load");
2577       Src = extractVector(IRB, Src, BeginIndex, EndIndex, "vec");
2578     } else if (IntTy && !IsWholeAlloca && !IsDest) {
2579       Src = IRB.CreateAlignedLoad(&NewAI, NewAI.getAlignment(),
2580                                   "load");
2581       Src = convertValue(DL, IRB, Src, IntTy);
2582       uint64_t Offset = NewBeginOffset - NewAllocaBeginOffset;
2583       Src = extractInteger(DL, IRB, Src, SubIntTy, Offset, "extract");
2584     } else {
2585       Src = IRB.CreateAlignedLoad(SrcPtr, Align, II.isVolatile(),
2586                                   "copyload");
2587     }
2588
2589     if (VecTy && !IsWholeAlloca && IsDest) {
2590       Value *Old = IRB.CreateAlignedLoad(&NewAI, NewAI.getAlignment(),
2591                                          "oldload");
2592       Src = insertVector(IRB, Old, Src, BeginIndex, "vec");
2593     } else if (IntTy && !IsWholeAlloca && IsDest) {
2594       Value *Old = IRB.CreateAlignedLoad(&NewAI, NewAI.getAlignment(),
2595                                          "oldload");
2596       Old = convertValue(DL, IRB, Old, IntTy);
2597       uint64_t Offset = NewBeginOffset - NewAllocaBeginOffset;
2598       Src = insertInteger(DL, IRB, Old, Src, Offset, "insert");
2599       Src = convertValue(DL, IRB, Src, NewAllocaTy);
2600     }
2601
2602     StoreInst *Store = cast<StoreInst>(
2603       IRB.CreateAlignedStore(Src, DstPtr, Align, II.isVolatile()));
2604     (void)Store;
2605     DEBUG(dbgs() << "          to: " << *Store << "\n");
2606     return !II.isVolatile();
2607   }
2608
2609   bool visitIntrinsicInst(IntrinsicInst &II) {
2610     assert(II.getIntrinsicID() == Intrinsic::lifetime_start ||
2611            II.getIntrinsicID() == Intrinsic::lifetime_end);
2612     DEBUG(dbgs() << "    original: " << II << "\n");
2613     assert(II.getArgOperand(1) == OldPtr);
2614
2615     // Compute the intersecting offset range.
2616     assert(BeginOffset < NewAllocaEndOffset);
2617     assert(EndOffset > NewAllocaBeginOffset);
2618     uint64_t NewBeginOffset = std::max(BeginOffset, NewAllocaBeginOffset);
2619     uint64_t NewEndOffset = std::min(EndOffset, NewAllocaEndOffset);
2620
2621     // Record this instruction for deletion.
2622     Pass.DeadInsts.insert(&II);
2623
2624     ConstantInt *Size
2625       = ConstantInt::get(cast<IntegerType>(II.getArgOperand(0)->getType()),
2626                          NewEndOffset - NewBeginOffset);
2627     Value *Ptr =
2628         getAdjustedAllocaPtr(IRB, NewBeginOffset, II.getArgOperand(1)->getType());
2629     Value *New;
2630     if (II.getIntrinsicID() == Intrinsic::lifetime_start)
2631       New = IRB.CreateLifetimeStart(Ptr, Size);
2632     else
2633       New = IRB.CreateLifetimeEnd(Ptr, Size);
2634
2635     (void)New;
2636     DEBUG(dbgs() << "          to: " << *New << "\n");
2637     return true;
2638   }
2639
2640   bool visitPHINode(PHINode &PN) {
2641     DEBUG(dbgs() << "    original: " << PN << "\n");
2642     assert(BeginOffset >= NewAllocaBeginOffset && "PHIs are unsplittable");
2643     assert(EndOffset <= NewAllocaEndOffset && "PHIs are unsplittable");
2644
2645     // We would like to compute a new pointer in only one place, but have it be
2646     // as local as possible to the PHI. To do that, we re-use the location of
2647     // the old pointer, which necessarily must be in the right position to
2648     // dominate the PHI.
2649     IRBuilderTy PtrBuilder(OldPtr);
2650     PtrBuilder.SetNamePrefix(Twine(NewAI.getName()) + "." + Twine(BeginOffset) +
2651                              ".");
2652
2653     Value *NewPtr =
2654         getAdjustedAllocaPtr(PtrBuilder, BeginOffset, OldPtr->getType());
2655     // Replace the operands which were using the old pointer.
2656     std::replace(PN.op_begin(), PN.op_end(), cast<Value>(OldPtr), NewPtr);
2657
2658     DEBUG(dbgs() << "          to: " << PN << "\n");
2659     deleteIfTriviallyDead(OldPtr);
2660
2661     // Check whether we can speculate this PHI node, and if so remember that
2662     // fact and queue it up for another iteration after the speculation
2663     // occurs.
2664     if (isSafePHIToSpeculate(PN, &DL)) {
2665       Pass.SpeculatablePHIs.insert(&PN);
2666       IsUsedByRewrittenSpeculatableInstructions = true;
2667       return true;
2668     }
2669
2670     return false; // PHIs can't be promoted on their own.
2671   }
2672
2673   bool visitSelectInst(SelectInst &SI) {
2674     DEBUG(dbgs() << "    original: " << SI << "\n");
2675     assert((SI.getTrueValue() == OldPtr || SI.getFalseValue() == OldPtr) &&
2676            "Pointer isn't an operand!");
2677     assert(BeginOffset >= NewAllocaBeginOffset && "Selects are unsplittable");
2678     assert(EndOffset <= NewAllocaEndOffset && "Selects are unsplittable");
2679
2680     Value *NewPtr = getAdjustedAllocaPtr(IRB, BeginOffset, OldPtr->getType());
2681     // Replace the operands which were using the old pointer.
2682     if (SI.getOperand(1) == OldPtr)
2683       SI.setOperand(1, NewPtr);
2684     if (SI.getOperand(2) == OldPtr)
2685       SI.setOperand(2, NewPtr);
2686
2687     DEBUG(dbgs() << "          to: " << SI << "\n");
2688     deleteIfTriviallyDead(OldPtr);
2689
2690     // Check whether we can speculate this select instruction, and if so
2691     // remember that fact and queue it up for another iteration after the
2692     // speculation occurs.
2693     if (isSafeSelectToSpeculate(SI, &DL)) {
2694       Pass.SpeculatableSelects.insert(&SI);
2695       IsUsedByRewrittenSpeculatableInstructions = true;
2696       return true;
2697     }
2698
2699     return false; // Selects can't be promoted on their own.
2700   }
2701
2702 };
2703 }
2704
2705 namespace {
2706 /// \brief Visitor to rewrite aggregate loads and stores as scalar.
2707 ///
2708 /// This pass aggressively rewrites all aggregate loads and stores on
2709 /// a particular pointer (or any pointer derived from it which we can identify)
2710 /// with scalar loads and stores.
2711 class AggLoadStoreRewriter : public InstVisitor<AggLoadStoreRewriter, bool> {
2712   // Befriend the base class so it can delegate to private visit methods.
2713   friend class llvm::InstVisitor<AggLoadStoreRewriter, bool>;
2714
2715   const DataLayout &DL;
2716
2717   /// Queue of pointer uses to analyze and potentially rewrite.
2718   SmallVector<Use *, 8> Queue;
2719
2720   /// Set to prevent us from cycling with phi nodes and loops.
2721   SmallPtrSet<User *, 8> Visited;
2722
2723   /// The current pointer use being rewritten. This is used to dig up the used
2724   /// value (as opposed to the user).
2725   Use *U;
2726
2727 public:
2728   AggLoadStoreRewriter(const DataLayout &DL) : DL(DL) {}
2729
2730   /// Rewrite loads and stores through a pointer and all pointers derived from
2731   /// it.
2732   bool rewrite(Instruction &I) {
2733     DEBUG(dbgs() << "  Rewriting FCA loads and stores...\n");
2734     enqueueUsers(I);
2735     bool Changed = false;
2736     while (!Queue.empty()) {
2737       U = Queue.pop_back_val();
2738       Changed |= visit(cast<Instruction>(U->getUser()));
2739     }
2740     return Changed;
2741   }
2742
2743 private:
2744   /// Enqueue all the users of the given instruction for further processing.
2745   /// This uses a set to de-duplicate users.
2746   void enqueueUsers(Instruction &I) {
2747     for (Value::use_iterator UI = I.use_begin(), UE = I.use_end(); UI != UE;
2748          ++UI)
2749       if (Visited.insert(*UI))
2750         Queue.push_back(&UI.getUse());
2751   }
2752
2753   // Conservative default is to not rewrite anything.
2754   bool visitInstruction(Instruction &I) { return false; }
2755
2756   /// \brief Generic recursive split emission class.
2757   template <typename Derived>
2758   class OpSplitter {
2759   protected:
2760     /// The builder used to form new instructions.
2761     IRBuilderTy IRB;
2762     /// The indices which to be used with insert- or extractvalue to select the
2763     /// appropriate value within the aggregate.
2764     SmallVector<unsigned, 4> Indices;
2765     /// The indices to a GEP instruction which will move Ptr to the correct slot
2766     /// within the aggregate.
2767     SmallVector<Value *, 4> GEPIndices;
2768     /// The base pointer of the original op, used as a base for GEPing the
2769     /// split operations.
2770     Value *Ptr;
2771
2772     /// Initialize the splitter with an insertion point, Ptr and start with a
2773     /// single zero GEP index.
2774     OpSplitter(Instruction *InsertionPoint, Value *Ptr)
2775       : IRB(InsertionPoint), GEPIndices(1, IRB.getInt32(0)), Ptr(Ptr) {}
2776
2777   public:
2778     /// \brief Generic recursive split emission routine.
2779     ///
2780     /// This method recursively splits an aggregate op (load or store) into
2781     /// scalar or vector ops. It splits recursively until it hits a single value
2782     /// and emits that single value operation via the template argument.
2783     ///
2784     /// The logic of this routine relies on GEPs and insertvalue and
2785     /// extractvalue all operating with the same fundamental index list, merely
2786     /// formatted differently (GEPs need actual values).
2787     ///
2788     /// \param Ty  The type being split recursively into smaller ops.
2789     /// \param Agg The aggregate value being built up or stored, depending on
2790     /// whether this is splitting a load or a store respectively.
2791     void emitSplitOps(Type *Ty, Value *&Agg, const Twine &Name) {
2792       if (Ty->isSingleValueType())
2793         return static_cast<Derived *>(this)->emitFunc(Ty, Agg, Name);
2794
2795       if (ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
2796         unsigned OldSize = Indices.size();
2797         (void)OldSize;
2798         for (unsigned Idx = 0, Size = ATy->getNumElements(); Idx != Size;
2799              ++Idx) {
2800           assert(Indices.size() == OldSize && "Did not return to the old size");
2801           Indices.push_back(Idx);
2802           GEPIndices.push_back(IRB.getInt32(Idx));
2803           emitSplitOps(ATy->getElementType(), Agg, Name + "." + Twine(Idx));
2804           GEPIndices.pop_back();
2805           Indices.pop_back();
2806         }
2807         return;
2808       }
2809
2810       if (StructType *STy = dyn_cast<StructType>(Ty)) {
2811         unsigned OldSize = Indices.size();
2812         (void)OldSize;
2813         for (unsigned Idx = 0, Size = STy->getNumElements(); Idx != Size;
2814              ++Idx) {
2815           assert(Indices.size() == OldSize && "Did not return to the old size");
2816           Indices.push_back(Idx);
2817           GEPIndices.push_back(IRB.getInt32(Idx));
2818           emitSplitOps(STy->getElementType(Idx), Agg, Name + "." + Twine(Idx));
2819           GEPIndices.pop_back();
2820           Indices.pop_back();
2821         }
2822         return;
2823       }
2824
2825       llvm_unreachable("Only arrays and structs are aggregate loadable types");
2826     }
2827   };
2828
2829   struct LoadOpSplitter : public OpSplitter<LoadOpSplitter> {
2830     LoadOpSplitter(Instruction *InsertionPoint, Value *Ptr)
2831       : OpSplitter<LoadOpSplitter>(InsertionPoint, Ptr) {}
2832
2833     /// Emit a leaf load of a single value. This is called at the leaves of the
2834     /// recursive emission to actually load values.
2835     void emitFunc(Type *Ty, Value *&Agg, const Twine &Name) {
2836       assert(Ty->isSingleValueType());
2837       // Load the single value and insert it using the indices.
2838       Value *GEP = IRB.CreateInBoundsGEP(Ptr, GEPIndices, Name + ".gep");
2839       Value *Load = IRB.CreateLoad(GEP, Name + ".load");
2840       Agg = IRB.CreateInsertValue(Agg, Load, Indices, Name + ".insert");
2841       DEBUG(dbgs() << "          to: " << *Load << "\n");
2842     }
2843   };
2844
2845   bool visitLoadInst(LoadInst &LI) {
2846     assert(LI.getPointerOperand() == *U);
2847     if (!LI.isSimple() || LI.getType()->isSingleValueType())
2848       return false;
2849
2850     // We have an aggregate being loaded, split it apart.
2851     DEBUG(dbgs() << "    original: " << LI << "\n");
2852     LoadOpSplitter Splitter(&LI, *U);
2853     Value *V = UndefValue::get(LI.getType());
2854     Splitter.emitSplitOps(LI.getType(), V, LI.getName() + ".fca");
2855     LI.replaceAllUsesWith(V);
2856     LI.eraseFromParent();
2857     return true;
2858   }
2859
2860   struct StoreOpSplitter : public OpSplitter<StoreOpSplitter> {
2861     StoreOpSplitter(Instruction *InsertionPoint, Value *Ptr)
2862       : OpSplitter<StoreOpSplitter>(InsertionPoint, Ptr) {}
2863
2864     /// Emit a leaf store of a single value. This is called at the leaves of the
2865     /// recursive emission to actually produce stores.
2866     void emitFunc(Type *Ty, Value *&Agg, const Twine &Name) {
2867       assert(Ty->isSingleValueType());
2868       // Extract the single value and store it using the indices.
2869       Value *Store = IRB.CreateStore(
2870         IRB.CreateExtractValue(Agg, Indices, Name + ".extract"),
2871         IRB.CreateInBoundsGEP(Ptr, GEPIndices, Name + ".gep"));
2872       (void)Store;
2873       DEBUG(dbgs() << "          to: " << *Store << "\n");
2874     }
2875   };
2876
2877   bool visitStoreInst(StoreInst &SI) {
2878     if (!SI.isSimple() || SI.getPointerOperand() != *U)
2879       return false;
2880     Value *V = SI.getValueOperand();
2881     if (V->getType()->isSingleValueType())
2882       return false;
2883
2884     // We have an aggregate being stored, split it apart.
2885     DEBUG(dbgs() << "    original: " << SI << "\n");
2886     StoreOpSplitter Splitter(&SI, *U);
2887     Splitter.emitSplitOps(V->getType(), V, V->getName() + ".fca");
2888     SI.eraseFromParent();
2889     return true;
2890   }
2891
2892   bool visitBitCastInst(BitCastInst &BC) {
2893     enqueueUsers(BC);
2894     return false;
2895   }
2896
2897   bool visitGetElementPtrInst(GetElementPtrInst &GEPI) {
2898     enqueueUsers(GEPI);
2899     return false;
2900   }
2901
2902   bool visitPHINode(PHINode &PN) {
2903     enqueueUsers(PN);
2904     return false;
2905   }
2906
2907   bool visitSelectInst(SelectInst &SI) {
2908     enqueueUsers(SI);
2909     return false;
2910   }
2911 };
2912 }
2913
2914 /// \brief Strip aggregate type wrapping.
2915 ///
2916 /// This removes no-op aggregate types wrapping an underlying type. It will
2917 /// strip as many layers of types as it can without changing either the type
2918 /// size or the allocated size.
2919 static Type *stripAggregateTypeWrapping(const DataLayout &DL, Type *Ty) {
2920   if (Ty->isSingleValueType())
2921     return Ty;
2922
2923   uint64_t AllocSize = DL.getTypeAllocSize(Ty);
2924   uint64_t TypeSize = DL.getTypeSizeInBits(Ty);
2925
2926   Type *InnerTy;
2927   if (ArrayType *ArrTy = dyn_cast<ArrayType>(Ty)) {
2928     InnerTy = ArrTy->getElementType();
2929   } else if (StructType *STy = dyn_cast<StructType>(Ty)) {
2930     const StructLayout *SL = DL.getStructLayout(STy);
2931     unsigned Index = SL->getElementContainingOffset(0);
2932     InnerTy = STy->getElementType(Index);
2933   } else {
2934     return Ty;
2935   }
2936
2937   if (AllocSize > DL.getTypeAllocSize(InnerTy) ||
2938       TypeSize > DL.getTypeSizeInBits(InnerTy))
2939     return Ty;
2940
2941   return stripAggregateTypeWrapping(DL, InnerTy);
2942 }
2943
2944 /// \brief Try to find a partition of the aggregate type passed in for a given
2945 /// offset and size.
2946 ///
2947 /// This recurses through the aggregate type and tries to compute a subtype
2948 /// based on the offset and size. When the offset and size span a sub-section
2949 /// of an array, it will even compute a new array type for that sub-section,
2950 /// and the same for structs.
2951 ///
2952 /// Note that this routine is very strict and tries to find a partition of the
2953 /// type which produces the *exact* right offset and size. It is not forgiving
2954 /// when the size or offset cause either end of type-based partition to be off.
2955 /// Also, this is a best-effort routine. It is reasonable to give up and not
2956 /// return a type if necessary.
2957 static Type *getTypePartition(const DataLayout &DL, Type *Ty,
2958                               uint64_t Offset, uint64_t Size) {
2959   if (Offset == 0 && DL.getTypeAllocSize(Ty) == Size)
2960     return stripAggregateTypeWrapping(DL, Ty);
2961   if (Offset > DL.getTypeAllocSize(Ty) ||
2962       (DL.getTypeAllocSize(Ty) - Offset) < Size)
2963     return 0;
2964
2965   if (SequentialType *SeqTy = dyn_cast<SequentialType>(Ty)) {
2966     // We can't partition pointers...
2967     if (SeqTy->isPointerTy())
2968       return 0;
2969
2970     Type *ElementTy = SeqTy->getElementType();
2971     uint64_t ElementSize = DL.getTypeAllocSize(ElementTy);
2972     uint64_t NumSkippedElements = Offset / ElementSize;
2973     if (ArrayType *ArrTy = dyn_cast<ArrayType>(SeqTy)) {
2974       if (NumSkippedElements >= ArrTy->getNumElements())
2975         return 0;
2976     } else if (VectorType *VecTy = dyn_cast<VectorType>(SeqTy)) {
2977       if (NumSkippedElements >= VecTy->getNumElements())
2978         return 0;
2979     }
2980     Offset -= NumSkippedElements * ElementSize;
2981
2982     // First check if we need to recurse.
2983     if (Offset > 0 || Size < ElementSize) {
2984       // Bail if the partition ends in a different array element.
2985       if ((Offset + Size) > ElementSize)
2986         return 0;
2987       // Recurse through the element type trying to peel off offset bytes.
2988       return getTypePartition(DL, ElementTy, Offset, Size);
2989     }
2990     assert(Offset == 0);
2991
2992     if (Size == ElementSize)
2993       return stripAggregateTypeWrapping(DL, ElementTy);
2994     assert(Size > ElementSize);
2995     uint64_t NumElements = Size / ElementSize;
2996     if (NumElements * ElementSize != Size)
2997       return 0;
2998     return ArrayType::get(ElementTy, NumElements);
2999   }
3000
3001   StructType *STy = dyn_cast<StructType>(Ty);
3002   if (!STy)
3003     return 0;
3004
3005   const StructLayout *SL = DL.getStructLayout(STy);
3006   if (Offset >= SL->getSizeInBytes())
3007     return 0;
3008   uint64_t EndOffset = Offset + Size;
3009   if (EndOffset > SL->getSizeInBytes())
3010     return 0;
3011
3012   unsigned Index = SL->getElementContainingOffset(Offset);
3013   Offset -= SL->getElementOffset(Index);
3014
3015   Type *ElementTy = STy->getElementType(Index);
3016   uint64_t ElementSize = DL.getTypeAllocSize(ElementTy);
3017   if (Offset >= ElementSize)
3018     return 0; // The offset points into alignment padding.
3019
3020   // See if any partition must be contained by the element.
3021   if (Offset > 0 || Size < ElementSize) {
3022     if ((Offset + Size) > ElementSize)
3023       return 0;
3024     return getTypePartition(DL, ElementTy, Offset, Size);
3025   }
3026   assert(Offset == 0);
3027
3028   if (Size == ElementSize)
3029     return stripAggregateTypeWrapping(DL, ElementTy);
3030
3031   StructType::element_iterator EI = STy->element_begin() + Index,
3032                                EE = STy->element_end();
3033   if (EndOffset < SL->getSizeInBytes()) {
3034     unsigned EndIndex = SL->getElementContainingOffset(EndOffset);
3035     if (Index == EndIndex)
3036       return 0; // Within a single element and its padding.
3037
3038     // Don't try to form "natural" types if the elements don't line up with the
3039     // expected size.
3040     // FIXME: We could potentially recurse down through the last element in the
3041     // sub-struct to find a natural end point.
3042     if (SL->getElementOffset(EndIndex) != EndOffset)
3043       return 0;
3044
3045     assert(Index < EndIndex);
3046     EE = STy->element_begin() + EndIndex;
3047   }
3048
3049   // Try to build up a sub-structure.
3050   StructType *SubTy = StructType::get(STy->getContext(), makeArrayRef(EI, EE),
3051                                       STy->isPacked());
3052   const StructLayout *SubSL = DL.getStructLayout(SubTy);
3053   if (Size != SubSL->getSizeInBytes())
3054     return 0; // The sub-struct doesn't have quite the size needed.
3055
3056   return SubTy;
3057 }
3058
3059 /// \brief Rewrite an alloca partition's users.
3060 ///
3061 /// This routine drives both of the rewriting goals of the SROA pass. It tries
3062 /// to rewrite uses of an alloca partition to be conducive for SSA value
3063 /// promotion. If the partition needs a new, more refined alloca, this will
3064 /// build that new alloca, preserving as much type information as possible, and
3065 /// rewrite the uses of the old alloca to point at the new one and have the
3066 /// appropriate new offsets. It also evaluates how successful the rewrite was
3067 /// at enabling promotion and if it was successful queues the alloca to be
3068 /// promoted.
3069 bool SROA::rewritePartition(AllocaInst &AI, AllocaSlices &S,
3070                             AllocaSlices::iterator B, AllocaSlices::iterator E,
3071                             int64_t BeginOffset, int64_t EndOffset,
3072                             ArrayRef<AllocaSlices::iterator> SplitUses) {
3073   assert(BeginOffset < EndOffset);
3074   uint64_t SliceSize = EndOffset - BeginOffset;
3075
3076   // Try to compute a friendly type for this partition of the alloca. This
3077   // won't always succeed, in which case we fall back to a legal integer type
3078   // or an i8 array of an appropriate size.
3079   Type *SliceTy = 0;
3080   if (Type *CommonUseTy = findCommonType(B, E, EndOffset))
3081     if (DL->getTypeAllocSize(CommonUseTy) >= SliceSize)
3082       SliceTy = CommonUseTy;
3083   if (!SliceTy)
3084     if (Type *TypePartitionTy = getTypePartition(*DL, AI.getAllocatedType(),
3085                                                  BeginOffset, SliceSize))
3086       SliceTy = TypePartitionTy;
3087   if ((!SliceTy || (SliceTy->isArrayTy() &&
3088                     SliceTy->getArrayElementType()->isIntegerTy())) &&
3089       DL->isLegalInteger(SliceSize * 8))
3090     SliceTy = Type::getIntNTy(*C, SliceSize * 8);
3091   if (!SliceTy)
3092     SliceTy = ArrayType::get(Type::getInt8Ty(*C), SliceSize);
3093   assert(DL->getTypeAllocSize(SliceTy) >= SliceSize);
3094
3095   bool IsVectorPromotable = isVectorPromotionViable(
3096       *DL, SliceTy, S, BeginOffset, EndOffset, B, E, SplitUses);
3097
3098   bool IsIntegerPromotable =
3099       !IsVectorPromotable &&
3100       isIntegerWideningViable(*DL, SliceTy, BeginOffset, S, B, E, SplitUses);
3101
3102   // Check for the case where we're going to rewrite to a new alloca of the
3103   // exact same type as the original, and with the same access offsets. In that
3104   // case, re-use the existing alloca, but still run through the rewriter to
3105   // perform phi and select speculation.
3106   AllocaInst *NewAI;
3107   if (SliceTy == AI.getAllocatedType()) {
3108     assert(BeginOffset == 0 &&
3109            "Non-zero begin offset but same alloca type");
3110     NewAI = &AI;
3111     // FIXME: We should be able to bail at this point with "nothing changed".
3112     // FIXME: We might want to defer PHI speculation until after here.
3113   } else {
3114     unsigned Alignment = AI.getAlignment();
3115     if (!Alignment) {
3116       // The minimum alignment which users can rely on when the explicit
3117       // alignment is omitted or zero is that required by the ABI for this
3118       // type.
3119       Alignment = DL->getABITypeAlignment(AI.getAllocatedType());
3120     }
3121     Alignment = MinAlign(Alignment, BeginOffset);
3122     // If we will get at least this much alignment from the type alone, leave
3123     // the alloca's alignment unconstrained.
3124     if (Alignment <= DL->getABITypeAlignment(SliceTy))
3125       Alignment = 0;
3126     NewAI = new AllocaInst(SliceTy, 0, Alignment,
3127                            AI.getName() + ".sroa." + Twine(B - S.begin()), &AI);
3128     ++NumNewAllocas;
3129   }
3130
3131   DEBUG(dbgs() << "Rewriting alloca partition "
3132                << "[" << BeginOffset << "," << EndOffset << ") to: " << *NewAI
3133                << "\n");
3134
3135   // Track the high watermark on several worklists that are only relevant for
3136   // promoted allocas. We will reset it to this point if the alloca is not in
3137   // fact scheduled for promotion.
3138   unsigned PPWOldSize = PostPromotionWorklist.size();
3139   unsigned SPOldSize = SpeculatablePHIs.size();
3140   unsigned SSOldSize = SpeculatableSelects.size();
3141   unsigned NumUses = 0;
3142
3143   AllocaSliceRewriter Rewriter(*DL, S, *this, AI, *NewAI, BeginOffset,
3144                                EndOffset, IsVectorPromotable,
3145                                IsIntegerPromotable);
3146   bool Promotable = true;
3147   for (ArrayRef<AllocaSlices::iterator>::const_iterator SUI = SplitUses.begin(),
3148                                                         SUE = SplitUses.end();
3149        SUI != SUE; ++SUI) {
3150     DEBUG(dbgs() << "  rewriting split ");
3151     DEBUG(S.printSlice(dbgs(), *SUI, ""));
3152     Promotable &= Rewriter.visit(*SUI);
3153     ++NumUses;
3154   }
3155   for (AllocaSlices::iterator I = B; I != E; ++I) {
3156     DEBUG(dbgs() << "  rewriting ");
3157     DEBUG(S.printSlice(dbgs(), I, ""));
3158     Promotable &= Rewriter.visit(I);
3159     ++NumUses;
3160   }
3161
3162   NumAllocaPartitionUses += NumUses;
3163   MaxUsesPerAllocaPartition =
3164       std::max<unsigned>(NumUses, MaxUsesPerAllocaPartition);
3165
3166   if (Promotable && !Rewriter.isUsedByRewrittenSpeculatableInstructions()) {
3167     DEBUG(dbgs() << "  and queuing for promotion\n");
3168     PromotableAllocas.push_back(NewAI);
3169   } else if (NewAI != &AI ||
3170              (Promotable &&
3171               Rewriter.isUsedByRewrittenSpeculatableInstructions())) {
3172     // If we can't promote the alloca, iterate on it to check for new
3173     // refinements exposed by splitting the current alloca. Don't iterate on an
3174     // alloca which didn't actually change and didn't get promoted.
3175     //
3176     // Alternatively, if we could promote the alloca but have speculatable
3177     // instructions then we will speculate them after finishing our processing
3178     // of the original alloca. Mark the new one for re-visiting in the next
3179     // iteration so the speculated operations can be rewritten.
3180     //
3181     // FIXME: We should actually track whether the rewriter changed anything.
3182     Worklist.insert(NewAI);
3183   }
3184
3185   // Drop any post-promotion work items if promotion didn't happen.
3186   if (!Promotable) {
3187     while (PostPromotionWorklist.size() > PPWOldSize)
3188       PostPromotionWorklist.pop_back();
3189     while (SpeculatablePHIs.size() > SPOldSize)
3190       SpeculatablePHIs.pop_back();
3191     while (SpeculatableSelects.size() > SSOldSize)
3192       SpeculatableSelects.pop_back();
3193   }
3194
3195   return true;
3196 }
3197
3198 namespace {
3199 struct IsSliceEndLessOrEqualTo {
3200   uint64_t UpperBound;
3201
3202   IsSliceEndLessOrEqualTo(uint64_t UpperBound) : UpperBound(UpperBound) {}
3203
3204   bool operator()(const AllocaSlices::iterator &I) {
3205     return I->endOffset() <= UpperBound;
3206   }
3207 };
3208 }
3209
3210 static void
3211 removeFinishedSplitUses(SmallVectorImpl<AllocaSlices::iterator> &SplitUses,
3212                         uint64_t &MaxSplitUseEndOffset, uint64_t Offset) {
3213   if (Offset >= MaxSplitUseEndOffset) {
3214     SplitUses.clear();
3215     MaxSplitUseEndOffset = 0;
3216     return;
3217   }
3218
3219   size_t SplitUsesOldSize = SplitUses.size();
3220   SplitUses.erase(std::remove_if(SplitUses.begin(), SplitUses.end(),
3221                                  IsSliceEndLessOrEqualTo(Offset)),
3222                   SplitUses.end());
3223   if (SplitUsesOldSize == SplitUses.size())
3224     return;
3225
3226   // Recompute the max. While this is linear, so is remove_if.
3227   MaxSplitUseEndOffset = 0;
3228   for (SmallVectorImpl<AllocaSlices::iterator>::iterator
3229            SUI = SplitUses.begin(),
3230            SUE = SplitUses.end();
3231        SUI != SUE; ++SUI)
3232     MaxSplitUseEndOffset = std::max((*SUI)->endOffset(), MaxSplitUseEndOffset);
3233 }
3234
3235 /// \brief Walks the slices of an alloca and form partitions based on them,
3236 /// rewriting each of their uses.
3237 bool SROA::splitAlloca(AllocaInst &AI, AllocaSlices &S) {
3238   if (S.begin() == S.end())
3239     return false;
3240
3241   unsigned NumPartitions = 0;
3242   bool Changed = false;
3243   SmallVector<AllocaSlices::iterator, 4> SplitUses;
3244   uint64_t MaxSplitUseEndOffset = 0;
3245
3246   uint64_t BeginOffset = S.begin()->beginOffset();
3247
3248   for (AllocaSlices::iterator SI = S.begin(), SJ = llvm::next(SI), SE = S.end();
3249        SI != SE; SI = SJ) {
3250     uint64_t MaxEndOffset = SI->endOffset();
3251
3252     if (!SI->isSplittable()) {
3253       // When we're forming an unsplittable region, it must always start at the
3254       // first slice and will extend through its end.
3255       assert(BeginOffset == SI->beginOffset());
3256
3257       // Form a partition including all of the overlapping slices with this
3258       // unsplittable slice.
3259       while (SJ != SE && SJ->beginOffset() < MaxEndOffset) {
3260         if (!SJ->isSplittable())
3261           MaxEndOffset = std::max(MaxEndOffset, SJ->endOffset());
3262         ++SJ;
3263       }
3264     } else {
3265       assert(SI->isSplittable()); // Established above.
3266
3267       // Collect all of the overlapping splittable slices.
3268       while (SJ != SE && SJ->beginOffset() < MaxEndOffset &&
3269              SJ->isSplittable()) {
3270         MaxEndOffset = std::max(MaxEndOffset, SJ->endOffset());
3271         ++SJ;
3272       }
3273
3274       // Back up MaxEndOffset and SJ if we ended the span early when
3275       // encountering an unsplittable slice.
3276       if (SJ != SE && SJ->beginOffset() < MaxEndOffset) {
3277         assert(!SJ->isSplittable());
3278         MaxEndOffset = SJ->beginOffset();
3279       }
3280     }
3281
3282     // Check if we have managed to move the end offset forward yet. If so,
3283     // we'll have to rewrite uses and erase old split uses.
3284     if (BeginOffset < MaxEndOffset) {
3285       // Rewrite a sequence of overlapping slices.
3286       Changed |=
3287           rewritePartition(AI, S, SI, SJ, BeginOffset, MaxEndOffset, SplitUses);
3288       ++NumPartitions;
3289
3290       removeFinishedSplitUses(SplitUses, MaxSplitUseEndOffset, MaxEndOffset);
3291     }
3292
3293     // Accumulate all the splittable slices from the [SI,SJ) region which
3294     // overlap going forward.
3295     for (AllocaSlices::iterator SK = SI; SK != SJ; ++SK)
3296       if (SK->isSplittable() && SK->endOffset() > MaxEndOffset) {
3297         SplitUses.push_back(SK);
3298         MaxSplitUseEndOffset = std::max(SK->endOffset(), MaxSplitUseEndOffset);
3299       }
3300
3301     // If we're already at the end and we have no split uses, we're done.
3302     if (SJ == SE && SplitUses.empty())
3303       break;
3304
3305     // If we have no split uses or no gap in offsets, we're ready to move to
3306     // the next slice.
3307     if (SplitUses.empty() || (SJ != SE && MaxEndOffset == SJ->beginOffset())) {
3308       BeginOffset = SJ->beginOffset();
3309       continue;
3310     }
3311
3312     // Even if we have split slices, if the next slice is splittable and the
3313     // split slices reach it, we can simply set up the beginning offset of the
3314     // next iteration to bridge between them.
3315     if (SJ != SE && SJ->isSplittable() &&
3316         MaxSplitUseEndOffset > SJ->beginOffset()) {
3317       BeginOffset = MaxEndOffset;
3318       continue;
3319     }
3320
3321     // Otherwise, we have a tail of split slices. Rewrite them with an empty
3322     // range of slices.
3323     uint64_t PostSplitEndOffset =
3324         SJ == SE ? MaxSplitUseEndOffset : SJ->beginOffset();
3325
3326     Changed |= rewritePartition(AI, S, SJ, SJ, MaxEndOffset, PostSplitEndOffset,
3327                                 SplitUses);
3328     ++NumPartitions;
3329
3330     if (SJ == SE)
3331       break; // Skip the rest, we don't need to do any cleanup.
3332
3333     removeFinishedSplitUses(SplitUses, MaxSplitUseEndOffset,
3334                             PostSplitEndOffset);
3335
3336     // Now just reset the begin offset for the next iteration.
3337     BeginOffset = SJ->beginOffset();
3338   }
3339
3340   NumAllocaPartitions += NumPartitions;
3341   MaxPartitionsPerAlloca =
3342       std::max<unsigned>(NumPartitions, MaxPartitionsPerAlloca);
3343
3344   return Changed;
3345 }
3346
3347 /// \brief Clobber a use with undef, deleting the used value if it becomes dead.
3348 void SROA::clobberUse(Use &U) {
3349   Value *OldV = U;
3350   // Replace the use with an undef value.
3351   U = UndefValue::get(OldV->getType());
3352
3353   // Check for this making an instruction dead. We have to garbage collect
3354   // all the dead instructions to ensure the uses of any alloca end up being
3355   // minimal.
3356   if (Instruction *OldI = dyn_cast<Instruction>(OldV))
3357     if (isInstructionTriviallyDead(OldI)) {
3358       DeadInsts.insert(OldI);
3359     }
3360 }
3361
3362 /// \brief Analyze an alloca for SROA.
3363 ///
3364 /// This analyzes the alloca to ensure we can reason about it, builds
3365 /// the slices of the alloca, and then hands it off to be split and
3366 /// rewritten as needed.
3367 bool SROA::runOnAlloca(AllocaInst &AI) {
3368   DEBUG(dbgs() << "SROA alloca: " << AI << "\n");
3369   ++NumAllocasAnalyzed;
3370
3371   // Special case dead allocas, as they're trivial.
3372   if (AI.use_empty()) {
3373     AI.eraseFromParent();
3374     return true;
3375   }
3376
3377   // Skip alloca forms that this analysis can't handle.
3378   if (AI.isArrayAllocation() || !AI.getAllocatedType()->isSized() ||
3379       DL->getTypeAllocSize(AI.getAllocatedType()) == 0)
3380     return false;
3381
3382   bool Changed = false;
3383
3384   // First, split any FCA loads and stores touching this alloca to promote
3385   // better splitting and promotion opportunities.
3386   AggLoadStoreRewriter AggRewriter(*DL);
3387   Changed |= AggRewriter.rewrite(AI);
3388
3389   // Build the slices using a recursive instruction-visiting builder.
3390   AllocaSlices S(*DL, AI);
3391   DEBUG(S.print(dbgs()));
3392   if (S.isEscaped())
3393     return Changed;
3394
3395   // Delete all the dead users of this alloca before splitting and rewriting it.
3396   for (AllocaSlices::dead_user_iterator DI = S.dead_user_begin(),
3397                                         DE = S.dead_user_end();
3398        DI != DE; ++DI) {
3399     // Free up everything used by this instruction.
3400     for (User::op_iterator DOI = (*DI)->op_begin(), DOE = (*DI)->op_end();
3401          DOI != DOE; ++DOI)
3402       clobberUse(*DOI);
3403
3404     // Now replace the uses of this instruction.
3405     (*DI)->replaceAllUsesWith(UndefValue::get((*DI)->getType()));
3406
3407     // And mark it for deletion.
3408     DeadInsts.insert(*DI);
3409     Changed = true;
3410   }
3411   for (AllocaSlices::dead_op_iterator DO = S.dead_op_begin(),
3412                                       DE = S.dead_op_end();
3413        DO != DE; ++DO) {
3414     clobberUse(**DO);
3415     Changed = true;
3416   }
3417
3418   // No slices to split. Leave the dead alloca for a later pass to clean up.
3419   if (S.begin() == S.end())
3420     return Changed;
3421
3422   Changed |= splitAlloca(AI, S);
3423
3424   DEBUG(dbgs() << "  Speculating PHIs\n");
3425   while (!SpeculatablePHIs.empty())
3426     speculatePHINodeLoads(*SpeculatablePHIs.pop_back_val());
3427
3428   DEBUG(dbgs() << "  Speculating Selects\n");
3429   while (!SpeculatableSelects.empty())
3430     speculateSelectInstLoads(*SpeculatableSelects.pop_back_val());
3431
3432   return Changed;
3433 }
3434
3435 /// \brief Delete the dead instructions accumulated in this run.
3436 ///
3437 /// Recursively deletes the dead instructions we've accumulated. This is done
3438 /// at the very end to maximize locality of the recursive delete and to
3439 /// minimize the problems of invalidated instruction pointers as such pointers
3440 /// are used heavily in the intermediate stages of the algorithm.
3441 ///
3442 /// We also record the alloca instructions deleted here so that they aren't
3443 /// subsequently handed to mem2reg to promote.
3444 void SROA::deleteDeadInstructions(SmallPtrSet<AllocaInst*, 4> &DeletedAllocas) {
3445   while (!DeadInsts.empty()) {
3446     Instruction *I = DeadInsts.pop_back_val();
3447     DEBUG(dbgs() << "Deleting dead instruction: " << *I << "\n");
3448
3449     I->replaceAllUsesWith(UndefValue::get(I->getType()));
3450
3451     for (User::op_iterator OI = I->op_begin(), E = I->op_end(); OI != E; ++OI)
3452       if (Instruction *U = dyn_cast<Instruction>(*OI)) {
3453         // Zero out the operand and see if it becomes trivially dead.
3454         *OI = 0;
3455         if (isInstructionTriviallyDead(U))
3456           DeadInsts.insert(U);
3457       }
3458
3459     if (AllocaInst *AI = dyn_cast<AllocaInst>(I))
3460       DeletedAllocas.insert(AI);
3461
3462     ++NumDeleted;
3463     I->eraseFromParent();
3464   }
3465 }
3466
3467 static void enqueueUsersInWorklist(Instruction &I,
3468                                    SmallVectorImpl<Instruction *> &Worklist,
3469                                    SmallPtrSet<Instruction *, 8> &Visited) {
3470   for (Value::use_iterator UI = I.use_begin(), UE = I.use_end(); UI != UE;
3471        ++UI)
3472     if (Visited.insert(cast<Instruction>(*UI)))
3473       Worklist.push_back(cast<Instruction>(*UI));
3474 }
3475
3476 /// \brief Promote the allocas, using the best available technique.
3477 ///
3478 /// This attempts to promote whatever allocas have been identified as viable in
3479 /// the PromotableAllocas list. If that list is empty, there is nothing to do.
3480 /// If there is a domtree available, we attempt to promote using the full power
3481 /// of mem2reg. Otherwise, we build and use the AllocaPromoter above which is
3482 /// based on the SSAUpdater utilities. This function returns whether any
3483 /// promotion occurred.
3484 bool SROA::promoteAllocas(Function &F) {
3485   if (PromotableAllocas.empty())
3486     return false;
3487
3488   NumPromoted += PromotableAllocas.size();
3489
3490   if (DT && !ForceSSAUpdater) {
3491     DEBUG(dbgs() << "Promoting allocas with mem2reg...\n");
3492     PromoteMemToReg(PromotableAllocas, *DT);
3493     PromotableAllocas.clear();
3494     return true;
3495   }
3496
3497   DEBUG(dbgs() << "Promoting allocas with SSAUpdater...\n");
3498   SSAUpdater SSA;
3499   DIBuilder DIB(*F.getParent());
3500   SmallVector<Instruction *, 64> Insts;
3501
3502   // We need a worklist to walk the uses of each alloca.
3503   SmallVector<Instruction *, 8> Worklist;
3504   SmallPtrSet<Instruction *, 8> Visited;
3505   SmallVector<Instruction *, 32> DeadInsts;
3506
3507   for (unsigned Idx = 0, Size = PromotableAllocas.size(); Idx != Size; ++Idx) {
3508     AllocaInst *AI = PromotableAllocas[Idx];
3509     Insts.clear();
3510     Worklist.clear();
3511     Visited.clear();
3512
3513     enqueueUsersInWorklist(*AI, Worklist, Visited);
3514
3515     while (!Worklist.empty()) {
3516       Instruction *I = Worklist.pop_back_val();
3517
3518       // FIXME: Currently the SSAUpdater infrastructure doesn't reason about
3519       // lifetime intrinsics and so we strip them (and the bitcasts+GEPs
3520       // leading to them) here. Eventually it should use them to optimize the
3521       // scalar values produced.
3522       if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
3523         assert(II->getIntrinsicID() == Intrinsic::lifetime_start ||
3524                II->getIntrinsicID() == Intrinsic::lifetime_end);
3525         II->eraseFromParent();
3526         continue;
3527       }
3528
3529       // Push the loads and stores we find onto the list. SROA will already
3530       // have validated that all loads and stores are viable candidates for
3531       // promotion.
3532       if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
3533         assert(LI->getType() == AI->getAllocatedType());
3534         Insts.push_back(LI);
3535         continue;
3536       }
3537       if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
3538         assert(SI->getValueOperand()->getType() == AI->getAllocatedType());
3539         Insts.push_back(SI);
3540         continue;
3541       }
3542
3543       // For everything else, we know that only no-op bitcasts and GEPs will
3544       // make it this far, just recurse through them and recall them for later
3545       // removal.
3546       DeadInsts.push_back(I);
3547       enqueueUsersInWorklist(*I, Worklist, Visited);
3548     }
3549     AllocaPromoter(Insts, SSA, *AI, DIB).run(Insts);
3550     while (!DeadInsts.empty())
3551       DeadInsts.pop_back_val()->eraseFromParent();
3552     AI->eraseFromParent();
3553   }
3554
3555   PromotableAllocas.clear();
3556   return true;
3557 }
3558
3559 namespace {
3560   /// \brief A predicate to test whether an alloca belongs to a set.
3561   class IsAllocaInSet {
3562     typedef SmallPtrSet<AllocaInst *, 4> SetType;
3563     const SetType &Set;
3564
3565   public:
3566     typedef AllocaInst *argument_type;
3567
3568     IsAllocaInSet(const SetType &Set) : Set(Set) {}
3569     bool operator()(AllocaInst *AI) const { return Set.count(AI); }
3570   };
3571 }
3572
3573 bool SROA::runOnFunction(Function &F) {
3574   if (skipOptnoneFunction(F))
3575     return false;
3576
3577   DEBUG(dbgs() << "SROA function: " << F.getName() << "\n");
3578   C = &F.getContext();
3579   DL = getAnalysisIfAvailable<DataLayout>();
3580   if (!DL) {
3581     DEBUG(dbgs() << "  Skipping SROA -- no target data!\n");
3582     return false;
3583   }
3584   DominatorTreeWrapperPass *DTWP =
3585       getAnalysisIfAvailable<DominatorTreeWrapperPass>();
3586   DT = DTWP ? &DTWP->getDomTree() : 0;
3587
3588   BasicBlock &EntryBB = F.getEntryBlock();
3589   for (BasicBlock::iterator I = EntryBB.begin(), E = llvm::prior(EntryBB.end());
3590        I != E; ++I)
3591     if (AllocaInst *AI = dyn_cast<AllocaInst>(I))
3592       Worklist.insert(AI);
3593
3594   bool Changed = false;
3595   // A set of deleted alloca instruction pointers which should be removed from
3596   // the list of promotable allocas.
3597   SmallPtrSet<AllocaInst *, 4> DeletedAllocas;
3598
3599   do {
3600     while (!Worklist.empty()) {
3601       Changed |= runOnAlloca(*Worklist.pop_back_val());
3602       deleteDeadInstructions(DeletedAllocas);
3603
3604       // Remove the deleted allocas from various lists so that we don't try to
3605       // continue processing them.
3606       if (!DeletedAllocas.empty()) {
3607         Worklist.remove_if(IsAllocaInSet(DeletedAllocas));
3608         PostPromotionWorklist.remove_if(IsAllocaInSet(DeletedAllocas));
3609         PromotableAllocas.erase(std::remove_if(PromotableAllocas.begin(),
3610                                                PromotableAllocas.end(),
3611                                                IsAllocaInSet(DeletedAllocas)),
3612                                 PromotableAllocas.end());
3613         DeletedAllocas.clear();
3614       }
3615     }
3616
3617     Changed |= promoteAllocas(F);
3618
3619     Worklist = PostPromotionWorklist;
3620     PostPromotionWorklist.clear();
3621   } while (!Worklist.empty());
3622
3623   return Changed;
3624 }
3625
3626 void SROA::getAnalysisUsage(AnalysisUsage &AU) const {
3627   if (RequiresDomTree)
3628     AU.addRequired<DominatorTreeWrapperPass>();
3629   AU.setPreservesCFG();
3630 }