DbgInfoIntrinsics no longer appear in an instruction's use list; so clean up looking...
[oota-llvm.git] / lib / Transforms / Scalar / ScalarReplAggregates.cpp
1 //===- ScalarReplAggregates.cpp - Scalar Replacement of Aggregates --------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This transformation implements the well known scalar replacement of
11 // aggregates transformation.  This xform breaks up alloca instructions of
12 // aggregate type (structure or array) into individual alloca instructions for
13 // each member (if possible).  Then, if possible, it transforms the individual
14 // alloca instructions into nice clean scalar SSA form.
15 //
16 // This combines a simple SRoA algorithm with the Mem2Reg algorithm because
17 // often interact, especially for C++ programs.  As such, iterating between
18 // SRoA, then Mem2Reg until we run out of things to promote works well.
19 //
20 //===----------------------------------------------------------------------===//
21
22 #define DEBUG_TYPE "scalarrepl"
23 #include "llvm/Transforms/Scalar.h"
24 #include "llvm/Constants.h"
25 #include "llvm/DerivedTypes.h"
26 #include "llvm/Function.h"
27 #include "llvm/GlobalVariable.h"
28 #include "llvm/Instructions.h"
29 #include "llvm/IntrinsicInst.h"
30 #include "llvm/LLVMContext.h"
31 #include "llvm/Pass.h"
32 #include "llvm/Analysis/Dominators.h"
33 #include "llvm/Target/TargetData.h"
34 #include "llvm/Transforms/Utils/PromoteMemToReg.h"
35 #include "llvm/Transforms/Utils/Local.h"
36 #include "llvm/Support/Debug.h"
37 #include "llvm/Support/ErrorHandling.h"
38 #include "llvm/Support/GetElementPtrTypeIterator.h"
39 #include "llvm/Support/IRBuilder.h"
40 #include "llvm/Support/MathExtras.h"
41 #include "llvm/Support/raw_ostream.h"
42 #include "llvm/ADT/SmallVector.h"
43 #include "llvm/ADT/Statistic.h"
44 using namespace llvm;
45
46 STATISTIC(NumReplaced,  "Number of allocas broken up");
47 STATISTIC(NumPromoted,  "Number of allocas promoted");
48 STATISTIC(NumConverted, "Number of aggregates converted to scalar");
49 STATISTIC(NumGlobals,   "Number of allocas copied from constant global");
50
51 namespace {
52   struct SROA : public FunctionPass {
53     static char ID; // Pass identification, replacement for typeid
54     explicit SROA(signed T = -1) : FunctionPass(&ID) {
55       if (T == -1)
56         SRThreshold = 128;
57       else
58         SRThreshold = T;
59     }
60
61     bool runOnFunction(Function &F);
62
63     bool performScalarRepl(Function &F);
64     bool performPromotion(Function &F);
65
66     // getAnalysisUsage - This pass does not require any passes, but we know it
67     // will not alter the CFG, so say so.
68     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
69       AU.addRequired<DominatorTree>();
70       AU.addRequired<DominanceFrontier>();
71       AU.setPreservesCFG();
72     }
73
74   private:
75     TargetData *TD;
76     
77     /// DeadInsts - Keep track of instructions we have made dead, so that
78     /// we can remove them after we are done working.
79     SmallVector<Value*, 32> DeadInsts;
80
81     /// AllocaInfo - When analyzing uses of an alloca instruction, this captures
82     /// information about the uses.  All these fields are initialized to false
83     /// and set to true when something is learned.
84     struct AllocaInfo {
85       /// isUnsafe - This is set to true if the alloca cannot be SROA'd.
86       bool isUnsafe : 1;
87       
88       /// isMemCpySrc - This is true if this aggregate is memcpy'd from.
89       bool isMemCpySrc : 1;
90
91       /// isMemCpyDst - This is true if this aggregate is memcpy'd into.
92       bool isMemCpyDst : 1;
93
94       AllocaInfo()
95         : isUnsafe(false), isMemCpySrc(false), isMemCpyDst(false) {}
96     };
97     
98     unsigned SRThreshold;
99
100     void MarkUnsafe(AllocaInfo &I) { I.isUnsafe = true; }
101
102     bool isSafeAllocaToScalarRepl(AllocaInst *AI);
103
104     void isSafeForScalarRepl(Instruction *I, AllocaInst *AI, uint64_t Offset,
105                              AllocaInfo &Info);
106     void isSafeGEP(GetElementPtrInst *GEPI, AllocaInst *AI, uint64_t &Offset,
107                    AllocaInfo &Info);
108     void isSafeMemAccess(AllocaInst *AI, uint64_t Offset, uint64_t MemSize,
109                          const Type *MemOpType, bool isStore, AllocaInfo &Info);
110     bool TypeHasComponent(const Type *T, uint64_t Offset, uint64_t Size);
111     uint64_t FindElementAndOffset(const Type *&T, uint64_t &Offset,
112                                   const Type *&IdxTy);
113     
114     void DoScalarReplacement(AllocaInst *AI, 
115                              std::vector<AllocaInst*> &WorkList);
116     void DeleteDeadInstructions();
117     AllocaInst *AddNewAlloca(Function &F, const Type *Ty, AllocaInst *Base);
118     
119     void RewriteForScalarRepl(Instruction *I, AllocaInst *AI, uint64_t Offset,
120                               SmallVector<AllocaInst*, 32> &NewElts);
121     void RewriteBitCast(BitCastInst *BC, AllocaInst *AI, uint64_t Offset,
122                         SmallVector<AllocaInst*, 32> &NewElts);
123     void RewriteGEP(GetElementPtrInst *GEPI, AllocaInst *AI, uint64_t Offset,
124                     SmallVector<AllocaInst*, 32> &NewElts);
125     void RewriteMemIntrinUserOfAlloca(MemIntrinsic *MI, Instruction *Inst,
126                                       AllocaInst *AI,
127                                       SmallVector<AllocaInst*, 32> &NewElts);
128     void RewriteStoreUserOfWholeAlloca(StoreInst *SI, AllocaInst *AI,
129                                        SmallVector<AllocaInst*, 32> &NewElts);
130     void RewriteLoadUserOfWholeAlloca(LoadInst *LI, AllocaInst *AI,
131                                       SmallVector<AllocaInst*, 32> &NewElts);
132     
133     bool CanConvertToScalar(Value *V, bool &IsNotTrivial, const Type *&VecTy,
134                             bool &SawVec, uint64_t Offset, unsigned AllocaSize);
135     void ConvertUsesToScalar(Value *Ptr, AllocaInst *NewAI, uint64_t Offset);
136     Value *ConvertScalar_ExtractValue(Value *NV, const Type *ToType,
137                                      uint64_t Offset, IRBuilder<> &Builder);
138     Value *ConvertScalar_InsertValue(Value *StoredVal, Value *ExistingVal,
139                                      uint64_t Offset, IRBuilder<> &Builder);
140     static Instruction *isOnlyCopiedFromConstantGlobal(AllocaInst *AI);
141   };
142 }
143
144 char SROA::ID = 0;
145 static RegisterPass<SROA> X("scalarrepl", "Scalar Replacement of Aggregates");
146
147 // Public interface to the ScalarReplAggregates pass
148 FunctionPass *llvm::createScalarReplAggregatesPass(signed int Threshold) { 
149   return new SROA(Threshold);
150 }
151
152
153 bool SROA::runOnFunction(Function &F) {
154   TD = getAnalysisIfAvailable<TargetData>();
155
156   bool Changed = performPromotion(F);
157
158   // FIXME: ScalarRepl currently depends on TargetData more than it
159   // theoretically needs to. It should be refactored in order to support
160   // target-independent IR. Until this is done, just skip the actual
161   // scalar-replacement portion of this pass.
162   if (!TD) return Changed;
163
164   while (1) {
165     bool LocalChange = performScalarRepl(F);
166     if (!LocalChange) break;   // No need to repromote if no scalarrepl
167     Changed = true;
168     LocalChange = performPromotion(F);
169     if (!LocalChange) break;   // No need to re-scalarrepl if no promotion
170   }
171
172   return Changed;
173 }
174
175
176 bool SROA::performPromotion(Function &F) {
177   std::vector<AllocaInst*> Allocas;
178   DominatorTree         &DT = getAnalysis<DominatorTree>();
179   DominanceFrontier &DF = getAnalysis<DominanceFrontier>();
180
181   BasicBlock &BB = F.getEntryBlock();  // Get the entry node for the function
182
183   bool Changed = false;
184
185   while (1) {
186     Allocas.clear();
187
188     // Find allocas that are safe to promote, by looking at all instructions in
189     // the entry node
190     for (BasicBlock::iterator I = BB.begin(), E = --BB.end(); I != E; ++I)
191       if (AllocaInst *AI = dyn_cast<AllocaInst>(I))       // Is it an alloca?
192         if (isAllocaPromotable(AI))
193           Allocas.push_back(AI);
194
195     if (Allocas.empty()) break;
196
197     PromoteMemToReg(Allocas, DT, DF);
198     NumPromoted += Allocas.size();
199     Changed = true;
200   }
201
202   return Changed;
203 }
204
205 /// getNumSAElements - Return the number of elements in the specific struct or
206 /// array.
207 static uint64_t getNumSAElements(const Type *T) {
208   if (const StructType *ST = dyn_cast<StructType>(T))
209     return ST->getNumElements();
210   return cast<ArrayType>(T)->getNumElements();
211 }
212
213 // performScalarRepl - This algorithm is a simple worklist driven algorithm,
214 // which runs on all of the malloc/alloca instructions in the function, removing
215 // them if they are only used by getelementptr instructions.
216 //
217 bool SROA::performScalarRepl(Function &F) {
218   std::vector<AllocaInst*> WorkList;
219
220   // Scan the entry basic block, adding any alloca's and mallocs to the worklist
221   BasicBlock &BB = F.getEntryBlock();
222   for (BasicBlock::iterator I = BB.begin(), E = BB.end(); I != E; ++I)
223     if (AllocaInst *A = dyn_cast<AllocaInst>(I))
224       WorkList.push_back(A);
225
226   // Process the worklist
227   bool Changed = false;
228   while (!WorkList.empty()) {
229     AllocaInst *AI = WorkList.back();
230     WorkList.pop_back();
231     
232     // Handle dead allocas trivially.  These can be formed by SROA'ing arrays
233     // with unused elements.
234     if (AI->use_empty()) {
235       AI->eraseFromParent();
236       continue;
237     }
238
239     // If this alloca is impossible for us to promote, reject it early.
240     if (AI->isArrayAllocation() || !AI->getAllocatedType()->isSized())
241       continue;
242     
243     // Check to see if this allocation is only modified by a memcpy/memmove from
244     // a constant global.  If this is the case, we can change all users to use
245     // the constant global instead.  This is commonly produced by the CFE by
246     // constructs like "void foo() { int A[] = {1,2,3,4,5,6,7,8,9...}; }" if 'A'
247     // is only subsequently read.
248     if (Instruction *TheCopy = isOnlyCopiedFromConstantGlobal(AI)) {
249       DEBUG(dbgs() << "Found alloca equal to global: " << *AI << '\n');
250       DEBUG(dbgs() << "  memcpy = " << *TheCopy << '\n');
251       Constant *TheSrc = cast<Constant>(TheCopy->getOperand(2));
252       AI->replaceAllUsesWith(ConstantExpr::getBitCast(TheSrc, AI->getType()));
253       TheCopy->eraseFromParent();  // Don't mutate the global.
254       AI->eraseFromParent();
255       ++NumGlobals;
256       Changed = true;
257       continue;
258     }
259     
260     // Check to see if we can perform the core SROA transformation.  We cannot
261     // transform the allocation instruction if it is an array allocation
262     // (allocations OF arrays are ok though), and an allocation of a scalar
263     // value cannot be decomposed at all.
264     uint64_t AllocaSize = TD->getTypeAllocSize(AI->getAllocatedType());
265
266     // Do not promote [0 x %struct].
267     if (AllocaSize == 0) continue;
268
269     // Do not promote any struct whose size is too big.
270     if (AllocaSize > SRThreshold) continue;
271
272     if ((isa<StructType>(AI->getAllocatedType()) ||
273          isa<ArrayType>(AI->getAllocatedType())) &&
274         // Do not promote any struct into more than "32" separate vars.
275         getNumSAElements(AI->getAllocatedType()) <= SRThreshold/4) {
276       // Check that all of the users of the allocation are capable of being
277       // transformed.
278       if (isSafeAllocaToScalarRepl(AI)) {
279         DoScalarReplacement(AI, WorkList);
280         Changed = true;
281         continue;
282       }
283     }
284
285     // If we can turn this aggregate value (potentially with casts) into a
286     // simple scalar value that can be mem2reg'd into a register value.
287     // IsNotTrivial tracks whether this is something that mem2reg could have
288     // promoted itself.  If so, we don't want to transform it needlessly.  Note
289     // that we can't just check based on the type: the alloca may be of an i32
290     // but that has pointer arithmetic to set byte 3 of it or something.
291     bool IsNotTrivial = false;
292     const Type *VectorTy = 0;
293     bool HadAVector = false;
294     if (CanConvertToScalar(AI, IsNotTrivial, VectorTy, HadAVector, 
295                            0, unsigned(AllocaSize)) && IsNotTrivial) {
296       AllocaInst *NewAI;
297       // If we were able to find a vector type that can handle this with
298       // insert/extract elements, and if there was at least one use that had
299       // a vector type, promote this to a vector.  We don't want to promote
300       // random stuff that doesn't use vectors (e.g. <9 x double>) because then
301       // we just get a lot of insert/extracts.  If at least one vector is
302       // involved, then we probably really do have a union of vector/array.
303       if (VectorTy && isa<VectorType>(VectorTy) && HadAVector) {
304         DEBUG(dbgs() << "CONVERT TO VECTOR: " << *AI << "\n  TYPE = "
305                      << *VectorTy << '\n');
306         
307         // Create and insert the vector alloca.
308         NewAI = new AllocaInst(VectorTy, 0, "",  AI->getParent()->begin());
309         ConvertUsesToScalar(AI, NewAI, 0);
310       } else {
311         DEBUG(dbgs() << "CONVERT TO SCALAR INTEGER: " << *AI << "\n");
312         
313         // Create and insert the integer alloca.
314         const Type *NewTy = IntegerType::get(AI->getContext(), AllocaSize*8);
315         NewAI = new AllocaInst(NewTy, 0, "", AI->getParent()->begin());
316         ConvertUsesToScalar(AI, NewAI, 0);
317       }
318       NewAI->takeName(AI);
319       AI->eraseFromParent();
320       ++NumConverted;
321       Changed = true;
322       continue;
323     }
324     
325     // Otherwise, couldn't process this alloca.
326   }
327
328   return Changed;
329 }
330
331 /// DoScalarReplacement - This alloca satisfied the isSafeAllocaToScalarRepl
332 /// predicate, do SROA now.
333 void SROA::DoScalarReplacement(AllocaInst *AI, 
334                                std::vector<AllocaInst*> &WorkList) {
335   DEBUG(dbgs() << "Found inst to SROA: " << *AI << '\n');
336   SmallVector<AllocaInst*, 32> ElementAllocas;
337   if (const StructType *ST = dyn_cast<StructType>(AI->getAllocatedType())) {
338     ElementAllocas.reserve(ST->getNumContainedTypes());
339     for (unsigned i = 0, e = ST->getNumContainedTypes(); i != e; ++i) {
340       AllocaInst *NA = new AllocaInst(ST->getContainedType(i), 0, 
341                                       AI->getAlignment(),
342                                       AI->getName() + "." + Twine(i), AI);
343       ElementAllocas.push_back(NA);
344       WorkList.push_back(NA);  // Add to worklist for recursive processing
345     }
346   } else {
347     const ArrayType *AT = cast<ArrayType>(AI->getAllocatedType());
348     ElementAllocas.reserve(AT->getNumElements());
349     const Type *ElTy = AT->getElementType();
350     for (unsigned i = 0, e = AT->getNumElements(); i != e; ++i) {
351       AllocaInst *NA = new AllocaInst(ElTy, 0, AI->getAlignment(),
352                                       AI->getName() + "." + Twine(i), AI);
353       ElementAllocas.push_back(NA);
354       WorkList.push_back(NA);  // Add to worklist for recursive processing
355     }
356   }
357
358   // Now that we have created the new alloca instructions, rewrite all the
359   // uses of the old alloca.
360   RewriteForScalarRepl(AI, AI, 0, ElementAllocas);
361
362   // Now erase any instructions that were made dead while rewriting the alloca.
363   DeleteDeadInstructions();
364   AI->eraseFromParent();
365
366   NumReplaced++;
367 }
368
369 /// DeleteDeadInstructions - Erase instructions on the DeadInstrs list,
370 /// recursively including all their operands that become trivially dead.
371 void SROA::DeleteDeadInstructions() {
372   while (!DeadInsts.empty()) {
373     Instruction *I = cast<Instruction>(DeadInsts.pop_back_val());
374
375     for (User::op_iterator OI = I->op_begin(), E = I->op_end(); OI != E; ++OI)
376       if (Instruction *U = dyn_cast<Instruction>(*OI)) {
377         // Zero out the operand and see if it becomes trivially dead.
378         // (But, don't add allocas to the dead instruction list -- they are
379         // already on the worklist and will be deleted separately.)
380         *OI = 0;
381         if (isInstructionTriviallyDead(U) && !isa<AllocaInst>(U))
382           DeadInsts.push_back(U);
383       }
384
385     I->eraseFromParent();
386   }
387 }
388     
389 /// isSafeForScalarRepl - Check if instruction I is a safe use with regard to
390 /// performing scalar replacement of alloca AI.  The results are flagged in
391 /// the Info parameter.  Offset indicates the position within AI that is
392 /// referenced by this instruction.
393 void SROA::isSafeForScalarRepl(Instruction *I, AllocaInst *AI, uint64_t Offset,
394                                AllocaInfo &Info) {
395   for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI!=E; ++UI) {
396     Instruction *User = cast<Instruction>(*UI);
397
398     if (BitCastInst *BC = dyn_cast<BitCastInst>(User)) {
399       isSafeForScalarRepl(BC, AI, Offset, Info);
400     } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
401       uint64_t GEPOffset = Offset;
402       isSafeGEP(GEPI, AI, GEPOffset, Info);
403       if (!Info.isUnsafe)
404         isSafeForScalarRepl(GEPI, AI, GEPOffset, Info);
405     } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(UI)) {
406       ConstantInt *Length = dyn_cast<ConstantInt>(MI->getLength());
407       if (Length)
408         isSafeMemAccess(AI, Offset, Length->getZExtValue(), 0,
409                         UI.getOperandNo() == 1, Info);
410       else
411         MarkUnsafe(Info);
412     } else if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
413       if (!LI->isVolatile()) {
414         const Type *LIType = LI->getType();
415         isSafeMemAccess(AI, Offset, TD->getTypeAllocSize(LIType),
416                         LIType, false, Info);
417       } else
418         MarkUnsafe(Info);
419     } else if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
420       // Store is ok if storing INTO the pointer, not storing the pointer
421       if (!SI->isVolatile() && SI->getOperand(0) != I) {
422         const Type *SIType = SI->getOperand(0)->getType();
423         isSafeMemAccess(AI, Offset, TD->getTypeAllocSize(SIType),
424                         SIType, true, Info);
425       } else
426         MarkUnsafe(Info);
427     } else {
428       DEBUG(errs() << "  Transformation preventing inst: " << *User << '\n');
429       MarkUnsafe(Info);
430     }
431     if (Info.isUnsafe) return;
432   }
433 }
434
435 /// isSafeGEP - Check if a GEP instruction can be handled for scalar
436 /// replacement.  It is safe when all the indices are constant, in-bounds
437 /// references, and when the resulting offset corresponds to an element within
438 /// the alloca type.  The results are flagged in the Info parameter.  Upon
439 /// return, Offset is adjusted as specified by the GEP indices.
440 void SROA::isSafeGEP(GetElementPtrInst *GEPI, AllocaInst *AI,
441                      uint64_t &Offset, AllocaInfo &Info) {
442   gep_type_iterator GEPIt = gep_type_begin(GEPI), E = gep_type_end(GEPI);
443   if (GEPIt == E)
444     return;
445
446   // Walk through the GEP type indices, checking the types that this indexes
447   // into.
448   for (; GEPIt != E; ++GEPIt) {
449     // Ignore struct elements, no extra checking needed for these.
450     if (isa<StructType>(*GEPIt))
451       continue;
452
453     ConstantInt *IdxVal = dyn_cast<ConstantInt>(GEPIt.getOperand());
454     if (!IdxVal)
455       return MarkUnsafe(Info);
456   }
457
458   // Compute the offset due to this GEP and check if the alloca has a
459   // component element at that offset.
460   SmallVector<Value*, 8> Indices(GEPI->op_begin() + 1, GEPI->op_end());
461   Offset += TD->getIndexedOffset(GEPI->getPointerOperandType(),
462                                  &Indices[0], Indices.size());
463   if (!TypeHasComponent(AI->getAllocatedType(), Offset, 0))
464     MarkUnsafe(Info);
465 }
466
467 /// isSafeMemAccess - Check if a load/store/memcpy operates on the entire AI
468 /// alloca or has an offset and size that corresponds to a component element
469 /// within it.  The offset checked here may have been formed from a GEP with a
470 /// pointer bitcasted to a different type.
471 void SROA::isSafeMemAccess(AllocaInst *AI, uint64_t Offset, uint64_t MemSize,
472                            const Type *MemOpType, bool isStore,
473                            AllocaInfo &Info) {
474   // Check if this is a load/store of the entire alloca.
475   if (Offset == 0 && MemSize == TD->getTypeAllocSize(AI->getAllocatedType())) {
476     bool UsesAggregateType = (MemOpType == AI->getAllocatedType());
477     // This is safe for MemIntrinsics (where MemOpType is 0), integer types
478     // (which are essentially the same as the MemIntrinsics, especially with
479     // regard to copying padding between elements), or references using the
480     // aggregate type of the alloca.
481     if (!MemOpType || isa<IntegerType>(MemOpType) || UsesAggregateType) {
482       if (!UsesAggregateType) {
483         if (isStore)
484           Info.isMemCpyDst = true;
485         else
486           Info.isMemCpySrc = true;
487       }
488       return;
489     }
490   }
491   // Check if the offset/size correspond to a component within the alloca type.
492   const Type *T = AI->getAllocatedType();
493   if (TypeHasComponent(T, Offset, MemSize))
494     return;
495
496   return MarkUnsafe(Info);
497 }
498
499 /// TypeHasComponent - Return true if T has a component type with the
500 /// specified offset and size.  If Size is zero, do not check the size.
501 bool SROA::TypeHasComponent(const Type *T, uint64_t Offset, uint64_t Size) {
502   const Type *EltTy;
503   uint64_t EltSize;
504   if (const StructType *ST = dyn_cast<StructType>(T)) {
505     const StructLayout *Layout = TD->getStructLayout(ST);
506     unsigned EltIdx = Layout->getElementContainingOffset(Offset);
507     EltTy = ST->getContainedType(EltIdx);
508     EltSize = TD->getTypeAllocSize(EltTy);
509     Offset -= Layout->getElementOffset(EltIdx);
510   } else if (const ArrayType *AT = dyn_cast<ArrayType>(T)) {
511     EltTy = AT->getElementType();
512     EltSize = TD->getTypeAllocSize(EltTy);
513     if (Offset >= AT->getNumElements() * EltSize)
514       return false;
515     Offset %= EltSize;
516   } else {
517     return false;
518   }
519   if (Offset == 0 && (Size == 0 || EltSize == Size))
520     return true;
521   // Check if the component spans multiple elements.
522   if (Offset + Size > EltSize)
523     return false;
524   return TypeHasComponent(EltTy, Offset, Size);
525 }
526
527 /// RewriteForScalarRepl - Alloca AI is being split into NewElts, so rewrite
528 /// the instruction I, which references it, to use the separate elements.
529 /// Offset indicates the position within AI that is referenced by this
530 /// instruction.
531 void SROA::RewriteForScalarRepl(Instruction *I, AllocaInst *AI, uint64_t Offset,
532                                 SmallVector<AllocaInst*, 32> &NewElts) {
533   for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI!=E; ++UI) {
534     Instruction *User = cast<Instruction>(*UI);
535
536     if (BitCastInst *BC = dyn_cast<BitCastInst>(User)) {
537       RewriteBitCast(BC, AI, Offset, NewElts);
538     } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
539       RewriteGEP(GEPI, AI, Offset, NewElts);
540     } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(User)) {
541       ConstantInt *Length = dyn_cast<ConstantInt>(MI->getLength());
542       uint64_t MemSize = Length->getZExtValue();
543       if (Offset == 0 &&
544           MemSize == TD->getTypeAllocSize(AI->getAllocatedType()))
545         RewriteMemIntrinUserOfAlloca(MI, I, AI, NewElts);
546       // Otherwise the intrinsic can only touch a single element and the
547       // address operand will be updated, so nothing else needs to be done.
548     } else if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
549       const Type *LIType = LI->getType();
550       if (LIType == AI->getAllocatedType()) {
551         // Replace:
552         //   %res = load { i32, i32 }* %alloc
553         // with:
554         //   %load.0 = load i32* %alloc.0
555         //   %insert.0 insertvalue { i32, i32 } zeroinitializer, i32 %load.0, 0
556         //   %load.1 = load i32* %alloc.1
557         //   %insert = insertvalue { i32, i32 } %insert.0, i32 %load.1, 1
558         // (Also works for arrays instead of structs)
559         Value *Insert = UndefValue::get(LIType);
560         for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
561           Value *Load = new LoadInst(NewElts[i], "load", LI);
562           Insert = InsertValueInst::Create(Insert, Load, i, "insert", LI);
563         }
564         LI->replaceAllUsesWith(Insert);
565         DeadInsts.push_back(LI);
566       } else if (isa<IntegerType>(LIType) &&
567                  TD->getTypeAllocSize(LIType) ==
568                  TD->getTypeAllocSize(AI->getAllocatedType())) {
569         // If this is a load of the entire alloca to an integer, rewrite it.
570         RewriteLoadUserOfWholeAlloca(LI, AI, NewElts);
571       }
572     } else if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
573       Value *Val = SI->getOperand(0);
574       const Type *SIType = Val->getType();
575       if (SIType == AI->getAllocatedType()) {
576         // Replace:
577         //   store { i32, i32 } %val, { i32, i32 }* %alloc
578         // with:
579         //   %val.0 = extractvalue { i32, i32 } %val, 0
580         //   store i32 %val.0, i32* %alloc.0
581         //   %val.1 = extractvalue { i32, i32 } %val, 1
582         //   store i32 %val.1, i32* %alloc.1
583         // (Also works for arrays instead of structs)
584         for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
585           Value *Extract = ExtractValueInst::Create(Val, i, Val->getName(), SI);
586           new StoreInst(Extract, NewElts[i], SI);
587         }
588         DeadInsts.push_back(SI);
589       } else if (isa<IntegerType>(SIType) &&
590                  TD->getTypeAllocSize(SIType) ==
591                  TD->getTypeAllocSize(AI->getAllocatedType())) {
592         // If this is a store of the entire alloca from an integer, rewrite it.
593         RewriteStoreUserOfWholeAlloca(SI, AI, NewElts);
594       }
595     }
596   }
597 }
598
599 /// RewriteBitCast - Update a bitcast reference to the alloca being replaced
600 /// and recursively continue updating all of its uses.
601 void SROA::RewriteBitCast(BitCastInst *BC, AllocaInst *AI, uint64_t Offset,
602                           SmallVector<AllocaInst*, 32> &NewElts) {
603   RewriteForScalarRepl(BC, AI, Offset, NewElts);
604   if (BC->getOperand(0) != AI)
605     return;
606
607   // The bitcast references the original alloca.  Replace its uses with
608   // references to the first new element alloca.
609   Instruction *Val = NewElts[0];
610   if (Val->getType() != BC->getDestTy()) {
611     Val = new BitCastInst(Val, BC->getDestTy(), "", BC);
612     Val->takeName(BC);
613   }
614   BC->replaceAllUsesWith(Val);
615   DeadInsts.push_back(BC);
616 }
617
618 /// FindElementAndOffset - Return the index of the element containing Offset
619 /// within the specified type, which must be either a struct or an array.
620 /// Sets T to the type of the element and Offset to the offset within that
621 /// element.  IdxTy is set to the type of the index result to be used in a
622 /// GEP instruction.
623 uint64_t SROA::FindElementAndOffset(const Type *&T, uint64_t &Offset,
624                                     const Type *&IdxTy) {
625   uint64_t Idx = 0;
626   if (const StructType *ST = dyn_cast<StructType>(T)) {
627     const StructLayout *Layout = TD->getStructLayout(ST);
628     Idx = Layout->getElementContainingOffset(Offset);
629     T = ST->getContainedType(Idx);
630     Offset -= Layout->getElementOffset(Idx);
631     IdxTy = Type::getInt32Ty(T->getContext());
632     return Idx;
633   }
634   const ArrayType *AT = cast<ArrayType>(T);
635   T = AT->getElementType();
636   uint64_t EltSize = TD->getTypeAllocSize(T);
637   Idx = Offset / EltSize;
638   Offset -= Idx * EltSize;
639   IdxTy = Type::getInt64Ty(T->getContext());
640   return Idx;
641 }
642
643 /// RewriteGEP - Check if this GEP instruction moves the pointer across
644 /// elements of the alloca that are being split apart, and if so, rewrite
645 /// the GEP to be relative to the new element.
646 void SROA::RewriteGEP(GetElementPtrInst *GEPI, AllocaInst *AI, uint64_t Offset,
647                       SmallVector<AllocaInst*, 32> &NewElts) {
648   uint64_t OldOffset = Offset;
649   SmallVector<Value*, 8> Indices(GEPI->op_begin() + 1, GEPI->op_end());
650   Offset += TD->getIndexedOffset(GEPI->getPointerOperandType(),
651                                  &Indices[0], Indices.size());
652
653   RewriteForScalarRepl(GEPI, AI, Offset, NewElts);
654
655   const Type *T = AI->getAllocatedType();
656   const Type *IdxTy;
657   uint64_t OldIdx = FindElementAndOffset(T, OldOffset, IdxTy);
658   if (GEPI->getOperand(0) == AI)
659     OldIdx = ~0ULL; // Force the GEP to be rewritten.
660
661   T = AI->getAllocatedType();
662   uint64_t EltOffset = Offset;
663   uint64_t Idx = FindElementAndOffset(T, EltOffset, IdxTy);
664
665   // If this GEP does not move the pointer across elements of the alloca
666   // being split, then it does not needs to be rewritten.
667   if (Idx == OldIdx)
668     return;
669
670   const Type *i32Ty = Type::getInt32Ty(AI->getContext());
671   SmallVector<Value*, 8> NewArgs;
672   NewArgs.push_back(Constant::getNullValue(i32Ty));
673   while (EltOffset != 0) {
674     uint64_t EltIdx = FindElementAndOffset(T, EltOffset, IdxTy);
675     NewArgs.push_back(ConstantInt::get(IdxTy, EltIdx));
676   }
677   Instruction *Val = NewElts[Idx];
678   if (NewArgs.size() > 1) {
679     Val = GetElementPtrInst::CreateInBounds(Val, NewArgs.begin(),
680                                             NewArgs.end(), "", GEPI);
681     Val->takeName(GEPI);
682   }
683   if (Val->getType() != GEPI->getType())
684     Val = new BitCastInst(Val, GEPI->getType(), Val->getNameStr(), GEPI);
685   GEPI->replaceAllUsesWith(Val);
686   DeadInsts.push_back(GEPI);
687 }
688
689 /// RewriteMemIntrinUserOfAlloca - MI is a memcpy/memset/memmove from or to AI.
690 /// Rewrite it to copy or set the elements of the scalarized memory.
691 void SROA::RewriteMemIntrinUserOfAlloca(MemIntrinsic *MI, Instruction *Inst,
692                                         AllocaInst *AI,
693                                         SmallVector<AllocaInst*, 32> &NewElts) {
694   // If this is a memcpy/memmove, construct the other pointer as the
695   // appropriate type.  The "Other" pointer is the pointer that goes to memory
696   // that doesn't have anything to do with the alloca that we are promoting. For
697   // memset, this Value* stays null.
698   Value *OtherPtr = 0;
699   LLVMContext &Context = MI->getContext();
700   unsigned MemAlignment = MI->getAlignment();
701   if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(MI)) { // memmove/memcopy
702     if (Inst == MTI->getRawDest())
703       OtherPtr = MTI->getRawSource();
704     else {
705       assert(Inst == MTI->getRawSource());
706       OtherPtr = MTI->getRawDest();
707     }
708   }
709
710   // If there is an other pointer, we want to convert it to the same pointer
711   // type as AI has, so we can GEP through it safely.
712   if (OtherPtr) {
713
714     // Remove bitcasts and all-zero GEPs from OtherPtr.  This is an
715     // optimization, but it's also required to detect the corner case where
716     // both pointer operands are referencing the same memory, and where
717     // OtherPtr may be a bitcast or GEP that currently being rewritten.  (This
718     // function is only called for mem intrinsics that access the whole
719     // aggregate, so non-zero GEPs are not an issue here.)
720     while (1) {
721       if (BitCastInst *BC = dyn_cast<BitCastInst>(OtherPtr)) {
722         OtherPtr = BC->getOperand(0);
723         continue;
724       }
725       if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(OtherPtr)) {
726         // All zero GEPs are effectively bitcasts.
727         if (GEP->hasAllZeroIndices()) {
728           OtherPtr = GEP->getOperand(0);
729           continue;
730         }
731       }
732       break;
733     }
734     // Copying the alloca to itself is a no-op: just delete it.
735     if (OtherPtr == AI || OtherPtr == NewElts[0]) {
736       // This code will run twice for a no-op memcpy -- once for each operand.
737       // Put only one reference to MI on the DeadInsts list.
738       for (SmallVector<Value*, 32>::const_iterator I = DeadInsts.begin(),
739              E = DeadInsts.end(); I != E; ++I)
740         if (*I == MI) return;
741       DeadInsts.push_back(MI);
742       return;
743     }
744     
745     if (ConstantExpr *BCE = dyn_cast<ConstantExpr>(OtherPtr))
746       if (BCE->getOpcode() == Instruction::BitCast)
747         OtherPtr = BCE->getOperand(0);
748     
749     // If the pointer is not the right type, insert a bitcast to the right
750     // type.
751     if (OtherPtr->getType() != AI->getType())
752       OtherPtr = new BitCastInst(OtherPtr, AI->getType(), OtherPtr->getName(),
753                                  MI);
754   }
755   
756   // Process each element of the aggregate.
757   Value *TheFn = MI->getOperand(0);
758   const Type *BytePtrTy = MI->getRawDest()->getType();
759   bool SROADest = MI->getRawDest() == Inst;
760   
761   Constant *Zero = Constant::getNullValue(Type::getInt32Ty(MI->getContext()));
762
763   for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
764     // If this is a memcpy/memmove, emit a GEP of the other element address.
765     Value *OtherElt = 0;
766     unsigned OtherEltAlign = MemAlignment;
767     
768     if (OtherPtr) {
769       Value *Idx[2] = { Zero,
770                       ConstantInt::get(Type::getInt32Ty(MI->getContext()), i) };
771       OtherElt = GetElementPtrInst::CreateInBounds(OtherPtr, Idx, Idx + 2,
772                                            OtherPtr->getNameStr()+"."+Twine(i),
773                                                    MI);
774       uint64_t EltOffset;
775       const PointerType *OtherPtrTy = cast<PointerType>(OtherPtr->getType());
776       if (const StructType *ST =
777             dyn_cast<StructType>(OtherPtrTy->getElementType())) {
778         EltOffset = TD->getStructLayout(ST)->getElementOffset(i);
779       } else {
780         const Type *EltTy =
781           cast<SequentialType>(OtherPtr->getType())->getElementType();
782         EltOffset = TD->getTypeAllocSize(EltTy)*i;
783       }
784       
785       // The alignment of the other pointer is the guaranteed alignment of the
786       // element, which is affected by both the known alignment of the whole
787       // mem intrinsic and the alignment of the element.  If the alignment of
788       // the memcpy (f.e.) is 32 but the element is at a 4-byte offset, then the
789       // known alignment is just 4 bytes.
790       OtherEltAlign = (unsigned)MinAlign(OtherEltAlign, EltOffset);
791     }
792     
793     Value *EltPtr = NewElts[i];
794     const Type *EltTy = cast<PointerType>(EltPtr->getType())->getElementType();
795     
796     // If we got down to a scalar, insert a load or store as appropriate.
797     if (EltTy->isSingleValueType()) {
798       if (isa<MemTransferInst>(MI)) {
799         if (SROADest) {
800           // From Other to Alloca.
801           Value *Elt = new LoadInst(OtherElt, "tmp", false, OtherEltAlign, MI);
802           new StoreInst(Elt, EltPtr, MI);
803         } else {
804           // From Alloca to Other.
805           Value *Elt = new LoadInst(EltPtr, "tmp", MI);
806           new StoreInst(Elt, OtherElt, false, OtherEltAlign, MI);
807         }
808         continue;
809       }
810       assert(isa<MemSetInst>(MI));
811       
812       // If the stored element is zero (common case), just store a null
813       // constant.
814       Constant *StoreVal;
815       if (ConstantInt *CI = dyn_cast<ConstantInt>(MI->getOperand(2))) {
816         if (CI->isZero()) {
817           StoreVal = Constant::getNullValue(EltTy);  // 0.0, null, 0, <0,0>
818         } else {
819           // If EltTy is a vector type, get the element type.
820           const Type *ValTy = EltTy->getScalarType();
821
822           // Construct an integer with the right value.
823           unsigned EltSize = TD->getTypeSizeInBits(ValTy);
824           APInt OneVal(EltSize, CI->getZExtValue());
825           APInt TotalVal(OneVal);
826           // Set each byte.
827           for (unsigned i = 0; 8*i < EltSize; ++i) {
828             TotalVal = TotalVal.shl(8);
829             TotalVal |= OneVal;
830           }
831           
832           // Convert the integer value to the appropriate type.
833           StoreVal = ConstantInt::get(Context, TotalVal);
834           if (isa<PointerType>(ValTy))
835             StoreVal = ConstantExpr::getIntToPtr(StoreVal, ValTy);
836           else if (ValTy->isFloatingPoint())
837             StoreVal = ConstantExpr::getBitCast(StoreVal, ValTy);
838           assert(StoreVal->getType() == ValTy && "Type mismatch!");
839           
840           // If the requested value was a vector constant, create it.
841           if (EltTy != ValTy) {
842             unsigned NumElts = cast<VectorType>(ValTy)->getNumElements();
843             SmallVector<Constant*, 16> Elts(NumElts, StoreVal);
844             StoreVal = ConstantVector::get(&Elts[0], NumElts);
845           }
846         }
847         new StoreInst(StoreVal, EltPtr, MI);
848         continue;
849       }
850       // Otherwise, if we're storing a byte variable, use a memset call for
851       // this element.
852     }
853     
854     // Cast the element pointer to BytePtrTy.
855     if (EltPtr->getType() != BytePtrTy)
856       EltPtr = new BitCastInst(EltPtr, BytePtrTy, EltPtr->getNameStr(), MI);
857     
858     // Cast the other pointer (if we have one) to BytePtrTy. 
859     if (OtherElt && OtherElt->getType() != BytePtrTy)
860       OtherElt = new BitCastInst(OtherElt, BytePtrTy,OtherElt->getNameStr(),
861                                  MI);
862     
863     unsigned EltSize = TD->getTypeAllocSize(EltTy);
864     
865     // Finally, insert the meminst for this element.
866     if (isa<MemTransferInst>(MI)) {
867       Value *Ops[] = {
868         SROADest ? EltPtr : OtherElt,  // Dest ptr
869         SROADest ? OtherElt : EltPtr,  // Src ptr
870         ConstantInt::get(MI->getOperand(3)->getType(), EltSize), // Size
871         // Align
872         ConstantInt::get(Type::getInt32Ty(MI->getContext()), OtherEltAlign)
873       };
874       CallInst::Create(TheFn, Ops, Ops + 4, "", MI);
875     } else {
876       assert(isa<MemSetInst>(MI));
877       Value *Ops[] = {
878         EltPtr, MI->getOperand(2),  // Dest, Value,
879         ConstantInt::get(MI->getOperand(3)->getType(), EltSize), // Size
880         Zero  // Align
881       };
882       CallInst::Create(TheFn, Ops, Ops + 4, "", MI);
883     }
884   }
885   DeadInsts.push_back(MI);
886 }
887
888 /// RewriteStoreUserOfWholeAlloca - We found a store of an integer that
889 /// overwrites the entire allocation.  Extract out the pieces of the stored
890 /// integer and store them individually.
891 void SROA::RewriteStoreUserOfWholeAlloca(StoreInst *SI, AllocaInst *AI,
892                                          SmallVector<AllocaInst*, 32> &NewElts){
893   // Extract each element out of the integer according to its structure offset
894   // and store the element value to the individual alloca.
895   Value *SrcVal = SI->getOperand(0);
896   const Type *AllocaEltTy = AI->getAllocatedType();
897   uint64_t AllocaSizeBits = TD->getTypeAllocSizeInBits(AllocaEltTy);
898   
899   // Handle tail padding by extending the operand
900   if (TD->getTypeSizeInBits(SrcVal->getType()) != AllocaSizeBits)
901     SrcVal = new ZExtInst(SrcVal,
902                           IntegerType::get(SI->getContext(), AllocaSizeBits), 
903                           "", SI);
904
905   DEBUG(dbgs() << "PROMOTING STORE TO WHOLE ALLOCA: " << *AI << '\n' << *SI
906                << '\n');
907
908   // There are two forms here: AI could be an array or struct.  Both cases
909   // have different ways to compute the element offset.
910   if (const StructType *EltSTy = dyn_cast<StructType>(AllocaEltTy)) {
911     const StructLayout *Layout = TD->getStructLayout(EltSTy);
912     
913     for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
914       // Get the number of bits to shift SrcVal to get the value.
915       const Type *FieldTy = EltSTy->getElementType(i);
916       uint64_t Shift = Layout->getElementOffsetInBits(i);
917       
918       if (TD->isBigEndian())
919         Shift = AllocaSizeBits-Shift-TD->getTypeAllocSizeInBits(FieldTy);
920       
921       Value *EltVal = SrcVal;
922       if (Shift) {
923         Value *ShiftVal = ConstantInt::get(EltVal->getType(), Shift);
924         EltVal = BinaryOperator::CreateLShr(EltVal, ShiftVal,
925                                             "sroa.store.elt", SI);
926       }
927       
928       // Truncate down to an integer of the right size.
929       uint64_t FieldSizeBits = TD->getTypeSizeInBits(FieldTy);
930       
931       // Ignore zero sized fields like {}, they obviously contain no data.
932       if (FieldSizeBits == 0) continue;
933       
934       if (FieldSizeBits != AllocaSizeBits)
935         EltVal = new TruncInst(EltVal,
936                              IntegerType::get(SI->getContext(), FieldSizeBits),
937                               "", SI);
938       Value *DestField = NewElts[i];
939       if (EltVal->getType() == FieldTy) {
940         // Storing to an integer field of this size, just do it.
941       } else if (FieldTy->isFloatingPoint() || isa<VectorType>(FieldTy)) {
942         // Bitcast to the right element type (for fp/vector values).
943         EltVal = new BitCastInst(EltVal, FieldTy, "", SI);
944       } else {
945         // Otherwise, bitcast the dest pointer (for aggregates).
946         DestField = new BitCastInst(DestField,
947                               PointerType::getUnqual(EltVal->getType()),
948                                     "", SI);
949       }
950       new StoreInst(EltVal, DestField, SI);
951     }
952     
953   } else {
954     const ArrayType *ATy = cast<ArrayType>(AllocaEltTy);
955     const Type *ArrayEltTy = ATy->getElementType();
956     uint64_t ElementOffset = TD->getTypeAllocSizeInBits(ArrayEltTy);
957     uint64_t ElementSizeBits = TD->getTypeSizeInBits(ArrayEltTy);
958
959     uint64_t Shift;
960     
961     if (TD->isBigEndian())
962       Shift = AllocaSizeBits-ElementOffset;
963     else 
964       Shift = 0;
965     
966     for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
967       // Ignore zero sized fields like {}, they obviously contain no data.
968       if (ElementSizeBits == 0) continue;
969       
970       Value *EltVal = SrcVal;
971       if (Shift) {
972         Value *ShiftVal = ConstantInt::get(EltVal->getType(), Shift);
973         EltVal = BinaryOperator::CreateLShr(EltVal, ShiftVal,
974                                             "sroa.store.elt", SI);
975       }
976       
977       // Truncate down to an integer of the right size.
978       if (ElementSizeBits != AllocaSizeBits)
979         EltVal = new TruncInst(EltVal, 
980                                IntegerType::get(SI->getContext(), 
981                                                 ElementSizeBits),"",SI);
982       Value *DestField = NewElts[i];
983       if (EltVal->getType() == ArrayEltTy) {
984         // Storing to an integer field of this size, just do it.
985       } else if (ArrayEltTy->isFloatingPoint() || isa<VectorType>(ArrayEltTy)) {
986         // Bitcast to the right element type (for fp/vector values).
987         EltVal = new BitCastInst(EltVal, ArrayEltTy, "", SI);
988       } else {
989         // Otherwise, bitcast the dest pointer (for aggregates).
990         DestField = new BitCastInst(DestField,
991                               PointerType::getUnqual(EltVal->getType()),
992                                     "", SI);
993       }
994       new StoreInst(EltVal, DestField, SI);
995       
996       if (TD->isBigEndian())
997         Shift -= ElementOffset;
998       else 
999         Shift += ElementOffset;
1000     }
1001   }
1002   
1003   DeadInsts.push_back(SI);
1004 }
1005
1006 /// RewriteLoadUserOfWholeAlloca - We found a load of the entire allocation to
1007 /// an integer.  Load the individual pieces to form the aggregate value.
1008 void SROA::RewriteLoadUserOfWholeAlloca(LoadInst *LI, AllocaInst *AI,
1009                                         SmallVector<AllocaInst*, 32> &NewElts) {
1010   // Extract each element out of the NewElts according to its structure offset
1011   // and form the result value.
1012   const Type *AllocaEltTy = AI->getAllocatedType();
1013   uint64_t AllocaSizeBits = TD->getTypeAllocSizeInBits(AllocaEltTy);
1014   
1015   DEBUG(dbgs() << "PROMOTING LOAD OF WHOLE ALLOCA: " << *AI << '\n' << *LI
1016                << '\n');
1017   
1018   // There are two forms here: AI could be an array or struct.  Both cases
1019   // have different ways to compute the element offset.
1020   const StructLayout *Layout = 0;
1021   uint64_t ArrayEltBitOffset = 0;
1022   if (const StructType *EltSTy = dyn_cast<StructType>(AllocaEltTy)) {
1023     Layout = TD->getStructLayout(EltSTy);
1024   } else {
1025     const Type *ArrayEltTy = cast<ArrayType>(AllocaEltTy)->getElementType();
1026     ArrayEltBitOffset = TD->getTypeAllocSizeInBits(ArrayEltTy);
1027   }    
1028   
1029   Value *ResultVal = 
1030     Constant::getNullValue(IntegerType::get(LI->getContext(), AllocaSizeBits));
1031   
1032   for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
1033     // Load the value from the alloca.  If the NewElt is an aggregate, cast
1034     // the pointer to an integer of the same size before doing the load.
1035     Value *SrcField = NewElts[i];
1036     const Type *FieldTy =
1037       cast<PointerType>(SrcField->getType())->getElementType();
1038     uint64_t FieldSizeBits = TD->getTypeSizeInBits(FieldTy);
1039     
1040     // Ignore zero sized fields like {}, they obviously contain no data.
1041     if (FieldSizeBits == 0) continue;
1042     
1043     const IntegerType *FieldIntTy = IntegerType::get(LI->getContext(), 
1044                                                      FieldSizeBits);
1045     if (!isa<IntegerType>(FieldTy) && !FieldTy->isFloatingPoint() &&
1046         !isa<VectorType>(FieldTy))
1047       SrcField = new BitCastInst(SrcField,
1048                                  PointerType::getUnqual(FieldIntTy),
1049                                  "", LI);
1050     SrcField = new LoadInst(SrcField, "sroa.load.elt", LI);
1051
1052     // If SrcField is a fp or vector of the right size but that isn't an
1053     // integer type, bitcast to an integer so we can shift it.
1054     if (SrcField->getType() != FieldIntTy)
1055       SrcField = new BitCastInst(SrcField, FieldIntTy, "", LI);
1056
1057     // Zero extend the field to be the same size as the final alloca so that
1058     // we can shift and insert it.
1059     if (SrcField->getType() != ResultVal->getType())
1060       SrcField = new ZExtInst(SrcField, ResultVal->getType(), "", LI);
1061     
1062     // Determine the number of bits to shift SrcField.
1063     uint64_t Shift;
1064     if (Layout) // Struct case.
1065       Shift = Layout->getElementOffsetInBits(i);
1066     else  // Array case.
1067       Shift = i*ArrayEltBitOffset;
1068     
1069     if (TD->isBigEndian())
1070       Shift = AllocaSizeBits-Shift-FieldIntTy->getBitWidth();
1071     
1072     if (Shift) {
1073       Value *ShiftVal = ConstantInt::get(SrcField->getType(), Shift);
1074       SrcField = BinaryOperator::CreateShl(SrcField, ShiftVal, "", LI);
1075     }
1076
1077     ResultVal = BinaryOperator::CreateOr(SrcField, ResultVal, "", LI);
1078   }
1079
1080   // Handle tail padding by truncating the result
1081   if (TD->getTypeSizeInBits(LI->getType()) != AllocaSizeBits)
1082     ResultVal = new TruncInst(ResultVal, LI->getType(), "", LI);
1083
1084   LI->replaceAllUsesWith(ResultVal);
1085   DeadInsts.push_back(LI);
1086 }
1087
1088 /// HasPadding - Return true if the specified type has any structure or
1089 /// alignment padding, false otherwise.
1090 static bool HasPadding(const Type *Ty, const TargetData &TD) {
1091   if (const StructType *STy = dyn_cast<StructType>(Ty)) {
1092     const StructLayout *SL = TD.getStructLayout(STy);
1093     unsigned PrevFieldBitOffset = 0;
1094     for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
1095       unsigned FieldBitOffset = SL->getElementOffsetInBits(i);
1096
1097       // Padding in sub-elements?
1098       if (HasPadding(STy->getElementType(i), TD))
1099         return true;
1100
1101       // Check to see if there is any padding between this element and the
1102       // previous one.
1103       if (i) {
1104         unsigned PrevFieldEnd =
1105         PrevFieldBitOffset+TD.getTypeSizeInBits(STy->getElementType(i-1));
1106         if (PrevFieldEnd < FieldBitOffset)
1107           return true;
1108       }
1109
1110       PrevFieldBitOffset = FieldBitOffset;
1111     }
1112
1113     //  Check for tail padding.
1114     if (unsigned EltCount = STy->getNumElements()) {
1115       unsigned PrevFieldEnd = PrevFieldBitOffset +
1116                    TD.getTypeSizeInBits(STy->getElementType(EltCount-1));
1117       if (PrevFieldEnd < SL->getSizeInBits())
1118         return true;
1119     }
1120
1121   } else if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
1122     return HasPadding(ATy->getElementType(), TD);
1123   } else if (const VectorType *VTy = dyn_cast<VectorType>(Ty)) {
1124     return HasPadding(VTy->getElementType(), TD);
1125   }
1126   return TD.getTypeSizeInBits(Ty) != TD.getTypeAllocSizeInBits(Ty);
1127 }
1128
1129 /// isSafeStructAllocaToScalarRepl - Check to see if the specified allocation of
1130 /// an aggregate can be broken down into elements.  Return 0 if not, 3 if safe,
1131 /// or 1 if safe after canonicalization has been performed.
1132 bool SROA::isSafeAllocaToScalarRepl(AllocaInst *AI) {
1133   // Loop over the use list of the alloca.  We can only transform it if all of
1134   // the users are safe to transform.
1135   AllocaInfo Info;
1136   
1137   isSafeForScalarRepl(AI, AI, 0, Info);
1138   if (Info.isUnsafe) {
1139     DEBUG(dbgs() << "Cannot transform: " << *AI << '\n');
1140     return false;
1141   }
1142   
1143   // Okay, we know all the users are promotable.  If the aggregate is a memcpy
1144   // source and destination, we have to be careful.  In particular, the memcpy
1145   // could be moving around elements that live in structure padding of the LLVM
1146   // types, but may actually be used.  In these cases, we refuse to promote the
1147   // struct.
1148   if (Info.isMemCpySrc && Info.isMemCpyDst &&
1149       HasPadding(AI->getAllocatedType(), *TD))
1150     return false;
1151
1152   return true;
1153 }
1154
1155 /// MergeInType - Add the 'In' type to the accumulated type (Accum) so far at
1156 /// the offset specified by Offset (which is specified in bytes).
1157 ///
1158 /// There are two cases we handle here:
1159 ///   1) A union of vector types of the same size and potentially its elements.
1160 ///      Here we turn element accesses into insert/extract element operations.
1161 ///      This promotes a <4 x float> with a store of float to the third element
1162 ///      into a <4 x float> that uses insert element.
1163 ///   2) A fully general blob of memory, which we turn into some (potentially
1164 ///      large) integer type with extract and insert operations where the loads
1165 ///      and stores would mutate the memory.
1166 static void MergeInType(const Type *In, uint64_t Offset, const Type *&VecTy,
1167                         unsigned AllocaSize, const TargetData &TD,
1168                         LLVMContext &Context) {
1169   // If this could be contributing to a vector, analyze it.
1170   if (VecTy != Type::getVoidTy(Context)) { // either null or a vector type.
1171
1172     // If the In type is a vector that is the same size as the alloca, see if it
1173     // matches the existing VecTy.
1174     if (const VectorType *VInTy = dyn_cast<VectorType>(In)) {
1175       if (VInTy->getBitWidth()/8 == AllocaSize && Offset == 0) {
1176         // If we're storing/loading a vector of the right size, allow it as a
1177         // vector.  If this the first vector we see, remember the type so that
1178         // we know the element size.
1179         if (VecTy == 0)
1180           VecTy = VInTy;
1181         return;
1182       }
1183     } else if (In->isFloatTy() || In->isDoubleTy() ||
1184                (isa<IntegerType>(In) && In->getPrimitiveSizeInBits() >= 8 &&
1185                 isPowerOf2_32(In->getPrimitiveSizeInBits()))) {
1186       // If we're accessing something that could be an element of a vector, see
1187       // if the implied vector agrees with what we already have and if Offset is
1188       // compatible with it.
1189       unsigned EltSize = In->getPrimitiveSizeInBits()/8;
1190       if (Offset % EltSize == 0 &&
1191           AllocaSize % EltSize == 0 &&
1192           (VecTy == 0 || 
1193            cast<VectorType>(VecTy)->getElementType()
1194                  ->getPrimitiveSizeInBits()/8 == EltSize)) {
1195         if (VecTy == 0)
1196           VecTy = VectorType::get(In, AllocaSize/EltSize);
1197         return;
1198       }
1199     }
1200   }
1201   
1202   // Otherwise, we have a case that we can't handle with an optimized vector
1203   // form.  We can still turn this into a large integer.
1204   VecTy = Type::getVoidTy(Context);
1205 }
1206
1207 /// CanConvertToScalar - V is a pointer.  If we can convert the pointee and all
1208 /// its accesses to a single vector type, return true and set VecTy to
1209 /// the new type.  If we could convert the alloca into a single promotable
1210 /// integer, return true but set VecTy to VoidTy.  Further, if the use is not a
1211 /// completely trivial use that mem2reg could promote, set IsNotTrivial.  Offset
1212 /// is the current offset from the base of the alloca being analyzed.
1213 ///
1214 /// If we see at least one access to the value that is as a vector type, set the
1215 /// SawVec flag.
1216 bool SROA::CanConvertToScalar(Value *V, bool &IsNotTrivial, const Type *&VecTy,
1217                               bool &SawVec, uint64_t Offset,
1218                               unsigned AllocaSize) {
1219   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI!=E; ++UI) {
1220     Instruction *User = cast<Instruction>(*UI);
1221     
1222     if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
1223       // Don't break volatile loads.
1224       if (LI->isVolatile())
1225         return false;
1226       MergeInType(LI->getType(), Offset, VecTy,
1227                   AllocaSize, *TD, V->getContext());
1228       SawVec |= isa<VectorType>(LI->getType());
1229       continue;
1230     }
1231     
1232     if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
1233       // Storing the pointer, not into the value?
1234       if (SI->getOperand(0) == V || SI->isVolatile()) return 0;
1235       MergeInType(SI->getOperand(0)->getType(), Offset,
1236                   VecTy, AllocaSize, *TD, V->getContext());
1237       SawVec |= isa<VectorType>(SI->getOperand(0)->getType());
1238       continue;
1239     }
1240     
1241     if (BitCastInst *BCI = dyn_cast<BitCastInst>(User)) {
1242       if (!CanConvertToScalar(BCI, IsNotTrivial, VecTy, SawVec, Offset,
1243                               AllocaSize))
1244         return false;
1245       IsNotTrivial = true;
1246       continue;
1247     }
1248
1249     if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(User)) {
1250       // If this is a GEP with a variable indices, we can't handle it.
1251       if (!GEP->hasAllConstantIndices())
1252         return false;
1253       
1254       // Compute the offset that this GEP adds to the pointer.
1255       SmallVector<Value*, 8> Indices(GEP->op_begin()+1, GEP->op_end());
1256       uint64_t GEPOffset = TD->getIndexedOffset(GEP->getPointerOperandType(),
1257                                                 &Indices[0], Indices.size());
1258       // See if all uses can be converted.
1259       if (!CanConvertToScalar(GEP, IsNotTrivial, VecTy, SawVec,Offset+GEPOffset,
1260                               AllocaSize))
1261         return false;
1262       IsNotTrivial = true;
1263       continue;
1264     }
1265
1266     // If this is a constant sized memset of a constant value (e.g. 0) we can
1267     // handle it.
1268     if (MemSetInst *MSI = dyn_cast<MemSetInst>(User)) {
1269       // Store of constant value and constant size.
1270       if (isa<ConstantInt>(MSI->getValue()) &&
1271           isa<ConstantInt>(MSI->getLength())) {
1272         IsNotTrivial = true;
1273         continue;
1274       }
1275     }
1276
1277     // If this is a memcpy or memmove into or out of the whole allocation, we
1278     // can handle it like a load or store of the scalar type.
1279     if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(User)) {
1280       if (ConstantInt *Len = dyn_cast<ConstantInt>(MTI->getLength()))
1281         if (Len->getZExtValue() == AllocaSize && Offset == 0) {
1282           IsNotTrivial = true;
1283           continue;
1284         }
1285     }
1286     
1287     // Otherwise, we cannot handle this!
1288     return false;
1289   }
1290   
1291   return true;
1292 }
1293
1294 /// ConvertUsesToScalar - Convert all of the users of Ptr to use the new alloca
1295 /// directly.  This happens when we are converting an "integer union" to a
1296 /// single integer scalar, or when we are converting a "vector union" to a
1297 /// vector with insert/extractelement instructions.
1298 ///
1299 /// Offset is an offset from the original alloca, in bits that need to be
1300 /// shifted to the right.  By the end of this, there should be no uses of Ptr.
1301 void SROA::ConvertUsesToScalar(Value *Ptr, AllocaInst *NewAI, uint64_t Offset) {
1302   while (!Ptr->use_empty()) {
1303     Instruction *User = cast<Instruction>(Ptr->use_back());
1304
1305     if (BitCastInst *CI = dyn_cast<BitCastInst>(User)) {
1306       ConvertUsesToScalar(CI, NewAI, Offset);
1307       CI->eraseFromParent();
1308       continue;
1309     }
1310
1311     if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(User)) {
1312       // Compute the offset that this GEP adds to the pointer.
1313       SmallVector<Value*, 8> Indices(GEP->op_begin()+1, GEP->op_end());
1314       uint64_t GEPOffset = TD->getIndexedOffset(GEP->getPointerOperandType(),
1315                                                 &Indices[0], Indices.size());
1316       ConvertUsesToScalar(GEP, NewAI, Offset+GEPOffset*8);
1317       GEP->eraseFromParent();
1318       continue;
1319     }
1320     
1321     IRBuilder<> Builder(User->getParent(), User);
1322     
1323     if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
1324       // The load is a bit extract from NewAI shifted right by Offset bits.
1325       Value *LoadedVal = Builder.CreateLoad(NewAI, "tmp");
1326       Value *NewLoadVal
1327         = ConvertScalar_ExtractValue(LoadedVal, LI->getType(), Offset, Builder);
1328       LI->replaceAllUsesWith(NewLoadVal);
1329       LI->eraseFromParent();
1330       continue;
1331     }
1332     
1333     if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
1334       assert(SI->getOperand(0) != Ptr && "Consistency error!");
1335       Instruction *Old = Builder.CreateLoad(NewAI, NewAI->getName()+".in");
1336       Value *New = ConvertScalar_InsertValue(SI->getOperand(0), Old, Offset,
1337                                              Builder);
1338       Builder.CreateStore(New, NewAI);
1339       SI->eraseFromParent();
1340       
1341       // If the load we just inserted is now dead, then the inserted store
1342       // overwrote the entire thing.
1343       if (Old->use_empty())
1344         Old->eraseFromParent();
1345       continue;
1346     }
1347     
1348     // If this is a constant sized memset of a constant value (e.g. 0) we can
1349     // transform it into a store of the expanded constant value.
1350     if (MemSetInst *MSI = dyn_cast<MemSetInst>(User)) {
1351       assert(MSI->getRawDest() == Ptr && "Consistency error!");
1352       unsigned NumBytes = cast<ConstantInt>(MSI->getLength())->getZExtValue();
1353       if (NumBytes != 0) {
1354         unsigned Val = cast<ConstantInt>(MSI->getValue())->getZExtValue();
1355         
1356         // Compute the value replicated the right number of times.
1357         APInt APVal(NumBytes*8, Val);
1358
1359         // Splat the value if non-zero.
1360         if (Val)
1361           for (unsigned i = 1; i != NumBytes; ++i)
1362             APVal |= APVal << 8;
1363         
1364         Instruction *Old = Builder.CreateLoad(NewAI, NewAI->getName()+".in");
1365         Value *New = ConvertScalar_InsertValue(
1366                                     ConstantInt::get(User->getContext(), APVal),
1367                                                Old, Offset, Builder);
1368         Builder.CreateStore(New, NewAI);
1369         
1370         // If the load we just inserted is now dead, then the memset overwrote
1371         // the entire thing.
1372         if (Old->use_empty())
1373           Old->eraseFromParent();        
1374       }
1375       MSI->eraseFromParent();
1376       continue;
1377     }
1378
1379     // If this is a memcpy or memmove into or out of the whole allocation, we
1380     // can handle it like a load or store of the scalar type.
1381     if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(User)) {
1382       assert(Offset == 0 && "must be store to start of alloca");
1383       
1384       // If the source and destination are both to the same alloca, then this is
1385       // a noop copy-to-self, just delete it.  Otherwise, emit a load and store
1386       // as appropriate.
1387       AllocaInst *OrigAI = cast<AllocaInst>(Ptr->getUnderlyingObject());
1388       
1389       if (MTI->getSource()->getUnderlyingObject() != OrigAI) {
1390         // Dest must be OrigAI, change this to be a load from the original
1391         // pointer (bitcasted), then a store to our new alloca.
1392         assert(MTI->getRawDest() == Ptr && "Neither use is of pointer?");
1393         Value *SrcPtr = MTI->getSource();
1394         SrcPtr = Builder.CreateBitCast(SrcPtr, NewAI->getType());
1395         
1396         LoadInst *SrcVal = Builder.CreateLoad(SrcPtr, "srcval");
1397         SrcVal->setAlignment(MTI->getAlignment());
1398         Builder.CreateStore(SrcVal, NewAI);
1399       } else if (MTI->getDest()->getUnderlyingObject() != OrigAI) {
1400         // Src must be OrigAI, change this to be a load from NewAI then a store
1401         // through the original dest pointer (bitcasted).
1402         assert(MTI->getRawSource() == Ptr && "Neither use is of pointer?");
1403         LoadInst *SrcVal = Builder.CreateLoad(NewAI, "srcval");
1404
1405         Value *DstPtr = Builder.CreateBitCast(MTI->getDest(), NewAI->getType());
1406         StoreInst *NewStore = Builder.CreateStore(SrcVal, DstPtr);
1407         NewStore->setAlignment(MTI->getAlignment());
1408       } else {
1409         // Noop transfer. Src == Dst
1410       }
1411
1412       MTI->eraseFromParent();
1413       continue;
1414     }
1415     
1416     llvm_unreachable("Unsupported operation!");
1417   }
1418 }
1419
1420 /// ConvertScalar_ExtractValue - Extract a value of type ToType from an integer
1421 /// or vector value FromVal, extracting the bits from the offset specified by
1422 /// Offset.  This returns the value, which is of type ToType.
1423 ///
1424 /// This happens when we are converting an "integer union" to a single
1425 /// integer scalar, or when we are converting a "vector union" to a vector with
1426 /// insert/extractelement instructions.
1427 ///
1428 /// Offset is an offset from the original alloca, in bits that need to be
1429 /// shifted to the right.
1430 Value *SROA::ConvertScalar_ExtractValue(Value *FromVal, const Type *ToType,
1431                                         uint64_t Offset, IRBuilder<> &Builder) {
1432   // If the load is of the whole new alloca, no conversion is needed.
1433   if (FromVal->getType() == ToType && Offset == 0)
1434     return FromVal;
1435
1436   // If the result alloca is a vector type, this is either an element
1437   // access or a bitcast to another vector type of the same size.
1438   if (const VectorType *VTy = dyn_cast<VectorType>(FromVal->getType())) {
1439     if (isa<VectorType>(ToType))
1440       return Builder.CreateBitCast(FromVal, ToType, "tmp");
1441
1442     // Otherwise it must be an element access.
1443     unsigned Elt = 0;
1444     if (Offset) {
1445       unsigned EltSize = TD->getTypeAllocSizeInBits(VTy->getElementType());
1446       Elt = Offset/EltSize;
1447       assert(EltSize*Elt == Offset && "Invalid modulus in validity checking");
1448     }
1449     // Return the element extracted out of it.
1450     Value *V = Builder.CreateExtractElement(FromVal, ConstantInt::get(
1451                     Type::getInt32Ty(FromVal->getContext()), Elt), "tmp");
1452     if (V->getType() != ToType)
1453       V = Builder.CreateBitCast(V, ToType, "tmp");
1454     return V;
1455   }
1456   
1457   // If ToType is a first class aggregate, extract out each of the pieces and
1458   // use insertvalue's to form the FCA.
1459   if (const StructType *ST = dyn_cast<StructType>(ToType)) {
1460     const StructLayout &Layout = *TD->getStructLayout(ST);
1461     Value *Res = UndefValue::get(ST);
1462     for (unsigned i = 0, e = ST->getNumElements(); i != e; ++i) {
1463       Value *Elt = ConvertScalar_ExtractValue(FromVal, ST->getElementType(i),
1464                                         Offset+Layout.getElementOffsetInBits(i),
1465                                               Builder);
1466       Res = Builder.CreateInsertValue(Res, Elt, i, "tmp");
1467     }
1468     return Res;
1469   }
1470   
1471   if (const ArrayType *AT = dyn_cast<ArrayType>(ToType)) {
1472     uint64_t EltSize = TD->getTypeAllocSizeInBits(AT->getElementType());
1473     Value *Res = UndefValue::get(AT);
1474     for (unsigned i = 0, e = AT->getNumElements(); i != e; ++i) {
1475       Value *Elt = ConvertScalar_ExtractValue(FromVal, AT->getElementType(),
1476                                               Offset+i*EltSize, Builder);
1477       Res = Builder.CreateInsertValue(Res, Elt, i, "tmp");
1478     }
1479     return Res;
1480   }
1481
1482   // Otherwise, this must be a union that was converted to an integer value.
1483   const IntegerType *NTy = cast<IntegerType>(FromVal->getType());
1484
1485   // If this is a big-endian system and the load is narrower than the
1486   // full alloca type, we need to do a shift to get the right bits.
1487   int ShAmt = 0;
1488   if (TD->isBigEndian()) {
1489     // On big-endian machines, the lowest bit is stored at the bit offset
1490     // from the pointer given by getTypeStoreSizeInBits.  This matters for
1491     // integers with a bitwidth that is not a multiple of 8.
1492     ShAmt = TD->getTypeStoreSizeInBits(NTy) -
1493             TD->getTypeStoreSizeInBits(ToType) - Offset;
1494   } else {
1495     ShAmt = Offset;
1496   }
1497
1498   // Note: we support negative bitwidths (with shl) which are not defined.
1499   // We do this to support (f.e.) loads off the end of a structure where
1500   // only some bits are used.
1501   if (ShAmt > 0 && (unsigned)ShAmt < NTy->getBitWidth())
1502     FromVal = Builder.CreateLShr(FromVal,
1503                                  ConstantInt::get(FromVal->getType(),
1504                                                            ShAmt), "tmp");
1505   else if (ShAmt < 0 && (unsigned)-ShAmt < NTy->getBitWidth())
1506     FromVal = Builder.CreateShl(FromVal, 
1507                                 ConstantInt::get(FromVal->getType(),
1508                                                           -ShAmt), "tmp");
1509
1510   // Finally, unconditionally truncate the integer to the right width.
1511   unsigned LIBitWidth = TD->getTypeSizeInBits(ToType);
1512   if (LIBitWidth < NTy->getBitWidth())
1513     FromVal =
1514       Builder.CreateTrunc(FromVal, IntegerType::get(FromVal->getContext(), 
1515                                                     LIBitWidth), "tmp");
1516   else if (LIBitWidth > NTy->getBitWidth())
1517     FromVal =
1518        Builder.CreateZExt(FromVal, IntegerType::get(FromVal->getContext(), 
1519                                                     LIBitWidth), "tmp");
1520
1521   // If the result is an integer, this is a trunc or bitcast.
1522   if (isa<IntegerType>(ToType)) {
1523     // Should be done.
1524   } else if (ToType->isFloatingPoint() || isa<VectorType>(ToType)) {
1525     // Just do a bitcast, we know the sizes match up.
1526     FromVal = Builder.CreateBitCast(FromVal, ToType, "tmp");
1527   } else {
1528     // Otherwise must be a pointer.
1529     FromVal = Builder.CreateIntToPtr(FromVal, ToType, "tmp");
1530   }
1531   assert(FromVal->getType() == ToType && "Didn't convert right?");
1532   return FromVal;
1533 }
1534
1535 /// ConvertScalar_InsertValue - Insert the value "SV" into the existing integer
1536 /// or vector value "Old" at the offset specified by Offset.
1537 ///
1538 /// This happens when we are converting an "integer union" to a
1539 /// single integer scalar, or when we are converting a "vector union" to a
1540 /// vector with insert/extractelement instructions.
1541 ///
1542 /// Offset is an offset from the original alloca, in bits that need to be
1543 /// shifted to the right.
1544 Value *SROA::ConvertScalar_InsertValue(Value *SV, Value *Old,
1545                                        uint64_t Offset, IRBuilder<> &Builder) {
1546
1547   // Convert the stored type to the actual type, shift it left to insert
1548   // then 'or' into place.
1549   const Type *AllocaType = Old->getType();
1550   LLVMContext &Context = Old->getContext();
1551
1552   if (const VectorType *VTy = dyn_cast<VectorType>(AllocaType)) {
1553     uint64_t VecSize = TD->getTypeAllocSizeInBits(VTy);
1554     uint64_t ValSize = TD->getTypeAllocSizeInBits(SV->getType());
1555     
1556     // Changing the whole vector with memset or with an access of a different
1557     // vector type?
1558     if (ValSize == VecSize)
1559       return Builder.CreateBitCast(SV, AllocaType, "tmp");
1560
1561     uint64_t EltSize = TD->getTypeAllocSizeInBits(VTy->getElementType());
1562
1563     // Must be an element insertion.
1564     unsigned Elt = Offset/EltSize;
1565     
1566     if (SV->getType() != VTy->getElementType())
1567       SV = Builder.CreateBitCast(SV, VTy->getElementType(), "tmp");
1568     
1569     SV = Builder.CreateInsertElement(Old, SV, 
1570                      ConstantInt::get(Type::getInt32Ty(SV->getContext()), Elt),
1571                                      "tmp");
1572     return SV;
1573   }
1574   
1575   // If SV is a first-class aggregate value, insert each value recursively.
1576   if (const StructType *ST = dyn_cast<StructType>(SV->getType())) {
1577     const StructLayout &Layout = *TD->getStructLayout(ST);
1578     for (unsigned i = 0, e = ST->getNumElements(); i != e; ++i) {
1579       Value *Elt = Builder.CreateExtractValue(SV, i, "tmp");
1580       Old = ConvertScalar_InsertValue(Elt, Old, 
1581                                       Offset+Layout.getElementOffsetInBits(i),
1582                                       Builder);
1583     }
1584     return Old;
1585   }
1586   
1587   if (const ArrayType *AT = dyn_cast<ArrayType>(SV->getType())) {
1588     uint64_t EltSize = TD->getTypeAllocSizeInBits(AT->getElementType());
1589     for (unsigned i = 0, e = AT->getNumElements(); i != e; ++i) {
1590       Value *Elt = Builder.CreateExtractValue(SV, i, "tmp");
1591       Old = ConvertScalar_InsertValue(Elt, Old, Offset+i*EltSize, Builder);
1592     }
1593     return Old;
1594   }
1595
1596   // If SV is a float, convert it to the appropriate integer type.
1597   // If it is a pointer, do the same.
1598   unsigned SrcWidth = TD->getTypeSizeInBits(SV->getType());
1599   unsigned DestWidth = TD->getTypeSizeInBits(AllocaType);
1600   unsigned SrcStoreWidth = TD->getTypeStoreSizeInBits(SV->getType());
1601   unsigned DestStoreWidth = TD->getTypeStoreSizeInBits(AllocaType);
1602   if (SV->getType()->isFloatingPoint() || isa<VectorType>(SV->getType()))
1603     SV = Builder.CreateBitCast(SV,
1604                             IntegerType::get(SV->getContext(),SrcWidth), "tmp");
1605   else if (isa<PointerType>(SV->getType()))
1606     SV = Builder.CreatePtrToInt(SV, TD->getIntPtrType(SV->getContext()), "tmp");
1607
1608   // Zero extend or truncate the value if needed.
1609   if (SV->getType() != AllocaType) {
1610     if (SV->getType()->getPrimitiveSizeInBits() <
1611              AllocaType->getPrimitiveSizeInBits())
1612       SV = Builder.CreateZExt(SV, AllocaType, "tmp");
1613     else {
1614       // Truncation may be needed if storing more than the alloca can hold
1615       // (undefined behavior).
1616       SV = Builder.CreateTrunc(SV, AllocaType, "tmp");
1617       SrcWidth = DestWidth;
1618       SrcStoreWidth = DestStoreWidth;
1619     }
1620   }
1621
1622   // If this is a big-endian system and the store is narrower than the
1623   // full alloca type, we need to do a shift to get the right bits.
1624   int ShAmt = 0;
1625   if (TD->isBigEndian()) {
1626     // On big-endian machines, the lowest bit is stored at the bit offset
1627     // from the pointer given by getTypeStoreSizeInBits.  This matters for
1628     // integers with a bitwidth that is not a multiple of 8.
1629     ShAmt = DestStoreWidth - SrcStoreWidth - Offset;
1630   } else {
1631     ShAmt = Offset;
1632   }
1633
1634   // Note: we support negative bitwidths (with shr) which are not defined.
1635   // We do this to support (f.e.) stores off the end of a structure where
1636   // only some bits in the structure are set.
1637   APInt Mask(APInt::getLowBitsSet(DestWidth, SrcWidth));
1638   if (ShAmt > 0 && (unsigned)ShAmt < DestWidth) {
1639     SV = Builder.CreateShl(SV, ConstantInt::get(SV->getType(),
1640                            ShAmt), "tmp");
1641     Mask <<= ShAmt;
1642   } else if (ShAmt < 0 && (unsigned)-ShAmt < DestWidth) {
1643     SV = Builder.CreateLShr(SV, ConstantInt::get(SV->getType(),
1644                             -ShAmt), "tmp");
1645     Mask = Mask.lshr(-ShAmt);
1646   }
1647
1648   // Mask out the bits we are about to insert from the old value, and or
1649   // in the new bits.
1650   if (SrcWidth != DestWidth) {
1651     assert(DestWidth > SrcWidth);
1652     Old = Builder.CreateAnd(Old, ConstantInt::get(Context, ~Mask), "mask");
1653     SV = Builder.CreateOr(Old, SV, "ins");
1654   }
1655   return SV;
1656 }
1657
1658
1659
1660 /// PointsToConstantGlobal - Return true if V (possibly indirectly) points to
1661 /// some part of a constant global variable.  This intentionally only accepts
1662 /// constant expressions because we don't can't rewrite arbitrary instructions.
1663 static bool PointsToConstantGlobal(Value *V) {
1664   if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
1665     return GV->isConstant();
1666   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
1667     if (CE->getOpcode() == Instruction::BitCast || 
1668         CE->getOpcode() == Instruction::GetElementPtr)
1669       return PointsToConstantGlobal(CE->getOperand(0));
1670   return false;
1671 }
1672
1673 /// isOnlyCopiedFromConstantGlobal - Recursively walk the uses of a (derived)
1674 /// pointer to an alloca.  Ignore any reads of the pointer, return false if we
1675 /// see any stores or other unknown uses.  If we see pointer arithmetic, keep
1676 /// track of whether it moves the pointer (with isOffset) but otherwise traverse
1677 /// the uses.  If we see a memcpy/memmove that targets an unoffseted pointer to
1678 /// the alloca, and if the source pointer is a pointer to a constant  global, we
1679 /// can optimize this.
1680 static bool isOnlyCopiedFromConstantGlobal(Value *V, Instruction *&TheCopy,
1681                                            bool isOffset) {
1682   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI!=E; ++UI) {
1683     if (LoadInst *LI = dyn_cast<LoadInst>(*UI))
1684       // Ignore non-volatile loads, they are always ok.
1685       if (!LI->isVolatile())
1686         continue;
1687     
1688     if (BitCastInst *BCI = dyn_cast<BitCastInst>(*UI)) {
1689       // If uses of the bitcast are ok, we are ok.
1690       if (!isOnlyCopiedFromConstantGlobal(BCI, TheCopy, isOffset))
1691         return false;
1692       continue;
1693     }
1694     if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(*UI)) {
1695       // If the GEP has all zero indices, it doesn't offset the pointer.  If it
1696       // doesn't, it does.
1697       if (!isOnlyCopiedFromConstantGlobal(GEP, TheCopy,
1698                                          isOffset || !GEP->hasAllZeroIndices()))
1699         return false;
1700       continue;
1701     }
1702     
1703     // If this is isn't our memcpy/memmove, reject it as something we can't
1704     // handle.
1705     if (!isa<MemTransferInst>(*UI))
1706       return false;
1707
1708     // If we already have seen a copy, reject the second one.
1709     if (TheCopy) return false;
1710     
1711     // If the pointer has been offset from the start of the alloca, we can't
1712     // safely handle this.
1713     if (isOffset) return false;
1714
1715     // If the memintrinsic isn't using the alloca as the dest, reject it.
1716     if (UI.getOperandNo() != 1) return false;
1717     
1718     MemIntrinsic *MI = cast<MemIntrinsic>(*UI);
1719     
1720     // If the source of the memcpy/move is not a constant global, reject it.
1721     if (!PointsToConstantGlobal(MI->getOperand(2)))
1722       return false;
1723     
1724     // Otherwise, the transform is safe.  Remember the copy instruction.
1725     TheCopy = MI;
1726   }
1727   return true;
1728 }
1729
1730 /// isOnlyCopiedFromConstantGlobal - Return true if the specified alloca is only
1731 /// modified by a copy from a constant global.  If we can prove this, we can
1732 /// replace any uses of the alloca with uses of the global directly.
1733 Instruction *SROA::isOnlyCopiedFromConstantGlobal(AllocaInst *AI) {
1734   Instruction *TheCopy = 0;
1735   if (::isOnlyCopiedFromConstantGlobal(AI, TheCopy, false))
1736     return TheCopy;
1737   return 0;
1738 }