blob: e0674492f892e678a69abe693297546b0fa03cbe [file] [log] [blame]
Chris Lattnered7b41e2003-05-27 15:45:27 +00001//===- ScalarReplAggregates.cpp - Scalar Replacement of Aggregates --------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanfd939082005-04-21 23:48:37 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattnered7b41e2003-05-27 15:45:27 +00009//
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
Chris Lattner38aec322003-09-11 16:45:55 +000013// 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.
Chris Lattnered7b41e2003-05-27 15:45:27 +000019//
20//===----------------------------------------------------------------------===//
21
Chris Lattner0e5f4992006-12-19 21:40:18 +000022#define DEBUG_TYPE "scalarrepl"
Chris Lattnered7b41e2003-05-27 15:45:27 +000023#include "llvm/Transforms/Scalar.h"
Chris Lattner38aec322003-09-11 16:45:55 +000024#include "llvm/Constants.h"
25#include "llvm/DerivedTypes.h"
Chris Lattnered7b41e2003-05-27 15:45:27 +000026#include "llvm/Function.h"
Chris Lattner79b3bd32007-04-25 06:40:51 +000027#include "llvm/GlobalVariable.h"
Misha Brukmand8e1eea2004-07-29 17:05:13 +000028#include "llvm/Instructions.h"
Chris Lattner372dda82007-03-05 07:52:57 +000029#include "llvm/IntrinsicInst.h"
Owen Andersonfa5cbd62009-07-03 19:42:02 +000030#include "llvm/LLVMContext.h"
Chris Lattner72eaa0e2010-09-01 23:09:27 +000031#include "llvm/Module.h"
Chris Lattner372dda82007-03-05 07:52:57 +000032#include "llvm/Pass.h"
Chris Lattner9fc5cdf2011-01-02 22:09:33 +000033#include "llvm/Analysis/DominanceFrontier.h"
Dan Gohman5034dd32010-12-15 20:02:24 +000034#include "llvm/Analysis/ValueTracking.h"
Chris Lattner38aec322003-09-11 16:45:55 +000035#include "llvm/Target/TargetData.h"
36#include "llvm/Transforms/Utils/PromoteMemToReg.h"
Devang Patel4afc90d2009-02-10 07:00:59 +000037#include "llvm/Transforms/Utils/Local.h"
Chris Lattnera9be1df2010-11-18 06:26:49 +000038#include "llvm/Support/CallSite.h"
Chris Lattner95255282006-06-28 23:17:24 +000039#include "llvm/Support/Debug.h"
Torok Edwin7d696d82009-07-11 13:10:19 +000040#include "llvm/Support/ErrorHandling.h"
Chris Lattnera1888942005-12-12 07:19:13 +000041#include "llvm/Support/GetElementPtrTypeIterator.h"
Chris Lattner65a65022009-02-03 19:41:50 +000042#include "llvm/Support/IRBuilder.h"
Chris Lattnera1888942005-12-12 07:19:13 +000043#include "llvm/Support/MathExtras.h"
Chris Lattnerbdff5482009-08-23 04:37:46 +000044#include "llvm/Support/raw_ostream.h"
Chris Lattner1ccd1852007-02-12 22:56:41 +000045#include "llvm/ADT/SmallVector.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000046#include "llvm/ADT/Statistic.h"
Chris Lattnerd8664732003-12-02 17:43:55 +000047using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000048
Chris Lattner0e5f4992006-12-19 21:40:18 +000049STATISTIC(NumReplaced, "Number of allocas broken up");
50STATISTIC(NumPromoted, "Number of allocas promoted");
51STATISTIC(NumConverted, "Number of aggregates converted to scalar");
Chris Lattner79b3bd32007-04-25 06:40:51 +000052STATISTIC(NumGlobals, "Number of allocas copied from constant global");
Chris Lattnered7b41e2003-05-27 15:45:27 +000053
Chris Lattner0e5f4992006-12-19 21:40:18 +000054namespace {
Chris Lattner3e8b6632009-09-02 06:11:42 +000055 struct SROA : public FunctionPass {
Nick Lewyckyecd94c82007-05-06 13:37:16 +000056 static char ID; // Pass identification, replacement for typeid
Owen Anderson90c579d2010-08-06 18:33:48 +000057 explicit SROA(signed T = -1) : FunctionPass(ID) {
Owen Anderson081c34b2010-10-19 17:21:58 +000058 initializeSROAPass(*PassRegistry::getPassRegistry());
Devang Patelff366852007-07-09 21:19:23 +000059 if (T == -1)
Chris Lattnerb0e71ed2007-08-02 21:33:36 +000060 SRThreshold = 128;
Devang Patelff366852007-07-09 21:19:23 +000061 else
62 SRThreshold = T;
63 }
Devang Patel794fd752007-05-01 21:15:47 +000064
Chris Lattnered7b41e2003-05-27 15:45:27 +000065 bool runOnFunction(Function &F);
66
Chris Lattner38aec322003-09-11 16:45:55 +000067 bool performScalarRepl(Function &F);
68 bool performPromotion(Function &F);
69
Chris Lattnera15854c2003-08-31 00:45:13 +000070 // getAnalysisUsage - This pass does not require any passes, but we know it
71 // will not alter the CFG, so say so.
72 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
Devang Patel326821e2007-06-07 21:57:03 +000073 AU.addRequired<DominatorTree>();
Chris Lattner38aec322003-09-11 16:45:55 +000074 AU.addRequired<DominanceFrontier>();
Chris Lattnera15854c2003-08-31 00:45:13 +000075 AU.setPreservesCFG();
76 }
77
Chris Lattnered7b41e2003-05-27 15:45:27 +000078 private:
Chris Lattner56c38522009-01-07 06:34:28 +000079 TargetData *TD;
80
Bob Wilsonb742def2009-12-18 20:14:40 +000081 /// DeadInsts - Keep track of instructions we have made dead, so that
82 /// we can remove them after we are done working.
83 SmallVector<Value*, 32> DeadInsts;
84
Chris Lattner39a1c042007-05-30 06:11:23 +000085 /// AllocaInfo - When analyzing uses of an alloca instruction, this captures
86 /// information about the uses. All these fields are initialized to false
87 /// and set to true when something is learned.
88 struct AllocaInfo {
89 /// isUnsafe - This is set to true if the alloca cannot be SROA'd.
90 bool isUnsafe : 1;
91
Chris Lattner39a1c042007-05-30 06:11:23 +000092 /// isMemCpySrc - This is true if this aggregate is memcpy'd from.
93 bool isMemCpySrc : 1;
94
Zhou Sheng33b0b8d2007-07-06 06:01:16 +000095 /// isMemCpyDst - This is true if this aggregate is memcpy'd into.
Chris Lattner39a1c042007-05-30 06:11:23 +000096 bool isMemCpyDst : 1;
97
98 AllocaInfo()
Victor Hernandez6c146ee2010-01-21 23:05:53 +000099 : isUnsafe(false), isMemCpySrc(false), isMemCpyDst(false) {}
Chris Lattner39a1c042007-05-30 06:11:23 +0000100 };
101
Devang Patelff366852007-07-09 21:19:23 +0000102 unsigned SRThreshold;
103
Chris Lattner39a1c042007-05-30 06:11:23 +0000104 void MarkUnsafe(AllocaInfo &I) { I.isUnsafe = true; }
105
Victor Hernandez6c146ee2010-01-21 23:05:53 +0000106 bool isSafeAllocaToScalarRepl(AllocaInst *AI);
Chris Lattner39a1c042007-05-30 06:11:23 +0000107
Bob Wilsonb742def2009-12-18 20:14:40 +0000108 void isSafeForScalarRepl(Instruction *I, AllocaInst *AI, uint64_t Offset,
Bob Wilson3c3af5d2009-12-21 18:39:47 +0000109 AllocaInfo &Info);
Bob Wilsonb742def2009-12-18 20:14:40 +0000110 void isSafeGEP(GetElementPtrInst *GEPI, AllocaInst *AI, uint64_t &Offset,
Bob Wilson3c3af5d2009-12-21 18:39:47 +0000111 AllocaInfo &Info);
112 void isSafeMemAccess(AllocaInst *AI, uint64_t Offset, uint64_t MemSize,
113 const Type *MemOpType, bool isStore, AllocaInfo &Info);
Bob Wilsonb742def2009-12-18 20:14:40 +0000114 bool TypeHasComponent(const Type *T, uint64_t Offset, uint64_t Size);
Bob Wilsone88728d2009-12-19 06:53:17 +0000115 uint64_t FindElementAndOffset(const Type *&T, uint64_t &Offset,
116 const Type *&IdxTy);
Chris Lattner39a1c042007-05-30 06:11:23 +0000117
Victor Hernandez7b929da2009-10-23 21:09:37 +0000118 void DoScalarReplacement(AllocaInst *AI,
119 std::vector<AllocaInst*> &WorkList);
Bob Wilsonb742def2009-12-18 20:14:40 +0000120 void DeleteDeadInstructions();
Chris Lattner3126f1c2010-08-18 02:37:06 +0000121
Bob Wilsonb742def2009-12-18 20:14:40 +0000122 void RewriteForScalarRepl(Instruction *I, AllocaInst *AI, uint64_t Offset,
123 SmallVector<AllocaInst*, 32> &NewElts);
124 void RewriteBitCast(BitCastInst *BC, AllocaInst *AI, uint64_t Offset,
125 SmallVector<AllocaInst*, 32> &NewElts);
126 void RewriteGEP(GetElementPtrInst *GEPI, AllocaInst *AI, uint64_t Offset,
127 SmallVector<AllocaInst*, 32> &NewElts);
128 void RewriteMemIntrinUserOfAlloca(MemIntrinsic *MI, Instruction *Inst,
Victor Hernandez7b929da2009-10-23 21:09:37 +0000129 AllocaInst *AI,
Chris Lattnerd93afec2009-01-07 07:18:45 +0000130 SmallVector<AllocaInst*, 32> &NewElts);
Victor Hernandez7b929da2009-10-23 21:09:37 +0000131 void RewriteStoreUserOfWholeAlloca(StoreInst *SI, AllocaInst *AI,
Chris Lattnerd2fa7812009-01-07 08:11:13 +0000132 SmallVector<AllocaInst*, 32> &NewElts);
Victor Hernandez7b929da2009-10-23 21:09:37 +0000133 void RewriteLoadUserOfWholeAlloca(LoadInst *LI, AllocaInst *AI,
Chris Lattner6e733d32009-01-28 20:16:43 +0000134 SmallVector<AllocaInst*, 32> &NewElts);
Chris Lattnerd93afec2009-01-07 07:18:45 +0000135
Chris Lattner31d80102010-04-15 21:59:20 +0000136 static MemTransferInst *isOnlyCopiedFromConstantGlobal(AllocaInst *AI);
Chris Lattnered7b41e2003-05-27 15:45:27 +0000137 };
Chris Lattnered7b41e2003-05-27 15:45:27 +0000138}
139
Dan Gohman844731a2008-05-13 00:00:25 +0000140char SROA::ID = 0;
Owen Anderson2ab36d32010-10-12 19:48:12 +0000141INITIALIZE_PASS_BEGIN(SROA, "scalarrepl",
142 "Scalar Replacement of Aggregates", false, false)
143INITIALIZE_PASS_DEPENDENCY(DominatorTree)
144INITIALIZE_PASS_DEPENDENCY(DominanceFrontier)
145INITIALIZE_PASS_END(SROA, "scalarrepl",
Owen Andersonce665bd2010-10-07 22:25:06 +0000146 "Scalar Replacement of Aggregates", false, false)
Dan Gohman844731a2008-05-13 00:00:25 +0000147
Brian Gaeked0fde302003-11-11 22:41:34 +0000148// Public interface to the ScalarReplAggregates pass
Devang Patelff366852007-07-09 21:19:23 +0000149FunctionPass *llvm::createScalarReplAggregatesPass(signed int Threshold) {
150 return new SROA(Threshold);
151}
Chris Lattnered7b41e2003-05-27 15:45:27 +0000152
153
Chris Lattner4cc576b2010-04-16 00:24:57 +0000154//===----------------------------------------------------------------------===//
155// Convert To Scalar Optimization.
156//===----------------------------------------------------------------------===//
157
158namespace {
Chris Lattnera001b662010-04-16 00:38:19 +0000159/// ConvertToScalarInfo - This class implements the "Convert To Scalar"
160/// optimization, which scans the uses of an alloca and determines if it can
161/// rewrite it in terms of a single new alloca that can be mem2reg'd.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000162class ConvertToScalarInfo {
163 /// AllocaSize - The size of the alloca being considered.
164 unsigned AllocaSize;
165 const TargetData &TD;
166
Chris Lattnera0bada72010-04-16 02:32:17 +0000167 /// IsNotTrivial - This is set to true if there is some access to the object
Chris Lattnera001b662010-04-16 00:38:19 +0000168 /// which means that mem2reg can't promote it.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000169 bool IsNotTrivial;
Chris Lattnera001b662010-04-16 00:38:19 +0000170
171 /// VectorTy - This tracks the type that we should promote the vector to if
172 /// it is possible to turn it into a vector. This starts out null, and if it
173 /// isn't possible to turn into a vector type, it gets set to VoidTy.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000174 const Type *VectorTy;
Chris Lattnera001b662010-04-16 00:38:19 +0000175
176 /// HadAVector - True if there is at least one vector access to the alloca.
177 /// We don't want to turn random arrays into vectors and use vector element
178 /// insert/extract, but if there are element accesses to something that is
179 /// also declared as a vector, we do want to promote to a vector.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000180 bool HadAVector;
181
182public:
183 explicit ConvertToScalarInfo(unsigned Size, const TargetData &td)
184 : AllocaSize(Size), TD(td) {
185 IsNotTrivial = false;
186 VectorTy = 0;
187 HadAVector = false;
188 }
189
Chris Lattnera001b662010-04-16 00:38:19 +0000190 AllocaInst *TryConvert(AllocaInst *AI);
Chris Lattner4cc576b2010-04-16 00:24:57 +0000191
192private:
193 bool CanConvertToScalar(Value *V, uint64_t Offset);
194 void MergeInType(const Type *In, uint64_t Offset);
195 void ConvertUsesToScalar(Value *Ptr, AllocaInst *NewAI, uint64_t Offset);
196
197 Value *ConvertScalar_ExtractValue(Value *NV, const Type *ToType,
198 uint64_t Offset, IRBuilder<> &Builder);
199 Value *ConvertScalar_InsertValue(Value *StoredVal, Value *ExistingVal,
200 uint64_t Offset, IRBuilder<> &Builder);
201};
202} // end anonymous namespace.
203
Chris Lattner91abace2010-09-01 05:14:33 +0000204
205/// IsVerbotenVectorType - Return true if this is a vector type ScalarRepl isn't
206/// allowed to form. We do this to avoid MMX types, which is a complete hack,
207/// but is required until the backend is fixed.
Chris Lattner72eaa0e2010-09-01 23:09:27 +0000208static bool IsVerbotenVectorType(const VectorType *VTy, const Instruction *I) {
209 StringRef Triple(I->getParent()->getParent()->getParent()->getTargetTriple());
210 if (!Triple.startswith("i386") &&
211 !Triple.startswith("x86_64"))
212 return false;
213
Chris Lattner91abace2010-09-01 05:14:33 +0000214 // Reject all the MMX vector types.
215 switch (VTy->getNumElements()) {
216 default: return false;
217 case 1: return VTy->getElementType()->isIntegerTy(64);
218 case 2: return VTy->getElementType()->isIntegerTy(32);
219 case 4: return VTy->getElementType()->isIntegerTy(16);
220 case 8: return VTy->getElementType()->isIntegerTy(8);
221 }
222}
223
224
Chris Lattnera001b662010-04-16 00:38:19 +0000225/// TryConvert - Analyze the specified alloca, and if it is safe to do so,
226/// rewrite it to be a new alloca which is mem2reg'able. This returns the new
227/// alloca if possible or null if not.
228AllocaInst *ConvertToScalarInfo::TryConvert(AllocaInst *AI) {
229 // If we can't convert this scalar, or if mem2reg can trivially do it, bail
230 // out.
231 if (!CanConvertToScalar(AI, 0) || !IsNotTrivial)
232 return 0;
233
234 // If we were able to find a vector type that can handle this with
235 // insert/extract elements, and if there was at least one use that had
236 // a vector type, promote this to a vector. We don't want to promote
237 // random stuff that doesn't use vectors (e.g. <9 x double>) because then
238 // we just get a lot of insert/extracts. If at least one vector is
239 // involved, then we probably really do have a union of vector/array.
240 const Type *NewTy;
Chris Lattner91abace2010-09-01 05:14:33 +0000241 if (VectorTy && VectorTy->isVectorTy() && HadAVector &&
Chris Lattner72eaa0e2010-09-01 23:09:27 +0000242 !IsVerbotenVectorType(cast<VectorType>(VectorTy), AI)) {
Chris Lattnera001b662010-04-16 00:38:19 +0000243 DEBUG(dbgs() << "CONVERT TO VECTOR: " << *AI << "\n TYPE = "
244 << *VectorTy << '\n');
245 NewTy = VectorTy; // Use the vector type.
246 } else {
247 DEBUG(dbgs() << "CONVERT TO SCALAR INTEGER: " << *AI << "\n");
248 // Create and insert the integer alloca.
249 NewTy = IntegerType::get(AI->getContext(), AllocaSize*8);
250 }
251 AllocaInst *NewAI = new AllocaInst(NewTy, 0, "", AI->getParent()->begin());
252 ConvertUsesToScalar(AI, NewAI, 0);
253 return NewAI;
254}
255
256/// MergeInType - Add the 'In' type to the accumulated vector type (VectorTy)
257/// so far at the offset specified by Offset (which is specified in bytes).
Chris Lattner4cc576b2010-04-16 00:24:57 +0000258///
259/// There are two cases we handle here:
260/// 1) A union of vector types of the same size and potentially its elements.
261/// Here we turn element accesses into insert/extract element operations.
262/// This promotes a <4 x float> with a store of float to the third element
263/// into a <4 x float> that uses insert element.
264/// 2) A fully general blob of memory, which we turn into some (potentially
265/// large) integer type with extract and insert operations where the loads
Chris Lattnera001b662010-04-16 00:38:19 +0000266/// and stores would mutate the memory. We mark this by setting VectorTy
267/// to VoidTy.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000268void ConvertToScalarInfo::MergeInType(const Type *In, uint64_t Offset) {
Chris Lattnera001b662010-04-16 00:38:19 +0000269 // If we already decided to turn this into a blob of integer memory, there is
270 // nothing to be done.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000271 if (VectorTy && VectorTy->isVoidTy())
272 return;
273
274 // If this could be contributing to a vector, analyze it.
275
276 // If the In type is a vector that is the same size as the alloca, see if it
277 // matches the existing VecTy.
278 if (const VectorType *VInTy = dyn_cast<VectorType>(In)) {
Chris Lattnera001b662010-04-16 00:38:19 +0000279 // Remember if we saw a vector type.
280 HadAVector = true;
281
Chris Lattner4cc576b2010-04-16 00:24:57 +0000282 if (VInTy->getBitWidth()/8 == AllocaSize && Offset == 0) {
283 // If we're storing/loading a vector of the right size, allow it as a
284 // vector. If this the first vector we see, remember the type so that
Chris Lattnera001b662010-04-16 00:38:19 +0000285 // we know the element size. If this is a subsequent access, ignore it
286 // even if it is a differing type but the same size. Worst case we can
287 // bitcast the resultant vectors.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000288 if (VectorTy == 0)
289 VectorTy = VInTy;
290 return;
291 }
292 } else if (In->isFloatTy() || In->isDoubleTy() ||
293 (In->isIntegerTy() && In->getPrimitiveSizeInBits() >= 8 &&
294 isPowerOf2_32(In->getPrimitiveSizeInBits()))) {
295 // If we're accessing something that could be an element of a vector, see
296 // if the implied vector agrees with what we already have and if Offset is
297 // compatible with it.
298 unsigned EltSize = In->getPrimitiveSizeInBits()/8;
299 if (Offset % EltSize == 0 && AllocaSize % EltSize == 0 &&
300 (VectorTy == 0 ||
301 cast<VectorType>(VectorTy)->getElementType()
302 ->getPrimitiveSizeInBits()/8 == EltSize)) {
303 if (VectorTy == 0)
304 VectorTy = VectorType::get(In, AllocaSize/EltSize);
305 return;
306 }
307 }
308
309 // Otherwise, we have a case that we can't handle with an optimized vector
310 // form. We can still turn this into a large integer.
311 VectorTy = Type::getVoidTy(In->getContext());
312}
313
314/// CanConvertToScalar - V is a pointer. If we can convert the pointee and all
315/// its accesses to a single vector type, return true and set VecTy to
316/// the new type. If we could convert the alloca into a single promotable
317/// integer, return true but set VecTy to VoidTy. Further, if the use is not a
318/// completely trivial use that mem2reg could promote, set IsNotTrivial. Offset
319/// is the current offset from the base of the alloca being analyzed.
320///
321/// If we see at least one access to the value that is as a vector type, set the
322/// SawVec flag.
323bool ConvertToScalarInfo::CanConvertToScalar(Value *V, uint64_t Offset) {
324 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI!=E; ++UI) {
325 Instruction *User = cast<Instruction>(*UI);
326
327 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
328 // Don't break volatile loads.
329 if (LI->isVolatile())
330 return false;
Dale Johannesen0488fb62010-09-30 23:57:10 +0000331 // Don't touch MMX operations.
332 if (LI->getType()->isX86_MMXTy())
333 return false;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000334 MergeInType(LI->getType(), Offset);
335 continue;
336 }
337
338 if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
339 // Storing the pointer, not into the value?
340 if (SI->getOperand(0) == V || SI->isVolatile()) return false;
Dale Johannesen0488fb62010-09-30 23:57:10 +0000341 // Don't touch MMX operations.
342 if (SI->getOperand(0)->getType()->isX86_MMXTy())
343 return false;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000344 MergeInType(SI->getOperand(0)->getType(), Offset);
345 continue;
346 }
347
348 if (BitCastInst *BCI = dyn_cast<BitCastInst>(User)) {
Chris Lattnera001b662010-04-16 00:38:19 +0000349 IsNotTrivial = true; // Can't be mem2reg'd.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000350 if (!CanConvertToScalar(BCI, Offset))
351 return false;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000352 continue;
353 }
354
355 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(User)) {
356 // If this is a GEP with a variable indices, we can't handle it.
357 if (!GEP->hasAllConstantIndices())
358 return false;
359
360 // Compute the offset that this GEP adds to the pointer.
361 SmallVector<Value*, 8> Indices(GEP->op_begin()+1, GEP->op_end());
362 uint64_t GEPOffset = TD.getIndexedOffset(GEP->getPointerOperandType(),
363 &Indices[0], Indices.size());
364 // See if all uses can be converted.
365 if (!CanConvertToScalar(GEP, Offset+GEPOffset))
366 return false;
Chris Lattnera001b662010-04-16 00:38:19 +0000367 IsNotTrivial = true; // Can't be mem2reg'd.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000368 continue;
369 }
370
371 // If this is a constant sized memset of a constant value (e.g. 0) we can
372 // handle it.
373 if (MemSetInst *MSI = dyn_cast<MemSetInst>(User)) {
374 // Store of constant value and constant size.
Chris Lattnera001b662010-04-16 00:38:19 +0000375 if (!isa<ConstantInt>(MSI->getValue()) ||
376 !isa<ConstantInt>(MSI->getLength()))
377 return false;
378 IsNotTrivial = true; // Can't be mem2reg'd.
379 continue;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000380 }
381
382 // If this is a memcpy or memmove into or out of the whole allocation, we
383 // can handle it like a load or store of the scalar type.
384 if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(User)) {
Chris Lattnera001b662010-04-16 00:38:19 +0000385 ConstantInt *Len = dyn_cast<ConstantInt>(MTI->getLength());
386 if (Len == 0 || Len->getZExtValue() != AllocaSize || Offset != 0)
387 return false;
388
389 IsNotTrivial = true; // Can't be mem2reg'd.
390 continue;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000391 }
392
393 // Otherwise, we cannot handle this!
394 return false;
395 }
396
397 return true;
398}
399
400/// ConvertUsesToScalar - Convert all of the users of Ptr to use the new alloca
401/// directly. This happens when we are converting an "integer union" to a
402/// single integer scalar, or when we are converting a "vector union" to a
403/// vector with insert/extractelement instructions.
404///
405/// Offset is an offset from the original alloca, in bits that need to be
406/// shifted to the right. By the end of this, there should be no uses of Ptr.
407void ConvertToScalarInfo::ConvertUsesToScalar(Value *Ptr, AllocaInst *NewAI,
408 uint64_t Offset) {
409 while (!Ptr->use_empty()) {
410 Instruction *User = cast<Instruction>(Ptr->use_back());
411
412 if (BitCastInst *CI = dyn_cast<BitCastInst>(User)) {
413 ConvertUsesToScalar(CI, NewAI, Offset);
414 CI->eraseFromParent();
415 continue;
416 }
417
418 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(User)) {
419 // Compute the offset that this GEP adds to the pointer.
420 SmallVector<Value*, 8> Indices(GEP->op_begin()+1, GEP->op_end());
421 uint64_t GEPOffset = TD.getIndexedOffset(GEP->getPointerOperandType(),
422 &Indices[0], Indices.size());
423 ConvertUsesToScalar(GEP, NewAI, Offset+GEPOffset*8);
424 GEP->eraseFromParent();
425 continue;
426 }
427
Chris Lattner61db1f52010-12-26 22:57:41 +0000428 IRBuilder<> Builder(User);
Chris Lattner4cc576b2010-04-16 00:24:57 +0000429
430 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
431 // The load is a bit extract from NewAI shifted right by Offset bits.
432 Value *LoadedVal = Builder.CreateLoad(NewAI, "tmp");
433 Value *NewLoadVal
434 = ConvertScalar_ExtractValue(LoadedVal, LI->getType(), Offset, Builder);
435 LI->replaceAllUsesWith(NewLoadVal);
436 LI->eraseFromParent();
437 continue;
438 }
439
440 if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
441 assert(SI->getOperand(0) != Ptr && "Consistency error!");
442 Instruction *Old = Builder.CreateLoad(NewAI, NewAI->getName()+".in");
443 Value *New = ConvertScalar_InsertValue(SI->getOperand(0), Old, Offset,
444 Builder);
445 Builder.CreateStore(New, NewAI);
446 SI->eraseFromParent();
447
448 // If the load we just inserted is now dead, then the inserted store
449 // overwrote the entire thing.
450 if (Old->use_empty())
451 Old->eraseFromParent();
452 continue;
453 }
454
455 // If this is a constant sized memset of a constant value (e.g. 0) we can
456 // transform it into a store of the expanded constant value.
457 if (MemSetInst *MSI = dyn_cast<MemSetInst>(User)) {
458 assert(MSI->getRawDest() == Ptr && "Consistency error!");
459 unsigned NumBytes = cast<ConstantInt>(MSI->getLength())->getZExtValue();
460 if (NumBytes != 0) {
461 unsigned Val = cast<ConstantInt>(MSI->getValue())->getZExtValue();
462
463 // Compute the value replicated the right number of times.
464 APInt APVal(NumBytes*8, Val);
465
466 // Splat the value if non-zero.
467 if (Val)
468 for (unsigned i = 1; i != NumBytes; ++i)
469 APVal |= APVal << 8;
470
471 Instruction *Old = Builder.CreateLoad(NewAI, NewAI->getName()+".in");
472 Value *New = ConvertScalar_InsertValue(
473 ConstantInt::get(User->getContext(), APVal),
474 Old, Offset, Builder);
475 Builder.CreateStore(New, NewAI);
476
477 // If the load we just inserted is now dead, then the memset overwrote
478 // the entire thing.
479 if (Old->use_empty())
480 Old->eraseFromParent();
481 }
482 MSI->eraseFromParent();
483 continue;
484 }
485
486 // If this is a memcpy or memmove into or out of the whole allocation, we
487 // can handle it like a load or store of the scalar type.
488 if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(User)) {
489 assert(Offset == 0 && "must be store to start of alloca");
490
491 // If the source and destination are both to the same alloca, then this is
492 // a noop copy-to-self, just delete it. Otherwise, emit a load and store
493 // as appropriate.
Dan Gohman5034dd32010-12-15 20:02:24 +0000494 AllocaInst *OrigAI = cast<AllocaInst>(GetUnderlyingObject(Ptr, 0));
Chris Lattner4cc576b2010-04-16 00:24:57 +0000495
Dan Gohman5034dd32010-12-15 20:02:24 +0000496 if (GetUnderlyingObject(MTI->getSource(), 0) != OrigAI) {
Chris Lattner4cc576b2010-04-16 00:24:57 +0000497 // Dest must be OrigAI, change this to be a load from the original
498 // pointer (bitcasted), then a store to our new alloca.
499 assert(MTI->getRawDest() == Ptr && "Neither use is of pointer?");
500 Value *SrcPtr = MTI->getSource();
Mon P Wange90a6332010-12-23 01:41:32 +0000501 const PointerType* SPTy = cast<PointerType>(SrcPtr->getType());
502 const PointerType* AIPTy = cast<PointerType>(NewAI->getType());
503 if (SPTy->getAddressSpace() != AIPTy->getAddressSpace()) {
504 AIPTy = PointerType::get(AIPTy->getElementType(),
505 SPTy->getAddressSpace());
506 }
507 SrcPtr = Builder.CreateBitCast(SrcPtr, AIPTy);
508
Chris Lattner4cc576b2010-04-16 00:24:57 +0000509 LoadInst *SrcVal = Builder.CreateLoad(SrcPtr, "srcval");
510 SrcVal->setAlignment(MTI->getAlignment());
511 Builder.CreateStore(SrcVal, NewAI);
Dan Gohman5034dd32010-12-15 20:02:24 +0000512 } else if (GetUnderlyingObject(MTI->getDest(), 0) != OrigAI) {
Chris Lattner4cc576b2010-04-16 00:24:57 +0000513 // Src must be OrigAI, change this to be a load from NewAI then a store
514 // through the original dest pointer (bitcasted).
515 assert(MTI->getRawSource() == Ptr && "Neither use is of pointer?");
516 LoadInst *SrcVal = Builder.CreateLoad(NewAI, "srcval");
517
Mon P Wange90a6332010-12-23 01:41:32 +0000518 const PointerType* DPTy = cast<PointerType>(MTI->getDest()->getType());
519 const PointerType* AIPTy = cast<PointerType>(NewAI->getType());
520 if (DPTy->getAddressSpace() != AIPTy->getAddressSpace()) {
521 AIPTy = PointerType::get(AIPTy->getElementType(),
522 DPTy->getAddressSpace());
523 }
524 Value *DstPtr = Builder.CreateBitCast(MTI->getDest(), AIPTy);
525
Chris Lattner4cc576b2010-04-16 00:24:57 +0000526 StoreInst *NewStore = Builder.CreateStore(SrcVal, DstPtr);
527 NewStore->setAlignment(MTI->getAlignment());
528 } else {
529 // Noop transfer. Src == Dst
530 }
531
532 MTI->eraseFromParent();
533 continue;
534 }
535
536 llvm_unreachable("Unsupported operation!");
537 }
538}
539
540/// ConvertScalar_ExtractValue - Extract a value of type ToType from an integer
541/// or vector value FromVal, extracting the bits from the offset specified by
542/// Offset. This returns the value, which is of type ToType.
543///
544/// This happens when we are converting an "integer union" to a single
545/// integer scalar, or when we are converting a "vector union" to a vector with
546/// insert/extractelement instructions.
547///
548/// Offset is an offset from the original alloca, in bits that need to be
549/// shifted to the right.
550Value *ConvertToScalarInfo::
551ConvertScalar_ExtractValue(Value *FromVal, const Type *ToType,
552 uint64_t Offset, IRBuilder<> &Builder) {
553 // If the load is of the whole new alloca, no conversion is needed.
554 if (FromVal->getType() == ToType && Offset == 0)
555 return FromVal;
556
557 // If the result alloca is a vector type, this is either an element
558 // access or a bitcast to another vector type of the same size.
559 if (const VectorType *VTy = dyn_cast<VectorType>(FromVal->getType())) {
560 if (ToType->isVectorTy())
561 return Builder.CreateBitCast(FromVal, ToType, "tmp");
562
563 // Otherwise it must be an element access.
564 unsigned Elt = 0;
565 if (Offset) {
566 unsigned EltSize = TD.getTypeAllocSizeInBits(VTy->getElementType());
567 Elt = Offset/EltSize;
568 assert(EltSize*Elt == Offset && "Invalid modulus in validity checking");
569 }
570 // Return the element extracted out of it.
571 Value *V = Builder.CreateExtractElement(FromVal, ConstantInt::get(
572 Type::getInt32Ty(FromVal->getContext()), Elt), "tmp");
573 if (V->getType() != ToType)
574 V = Builder.CreateBitCast(V, ToType, "tmp");
575 return V;
576 }
577
578 // If ToType is a first class aggregate, extract out each of the pieces and
579 // use insertvalue's to form the FCA.
580 if (const StructType *ST = dyn_cast<StructType>(ToType)) {
581 const StructLayout &Layout = *TD.getStructLayout(ST);
582 Value *Res = UndefValue::get(ST);
583 for (unsigned i = 0, e = ST->getNumElements(); i != e; ++i) {
584 Value *Elt = ConvertScalar_ExtractValue(FromVal, ST->getElementType(i),
585 Offset+Layout.getElementOffsetInBits(i),
586 Builder);
587 Res = Builder.CreateInsertValue(Res, Elt, i, "tmp");
588 }
589 return Res;
590 }
591
592 if (const ArrayType *AT = dyn_cast<ArrayType>(ToType)) {
593 uint64_t EltSize = TD.getTypeAllocSizeInBits(AT->getElementType());
594 Value *Res = UndefValue::get(AT);
595 for (unsigned i = 0, e = AT->getNumElements(); i != e; ++i) {
596 Value *Elt = ConvertScalar_ExtractValue(FromVal, AT->getElementType(),
597 Offset+i*EltSize, Builder);
598 Res = Builder.CreateInsertValue(Res, Elt, i, "tmp");
599 }
600 return Res;
601 }
602
603 // Otherwise, this must be a union that was converted to an integer value.
604 const IntegerType *NTy = cast<IntegerType>(FromVal->getType());
605
606 // If this is a big-endian system and the load is narrower than the
607 // full alloca type, we need to do a shift to get the right bits.
608 int ShAmt = 0;
609 if (TD.isBigEndian()) {
610 // On big-endian machines, the lowest bit is stored at the bit offset
611 // from the pointer given by getTypeStoreSizeInBits. This matters for
612 // integers with a bitwidth that is not a multiple of 8.
613 ShAmt = TD.getTypeStoreSizeInBits(NTy) -
614 TD.getTypeStoreSizeInBits(ToType) - Offset;
615 } else {
616 ShAmt = Offset;
617 }
618
619 // Note: we support negative bitwidths (with shl) which are not defined.
620 // We do this to support (f.e.) loads off the end of a structure where
621 // only some bits are used.
622 if (ShAmt > 0 && (unsigned)ShAmt < NTy->getBitWidth())
623 FromVal = Builder.CreateLShr(FromVal,
624 ConstantInt::get(FromVal->getType(),
625 ShAmt), "tmp");
626 else if (ShAmt < 0 && (unsigned)-ShAmt < NTy->getBitWidth())
627 FromVal = Builder.CreateShl(FromVal,
628 ConstantInt::get(FromVal->getType(),
629 -ShAmt), "tmp");
630
631 // Finally, unconditionally truncate the integer to the right width.
632 unsigned LIBitWidth = TD.getTypeSizeInBits(ToType);
633 if (LIBitWidth < NTy->getBitWidth())
634 FromVal =
635 Builder.CreateTrunc(FromVal, IntegerType::get(FromVal->getContext(),
636 LIBitWidth), "tmp");
637 else if (LIBitWidth > NTy->getBitWidth())
638 FromVal =
639 Builder.CreateZExt(FromVal, IntegerType::get(FromVal->getContext(),
640 LIBitWidth), "tmp");
641
642 // If the result is an integer, this is a trunc or bitcast.
643 if (ToType->isIntegerTy()) {
644 // Should be done.
645 } else if (ToType->isFloatingPointTy() || ToType->isVectorTy()) {
646 // Just do a bitcast, we know the sizes match up.
647 FromVal = Builder.CreateBitCast(FromVal, ToType, "tmp");
648 } else {
649 // Otherwise must be a pointer.
650 FromVal = Builder.CreateIntToPtr(FromVal, ToType, "tmp");
651 }
652 assert(FromVal->getType() == ToType && "Didn't convert right?");
653 return FromVal;
654}
655
656/// ConvertScalar_InsertValue - Insert the value "SV" into the existing integer
657/// or vector value "Old" at the offset specified by Offset.
658///
659/// This happens when we are converting an "integer union" to a
660/// single integer scalar, or when we are converting a "vector union" to a
661/// vector with insert/extractelement instructions.
662///
663/// Offset is an offset from the original alloca, in bits that need to be
664/// shifted to the right.
665Value *ConvertToScalarInfo::
666ConvertScalar_InsertValue(Value *SV, Value *Old,
667 uint64_t Offset, IRBuilder<> &Builder) {
668 // Convert the stored type to the actual type, shift it left to insert
669 // then 'or' into place.
670 const Type *AllocaType = Old->getType();
671 LLVMContext &Context = Old->getContext();
672
673 if (const VectorType *VTy = dyn_cast<VectorType>(AllocaType)) {
674 uint64_t VecSize = TD.getTypeAllocSizeInBits(VTy);
675 uint64_t ValSize = TD.getTypeAllocSizeInBits(SV->getType());
676
677 // Changing the whole vector with memset or with an access of a different
678 // vector type?
679 if (ValSize == VecSize)
680 return Builder.CreateBitCast(SV, AllocaType, "tmp");
681
682 uint64_t EltSize = TD.getTypeAllocSizeInBits(VTy->getElementType());
683
684 // Must be an element insertion.
685 unsigned Elt = Offset/EltSize;
686
687 if (SV->getType() != VTy->getElementType())
688 SV = Builder.CreateBitCast(SV, VTy->getElementType(), "tmp");
689
690 SV = Builder.CreateInsertElement(Old, SV,
691 ConstantInt::get(Type::getInt32Ty(SV->getContext()), Elt),
692 "tmp");
693 return SV;
694 }
695
696 // If SV is a first-class aggregate value, insert each value recursively.
697 if (const StructType *ST = dyn_cast<StructType>(SV->getType())) {
698 const StructLayout &Layout = *TD.getStructLayout(ST);
699 for (unsigned i = 0, e = ST->getNumElements(); i != e; ++i) {
700 Value *Elt = Builder.CreateExtractValue(SV, i, "tmp");
701 Old = ConvertScalar_InsertValue(Elt, Old,
702 Offset+Layout.getElementOffsetInBits(i),
703 Builder);
704 }
705 return Old;
706 }
707
708 if (const ArrayType *AT = dyn_cast<ArrayType>(SV->getType())) {
709 uint64_t EltSize = TD.getTypeAllocSizeInBits(AT->getElementType());
710 for (unsigned i = 0, e = AT->getNumElements(); i != e; ++i) {
711 Value *Elt = Builder.CreateExtractValue(SV, i, "tmp");
712 Old = ConvertScalar_InsertValue(Elt, Old, Offset+i*EltSize, Builder);
713 }
714 return Old;
715 }
716
717 // If SV is a float, convert it to the appropriate integer type.
718 // If it is a pointer, do the same.
719 unsigned SrcWidth = TD.getTypeSizeInBits(SV->getType());
720 unsigned DestWidth = TD.getTypeSizeInBits(AllocaType);
721 unsigned SrcStoreWidth = TD.getTypeStoreSizeInBits(SV->getType());
722 unsigned DestStoreWidth = TD.getTypeStoreSizeInBits(AllocaType);
723 if (SV->getType()->isFloatingPointTy() || SV->getType()->isVectorTy())
724 SV = Builder.CreateBitCast(SV,
725 IntegerType::get(SV->getContext(),SrcWidth), "tmp");
726 else if (SV->getType()->isPointerTy())
727 SV = Builder.CreatePtrToInt(SV, TD.getIntPtrType(SV->getContext()), "tmp");
728
729 // Zero extend or truncate the value if needed.
730 if (SV->getType() != AllocaType) {
731 if (SV->getType()->getPrimitiveSizeInBits() <
732 AllocaType->getPrimitiveSizeInBits())
733 SV = Builder.CreateZExt(SV, AllocaType, "tmp");
734 else {
735 // Truncation may be needed if storing more than the alloca can hold
736 // (undefined behavior).
737 SV = Builder.CreateTrunc(SV, AllocaType, "tmp");
738 SrcWidth = DestWidth;
739 SrcStoreWidth = DestStoreWidth;
740 }
741 }
742
743 // If this is a big-endian system and the store is narrower than the
744 // full alloca type, we need to do a shift to get the right bits.
745 int ShAmt = 0;
746 if (TD.isBigEndian()) {
747 // On big-endian machines, the lowest bit is stored at the bit offset
748 // from the pointer given by getTypeStoreSizeInBits. This matters for
749 // integers with a bitwidth that is not a multiple of 8.
750 ShAmt = DestStoreWidth - SrcStoreWidth - Offset;
751 } else {
752 ShAmt = Offset;
753 }
754
755 // Note: we support negative bitwidths (with shr) which are not defined.
756 // We do this to support (f.e.) stores off the end of a structure where
757 // only some bits in the structure are set.
758 APInt Mask(APInt::getLowBitsSet(DestWidth, SrcWidth));
759 if (ShAmt > 0 && (unsigned)ShAmt < DestWidth) {
760 SV = Builder.CreateShl(SV, ConstantInt::get(SV->getType(),
761 ShAmt), "tmp");
762 Mask <<= ShAmt;
763 } else if (ShAmt < 0 && (unsigned)-ShAmt < DestWidth) {
764 SV = Builder.CreateLShr(SV, ConstantInt::get(SV->getType(),
765 -ShAmt), "tmp");
766 Mask = Mask.lshr(-ShAmt);
767 }
768
769 // Mask out the bits we are about to insert from the old value, and or
770 // in the new bits.
771 if (SrcWidth != DestWidth) {
772 assert(DestWidth > SrcWidth);
773 Old = Builder.CreateAnd(Old, ConstantInt::get(Context, ~Mask), "mask");
774 SV = Builder.CreateOr(Old, SV, "ins");
775 }
776 return SV;
777}
778
779
780//===----------------------------------------------------------------------===//
781// SRoA Driver
782//===----------------------------------------------------------------------===//
783
784
Chris Lattnered7b41e2003-05-27 15:45:27 +0000785bool SROA::runOnFunction(Function &F) {
Dan Gohmane4af1cf2009-08-19 18:22:18 +0000786 TD = getAnalysisIfAvailable<TargetData>();
787
Chris Lattnerfe7ea0d2003-09-12 15:36:03 +0000788 bool Changed = performPromotion(F);
Dan Gohmane4af1cf2009-08-19 18:22:18 +0000789
790 // FIXME: ScalarRepl currently depends on TargetData more than it
791 // theoretically needs to. It should be refactored in order to support
792 // target-independent IR. Until this is done, just skip the actual
793 // scalar-replacement portion of this pass.
794 if (!TD) return Changed;
795
Chris Lattnerfe7ea0d2003-09-12 15:36:03 +0000796 while (1) {
797 bool LocalChange = performScalarRepl(F);
798 if (!LocalChange) break; // No need to repromote if no scalarrepl
799 Changed = true;
800 LocalChange = performPromotion(F);
801 if (!LocalChange) break; // No need to re-scalarrepl if no promotion
802 }
Chris Lattner38aec322003-09-11 16:45:55 +0000803
804 return Changed;
805}
806
807
808bool SROA::performPromotion(Function &F) {
809 std::vector<AllocaInst*> Allocas;
Devang Patel326821e2007-06-07 21:57:03 +0000810 DominatorTree &DT = getAnalysis<DominatorTree>();
Chris Lattner43f820d2003-10-05 21:20:13 +0000811 DominanceFrontier &DF = getAnalysis<DominanceFrontier>();
Chris Lattner38aec322003-09-11 16:45:55 +0000812
Chris Lattner02a3be02003-09-20 14:39:18 +0000813 BasicBlock &BB = F.getEntryBlock(); // Get the entry node for the function
Chris Lattner38aec322003-09-11 16:45:55 +0000814
Chris Lattnerfe7ea0d2003-09-12 15:36:03 +0000815 bool Changed = false;
Misha Brukmanfd939082005-04-21 23:48:37 +0000816
Chris Lattner38aec322003-09-11 16:45:55 +0000817 while (1) {
818 Allocas.clear();
819
820 // Find allocas that are safe to promote, by looking at all instructions in
821 // the entry node
822 for (BasicBlock::iterator I = BB.begin(), E = --BB.end(); I != E; ++I)
823 if (AllocaInst *AI = dyn_cast<AllocaInst>(I)) // Is it an alloca?
Devang Patel41968df2007-04-25 17:15:20 +0000824 if (isAllocaPromotable(AI))
Chris Lattner38aec322003-09-11 16:45:55 +0000825 Allocas.push_back(AI);
826
827 if (Allocas.empty()) break;
828
Nick Lewyckyce2c51b2009-11-23 03:50:44 +0000829 PromoteMemToReg(Allocas, DT, DF);
Chris Lattner38aec322003-09-11 16:45:55 +0000830 NumPromoted += Allocas.size();
831 Changed = true;
832 }
833
834 return Changed;
835}
836
Chris Lattner4cc576b2010-04-16 00:24:57 +0000837
Bob Wilson3992feb2010-02-03 17:23:56 +0000838/// ShouldAttemptScalarRepl - Decide if an alloca is a good candidate for
839/// SROA. It must be a struct or array type with a small number of elements.
840static bool ShouldAttemptScalarRepl(AllocaInst *AI) {
841 const Type *T = AI->getAllocatedType();
842 // Do not promote any struct into more than 32 separate vars.
Chris Lattner963a97f2008-06-22 17:46:21 +0000843 if (const StructType *ST = dyn_cast<StructType>(T))
Bob Wilson3992feb2010-02-03 17:23:56 +0000844 return ST->getNumElements() <= 32;
845 // Arrays are much less likely to be safe for SROA; only consider
846 // them if they are very small.
847 if (const ArrayType *AT = dyn_cast<ArrayType>(T))
848 return AT->getNumElements() <= 8;
849 return false;
Chris Lattner963a97f2008-06-22 17:46:21 +0000850}
851
Chris Lattnerc4472072010-04-15 23:50:26 +0000852
Chris Lattner38aec322003-09-11 16:45:55 +0000853// performScalarRepl - This algorithm is a simple worklist driven algorithm,
854// which runs on all of the malloc/alloca instructions in the function, removing
855// them if they are only used by getelementptr instructions.
856//
857bool SROA::performScalarRepl(Function &F) {
Victor Hernandez7b929da2009-10-23 21:09:37 +0000858 std::vector<AllocaInst*> WorkList;
Chris Lattnered7b41e2003-05-27 15:45:27 +0000859
Chris Lattner31d80102010-04-15 21:59:20 +0000860 // Scan the entry basic block, adding allocas to the worklist.
Chris Lattner02a3be02003-09-20 14:39:18 +0000861 BasicBlock &BB = F.getEntryBlock();
Chris Lattnered7b41e2003-05-27 15:45:27 +0000862 for (BasicBlock::iterator I = BB.begin(), E = BB.end(); I != E; ++I)
Victor Hernandez7b929da2009-10-23 21:09:37 +0000863 if (AllocaInst *A = dyn_cast<AllocaInst>(I))
Chris Lattnered7b41e2003-05-27 15:45:27 +0000864 WorkList.push_back(A);
865
866 // Process the worklist
867 bool Changed = false;
868 while (!WorkList.empty()) {
Victor Hernandez7b929da2009-10-23 21:09:37 +0000869 AllocaInst *AI = WorkList.back();
Chris Lattnered7b41e2003-05-27 15:45:27 +0000870 WorkList.pop_back();
Chris Lattnera1888942005-12-12 07:19:13 +0000871
Chris Lattneradd2bd72006-12-22 23:14:42 +0000872 // Handle dead allocas trivially. These can be formed by SROA'ing arrays
873 // with unused elements.
874 if (AI->use_empty()) {
875 AI->eraseFromParent();
Chris Lattnerc4472072010-04-15 23:50:26 +0000876 Changed = true;
Chris Lattneradd2bd72006-12-22 23:14:42 +0000877 continue;
878 }
Chris Lattner7809ecd2009-02-03 01:30:09 +0000879
880 // If this alloca is impossible for us to promote, reject it early.
881 if (AI->isArrayAllocation() || !AI->getAllocatedType()->isSized())
882 continue;
Chris Lattner79b3bd32007-04-25 06:40:51 +0000883
884 // Check to see if this allocation is only modified by a memcpy/memmove from
885 // a constant global. If this is the case, we can change all users to use
886 // the constant global instead. This is commonly produced by the CFE by
887 // constructs like "void foo() { int A[] = {1,2,3,4,5,6,7,8,9...}; }" if 'A'
888 // is only subsequently read.
Chris Lattner31d80102010-04-15 21:59:20 +0000889 if (MemTransferInst *TheCopy = isOnlyCopiedFromConstantGlobal(AI)) {
David Greene504c7d82010-01-05 01:27:09 +0000890 DEBUG(dbgs() << "Found alloca equal to global: " << *AI << '\n');
891 DEBUG(dbgs() << " memcpy = " << *TheCopy << '\n');
Chris Lattner31d80102010-04-15 21:59:20 +0000892 Constant *TheSrc = cast<Constant>(TheCopy->getSource());
Owen Andersonbaf3c402009-07-29 18:55:55 +0000893 AI->replaceAllUsesWith(ConstantExpr::getBitCast(TheSrc, AI->getType()));
Chris Lattner79b3bd32007-04-25 06:40:51 +0000894 TheCopy->eraseFromParent(); // Don't mutate the global.
895 AI->eraseFromParent();
896 ++NumGlobals;
897 Changed = true;
898 continue;
899 }
Chris Lattner15c82772009-02-02 20:44:45 +0000900
Chris Lattner7809ecd2009-02-03 01:30:09 +0000901 // Check to see if we can perform the core SROA transformation. We cannot
902 // transform the allocation instruction if it is an array allocation
903 // (allocations OF arrays are ok though), and an allocation of a scalar
904 // value cannot be decomposed at all.
Duncan Sands777d2302009-05-09 07:06:46 +0000905 uint64_t AllocaSize = TD->getTypeAllocSize(AI->getAllocatedType());
Bill Wendling5a377cb2009-03-03 12:12:58 +0000906
Nick Lewyckyd3aa25e2009-08-17 05:37:31 +0000907 // Do not promote [0 x %struct].
908 if (AllocaSize == 0) continue;
Chris Lattner31d80102010-04-15 21:59:20 +0000909
910 // Do not promote any struct whose size is too big.
911 if (AllocaSize > SRThreshold) continue;
912
Bob Wilson3992feb2010-02-03 17:23:56 +0000913 // If the alloca looks like a good candidate for scalar replacement, and if
914 // all its users can be transformed, then split up the aggregate into its
915 // separate elements.
916 if (ShouldAttemptScalarRepl(AI) && isSafeAllocaToScalarRepl(AI)) {
917 DoScalarReplacement(AI, WorkList);
918 Changed = true;
919 continue;
920 }
921
Chris Lattner6e733d32009-01-28 20:16:43 +0000922 // If we can turn this aggregate value (potentially with casts) into a
923 // simple scalar value that can be mem2reg'd into a register value.
Chris Lattner2e0d5f82009-01-31 02:28:54 +0000924 // IsNotTrivial tracks whether this is something that mem2reg could have
925 // promoted itself. If so, we don't want to transform it needlessly. Note
926 // that we can't just check based on the type: the alloca may be of an i32
927 // but that has pointer arithmetic to set byte 3 of it or something.
Chris Lattner593375d2010-04-16 00:20:00 +0000928 if (AllocaInst *NewAI =
929 ConvertToScalarInfo((unsigned)AllocaSize, *TD).TryConvert(AI)) {
Chris Lattner7809ecd2009-02-03 01:30:09 +0000930 NewAI->takeName(AI);
931 AI->eraseFromParent();
932 ++NumConverted;
933 Changed = true;
934 continue;
Chris Lattner593375d2010-04-16 00:20:00 +0000935 }
Chris Lattner6e733d32009-01-28 20:16:43 +0000936
Chris Lattner7809ecd2009-02-03 01:30:09 +0000937 // Otherwise, couldn't process this alloca.
Chris Lattnered7b41e2003-05-27 15:45:27 +0000938 }
939
940 return Changed;
941}
Chris Lattner5e062a12003-05-30 04:15:41 +0000942
Chris Lattnera10b29b2007-04-25 05:02:56 +0000943/// DoScalarReplacement - This alloca satisfied the isSafeAllocaToScalarRepl
944/// predicate, do SROA now.
Victor Hernandez7b929da2009-10-23 21:09:37 +0000945void SROA::DoScalarReplacement(AllocaInst *AI,
946 std::vector<AllocaInst*> &WorkList) {
David Greene504c7d82010-01-05 01:27:09 +0000947 DEBUG(dbgs() << "Found inst to SROA: " << *AI << '\n');
Chris Lattnera10b29b2007-04-25 05:02:56 +0000948 SmallVector<AllocaInst*, 32> ElementAllocas;
949 if (const StructType *ST = dyn_cast<StructType>(AI->getAllocatedType())) {
950 ElementAllocas.reserve(ST->getNumContainedTypes());
951 for (unsigned i = 0, e = ST->getNumContainedTypes(); i != e; ++i) {
Owen Anderson50dead02009-07-15 23:53:25 +0000952 AllocaInst *NA = new AllocaInst(ST->getContainedType(i), 0,
Chris Lattnera10b29b2007-04-25 05:02:56 +0000953 AI->getAlignment(),
Daniel Dunbarfe09b202009-07-30 17:37:43 +0000954 AI->getName() + "." + Twine(i), AI);
Chris Lattnera10b29b2007-04-25 05:02:56 +0000955 ElementAllocas.push_back(NA);
956 WorkList.push_back(NA); // Add to worklist for recursive processing
957 }
958 } else {
959 const ArrayType *AT = cast<ArrayType>(AI->getAllocatedType());
960 ElementAllocas.reserve(AT->getNumElements());
961 const Type *ElTy = AT->getElementType();
962 for (unsigned i = 0, e = AT->getNumElements(); i != e; ++i) {
Owen Anderson50dead02009-07-15 23:53:25 +0000963 AllocaInst *NA = new AllocaInst(ElTy, 0, AI->getAlignment(),
Daniel Dunbarfe09b202009-07-30 17:37:43 +0000964 AI->getName() + "." + Twine(i), AI);
Chris Lattnera10b29b2007-04-25 05:02:56 +0000965 ElementAllocas.push_back(NA);
966 WorkList.push_back(NA); // Add to worklist for recursive processing
967 }
968 }
969
Bob Wilsonb742def2009-12-18 20:14:40 +0000970 // Now that we have created the new alloca instructions, rewrite all the
971 // uses of the old alloca.
972 RewriteForScalarRepl(AI, AI, 0, ElementAllocas);
Chris Lattnera59adc42009-12-14 05:11:02 +0000973
Bob Wilsonb742def2009-12-18 20:14:40 +0000974 // Now erase any instructions that were made dead while rewriting the alloca.
975 DeleteDeadInstructions();
Bob Wilson39c88a62009-12-17 18:34:24 +0000976 AI->eraseFromParent();
Bob Wilsonb742def2009-12-18 20:14:40 +0000977
Dan Gohmanfe601042010-06-22 15:08:57 +0000978 ++NumReplaced;
Chris Lattnera10b29b2007-04-25 05:02:56 +0000979}
Chris Lattnera59adc42009-12-14 05:11:02 +0000980
Bob Wilsonb742def2009-12-18 20:14:40 +0000981/// DeleteDeadInstructions - Erase instructions on the DeadInstrs list,
982/// recursively including all their operands that become trivially dead.
983void SROA::DeleteDeadInstructions() {
984 while (!DeadInsts.empty()) {
985 Instruction *I = cast<Instruction>(DeadInsts.pop_back_val());
Chris Lattnera59adc42009-12-14 05:11:02 +0000986
Bob Wilsonb742def2009-12-18 20:14:40 +0000987 for (User::op_iterator OI = I->op_begin(), E = I->op_end(); OI != E; ++OI)
988 if (Instruction *U = dyn_cast<Instruction>(*OI)) {
989 // Zero out the operand and see if it becomes trivially dead.
990 // (But, don't add allocas to the dead instruction list -- they are
991 // already on the worklist and will be deleted separately.)
992 *OI = 0;
993 if (isInstructionTriviallyDead(U) && !isa<AllocaInst>(U))
994 DeadInsts.push_back(U);
Chris Lattnera59adc42009-12-14 05:11:02 +0000995 }
Bob Wilsonb742def2009-12-18 20:14:40 +0000996
997 I->eraseFromParent();
Chris Lattnera59adc42009-12-14 05:11:02 +0000998 }
Chris Lattnera59adc42009-12-14 05:11:02 +0000999}
Bob Wilsonb742def2009-12-18 20:14:40 +00001000
Bob Wilsonb742def2009-12-18 20:14:40 +00001001/// isSafeForScalarRepl - Check if instruction I is a safe use with regard to
1002/// performing scalar replacement of alloca AI. The results are flagged in
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001003/// the Info parameter. Offset indicates the position within AI that is
1004/// referenced by this instruction.
Bob Wilsonb742def2009-12-18 20:14:40 +00001005void SROA::isSafeForScalarRepl(Instruction *I, AllocaInst *AI, uint64_t Offset,
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001006 AllocaInfo &Info) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001007 for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI!=E; ++UI) {
1008 Instruction *User = cast<Instruction>(*UI);
Chris Lattnerbe883a22003-11-25 21:09:18 +00001009
Bob Wilsonb742def2009-12-18 20:14:40 +00001010 if (BitCastInst *BC = dyn_cast<BitCastInst>(User)) {
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001011 isSafeForScalarRepl(BC, AI, Offset, Info);
Bob Wilsonb742def2009-12-18 20:14:40 +00001012 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001013 uint64_t GEPOffset = Offset;
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001014 isSafeGEP(GEPI, AI, GEPOffset, Info);
Bob Wilsonb742def2009-12-18 20:14:40 +00001015 if (!Info.isUnsafe)
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001016 isSafeForScalarRepl(GEPI, AI, GEPOffset, Info);
Gabor Greif19101c72010-06-28 11:20:42 +00001017 } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(User)) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001018 ConstantInt *Length = dyn_cast<ConstantInt>(MI->getLength());
1019 if (Length)
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001020 isSafeMemAccess(AI, Offset, Length->getZExtValue(), 0,
Gabor Greifa6aac4c2010-07-16 09:38:02 +00001021 UI.getOperandNo() == 0, Info);
Bob Wilsonb742def2009-12-18 20:14:40 +00001022 else
1023 MarkUnsafe(Info);
1024 } else if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
1025 if (!LI->isVolatile()) {
1026 const Type *LIType = LI->getType();
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001027 isSafeMemAccess(AI, Offset, TD->getTypeAllocSize(LIType),
Bob Wilsonb742def2009-12-18 20:14:40 +00001028 LIType, false, Info);
1029 } else
1030 MarkUnsafe(Info);
1031 } else if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
1032 // Store is ok if storing INTO the pointer, not storing the pointer
1033 if (!SI->isVolatile() && SI->getOperand(0) != I) {
1034 const Type *SIType = SI->getOperand(0)->getType();
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001035 isSafeMemAccess(AI, Offset, TD->getTypeAllocSize(SIType),
Bob Wilsonb742def2009-12-18 20:14:40 +00001036 SIType, true, Info);
1037 } else
1038 MarkUnsafe(Info);
Bob Wilsonb742def2009-12-18 20:14:40 +00001039 } else {
1040 DEBUG(errs() << " Transformation preventing inst: " << *User << '\n');
1041 MarkUnsafe(Info);
1042 }
1043 if (Info.isUnsafe) return;
Bob Wilson39c88a62009-12-17 18:34:24 +00001044 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001045}
Bob Wilson39c88a62009-12-17 18:34:24 +00001046
Bob Wilsonb742def2009-12-18 20:14:40 +00001047/// isSafeGEP - Check if a GEP instruction can be handled for scalar
1048/// replacement. It is safe when all the indices are constant, in-bounds
1049/// references, and when the resulting offset corresponds to an element within
1050/// the alloca type. The results are flagged in the Info parameter. Upon
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001051/// return, Offset is adjusted as specified by the GEP indices.
Bob Wilsonb742def2009-12-18 20:14:40 +00001052void SROA::isSafeGEP(GetElementPtrInst *GEPI, AllocaInst *AI,
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001053 uint64_t &Offset, AllocaInfo &Info) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001054 gep_type_iterator GEPIt = gep_type_begin(GEPI), E = gep_type_end(GEPI);
1055 if (GEPIt == E)
1056 return;
Bob Wilson39c88a62009-12-17 18:34:24 +00001057
Chris Lattner88e6dc82008-08-23 05:21:06 +00001058 // Walk through the GEP type indices, checking the types that this indexes
1059 // into.
Bob Wilsonb742def2009-12-18 20:14:40 +00001060 for (; GEPIt != E; ++GEPIt) {
Chris Lattner88e6dc82008-08-23 05:21:06 +00001061 // Ignore struct elements, no extra checking needed for these.
Duncan Sands1df98592010-02-16 11:11:14 +00001062 if ((*GEPIt)->isStructTy())
Chris Lattner88e6dc82008-08-23 05:21:06 +00001063 continue;
Matthijs Kooijman5fac55f2008-10-06 16:23:31 +00001064
Bob Wilsonb742def2009-12-18 20:14:40 +00001065 ConstantInt *IdxVal = dyn_cast<ConstantInt>(GEPIt.getOperand());
1066 if (!IdxVal)
1067 return MarkUnsafe(Info);
Chris Lattner88e6dc82008-08-23 05:21:06 +00001068 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001069
Bob Wilsonf27a4cd2009-12-22 06:57:14 +00001070 // Compute the offset due to this GEP and check if the alloca has a
1071 // component element at that offset.
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001072 SmallVector<Value*, 8> Indices(GEPI->op_begin() + 1, GEPI->op_end());
1073 Offset += TD->getIndexedOffset(GEPI->getPointerOperandType(),
1074 &Indices[0], Indices.size());
Bob Wilsonb742def2009-12-18 20:14:40 +00001075 if (!TypeHasComponent(AI->getAllocatedType(), Offset, 0))
1076 MarkUnsafe(Info);
Chris Lattner5e062a12003-05-30 04:15:41 +00001077}
1078
Bob Wilsonb742def2009-12-18 20:14:40 +00001079/// isSafeMemAccess - Check if a load/store/memcpy operates on the entire AI
1080/// alloca or has an offset and size that corresponds to a component element
1081/// within it. The offset checked here may have been formed from a GEP with a
1082/// pointer bitcasted to a different type.
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001083void SROA::isSafeMemAccess(AllocaInst *AI, uint64_t Offset, uint64_t MemSize,
Bob Wilsonb742def2009-12-18 20:14:40 +00001084 const Type *MemOpType, bool isStore,
1085 AllocaInfo &Info) {
1086 // Check if this is a load/store of the entire alloca.
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001087 if (Offset == 0 && MemSize == TD->getTypeAllocSize(AI->getAllocatedType())) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001088 bool UsesAggregateType = (MemOpType == AI->getAllocatedType());
1089 // This is safe for MemIntrinsics (where MemOpType is 0), integer types
1090 // (which are essentially the same as the MemIntrinsics, especially with
1091 // regard to copying padding between elements), or references using the
1092 // aggregate type of the alloca.
Duncan Sands1df98592010-02-16 11:11:14 +00001093 if (!MemOpType || MemOpType->isIntegerTy() || UsesAggregateType) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001094 if (!UsesAggregateType) {
1095 if (isStore)
1096 Info.isMemCpyDst = true;
1097 else
1098 Info.isMemCpySrc = true;
1099 }
1100 return;
1101 }
1102 }
1103 // Check if the offset/size correspond to a component within the alloca type.
1104 const Type *T = AI->getAllocatedType();
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001105 if (TypeHasComponent(T, Offset, MemSize))
Bob Wilsonb742def2009-12-18 20:14:40 +00001106 return;
1107
1108 return MarkUnsafe(Info);
1109}
1110
1111/// TypeHasComponent - Return true if T has a component type with the
1112/// specified offset and size. If Size is zero, do not check the size.
1113bool SROA::TypeHasComponent(const Type *T, uint64_t Offset, uint64_t Size) {
1114 const Type *EltTy;
1115 uint64_t EltSize;
1116 if (const StructType *ST = dyn_cast<StructType>(T)) {
1117 const StructLayout *Layout = TD->getStructLayout(ST);
1118 unsigned EltIdx = Layout->getElementContainingOffset(Offset);
1119 EltTy = ST->getContainedType(EltIdx);
1120 EltSize = TD->getTypeAllocSize(EltTy);
1121 Offset -= Layout->getElementOffset(EltIdx);
1122 } else if (const ArrayType *AT = dyn_cast<ArrayType>(T)) {
1123 EltTy = AT->getElementType();
1124 EltSize = TD->getTypeAllocSize(EltTy);
Bob Wilsonf27a4cd2009-12-22 06:57:14 +00001125 if (Offset >= AT->getNumElements() * EltSize)
1126 return false;
Bob Wilsonb742def2009-12-18 20:14:40 +00001127 Offset %= EltSize;
1128 } else {
1129 return false;
1130 }
1131 if (Offset == 0 && (Size == 0 || EltSize == Size))
1132 return true;
1133 // Check if the component spans multiple elements.
1134 if (Offset + Size > EltSize)
1135 return false;
1136 return TypeHasComponent(EltTy, Offset, Size);
1137}
1138
1139/// RewriteForScalarRepl - Alloca AI is being split into NewElts, so rewrite
1140/// the instruction I, which references it, to use the separate elements.
1141/// Offset indicates the position within AI that is referenced by this
1142/// instruction.
1143void SROA::RewriteForScalarRepl(Instruction *I, AllocaInst *AI, uint64_t Offset,
1144 SmallVector<AllocaInst*, 32> &NewElts) {
1145 for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI!=E; ++UI) {
1146 Instruction *User = cast<Instruction>(*UI);
1147
1148 if (BitCastInst *BC = dyn_cast<BitCastInst>(User)) {
1149 RewriteBitCast(BC, AI, Offset, NewElts);
1150 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
1151 RewriteGEP(GEPI, AI, Offset, NewElts);
1152 } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(User)) {
1153 ConstantInt *Length = dyn_cast<ConstantInt>(MI->getLength());
1154 uint64_t MemSize = Length->getZExtValue();
1155 if (Offset == 0 &&
1156 MemSize == TD->getTypeAllocSize(AI->getAllocatedType()))
1157 RewriteMemIntrinUserOfAlloca(MI, I, AI, NewElts);
Bob Wilsone88728d2009-12-19 06:53:17 +00001158 // Otherwise the intrinsic can only touch a single element and the
1159 // address operand will be updated, so nothing else needs to be done.
Bob Wilsonb742def2009-12-18 20:14:40 +00001160 } else if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
1161 const Type *LIType = LI->getType();
1162 if (LIType == AI->getAllocatedType()) {
1163 // Replace:
1164 // %res = load { i32, i32 }* %alloc
1165 // with:
1166 // %load.0 = load i32* %alloc.0
1167 // %insert.0 insertvalue { i32, i32 } zeroinitializer, i32 %load.0, 0
1168 // %load.1 = load i32* %alloc.1
1169 // %insert = insertvalue { i32, i32 } %insert.0, i32 %load.1, 1
1170 // (Also works for arrays instead of structs)
1171 Value *Insert = UndefValue::get(LIType);
1172 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
1173 Value *Load = new LoadInst(NewElts[i], "load", LI);
1174 Insert = InsertValueInst::Create(Insert, Load, i, "insert", LI);
1175 }
1176 LI->replaceAllUsesWith(Insert);
1177 DeadInsts.push_back(LI);
Duncan Sands1df98592010-02-16 11:11:14 +00001178 } else if (LIType->isIntegerTy() &&
Bob Wilsonb742def2009-12-18 20:14:40 +00001179 TD->getTypeAllocSize(LIType) ==
1180 TD->getTypeAllocSize(AI->getAllocatedType())) {
1181 // If this is a load of the entire alloca to an integer, rewrite it.
1182 RewriteLoadUserOfWholeAlloca(LI, AI, NewElts);
1183 }
1184 } else if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
1185 Value *Val = SI->getOperand(0);
1186 const Type *SIType = Val->getType();
1187 if (SIType == AI->getAllocatedType()) {
1188 // Replace:
1189 // store { i32, i32 } %val, { i32, i32 }* %alloc
1190 // with:
1191 // %val.0 = extractvalue { i32, i32 } %val, 0
1192 // store i32 %val.0, i32* %alloc.0
1193 // %val.1 = extractvalue { i32, i32 } %val, 1
1194 // store i32 %val.1, i32* %alloc.1
1195 // (Also works for arrays instead of structs)
1196 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
1197 Value *Extract = ExtractValueInst::Create(Val, i, Val->getName(), SI);
1198 new StoreInst(Extract, NewElts[i], SI);
1199 }
1200 DeadInsts.push_back(SI);
Duncan Sands1df98592010-02-16 11:11:14 +00001201 } else if (SIType->isIntegerTy() &&
Bob Wilsonb742def2009-12-18 20:14:40 +00001202 TD->getTypeAllocSize(SIType) ==
1203 TD->getTypeAllocSize(AI->getAllocatedType())) {
1204 // If this is a store of the entire alloca from an integer, rewrite it.
1205 RewriteStoreUserOfWholeAlloca(SI, AI, NewElts);
1206 }
1207 }
Bob Wilson39c88a62009-12-17 18:34:24 +00001208 }
1209}
1210
Bob Wilsonb742def2009-12-18 20:14:40 +00001211/// RewriteBitCast - Update a bitcast reference to the alloca being replaced
1212/// and recursively continue updating all of its uses.
1213void SROA::RewriteBitCast(BitCastInst *BC, AllocaInst *AI, uint64_t Offset,
1214 SmallVector<AllocaInst*, 32> &NewElts) {
1215 RewriteForScalarRepl(BC, AI, Offset, NewElts);
1216 if (BC->getOperand(0) != AI)
1217 return;
Bob Wilson39c88a62009-12-17 18:34:24 +00001218
Bob Wilsonb742def2009-12-18 20:14:40 +00001219 // The bitcast references the original alloca. Replace its uses with
1220 // references to the first new element alloca.
1221 Instruction *Val = NewElts[0];
1222 if (Val->getType() != BC->getDestTy()) {
1223 Val = new BitCastInst(Val, BC->getDestTy(), "", BC);
1224 Val->takeName(BC);
Daniel Dunbarfca55c82009-12-16 10:56:17 +00001225 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001226 BC->replaceAllUsesWith(Val);
1227 DeadInsts.push_back(BC);
Daniel Dunbarfca55c82009-12-16 10:56:17 +00001228}
1229
Bob Wilsonb742def2009-12-18 20:14:40 +00001230/// FindElementAndOffset - Return the index of the element containing Offset
1231/// within the specified type, which must be either a struct or an array.
1232/// Sets T to the type of the element and Offset to the offset within that
Bob Wilsone88728d2009-12-19 06:53:17 +00001233/// element. IdxTy is set to the type of the index result to be used in a
1234/// GEP instruction.
1235uint64_t SROA::FindElementAndOffset(const Type *&T, uint64_t &Offset,
1236 const Type *&IdxTy) {
1237 uint64_t Idx = 0;
Bob Wilsonb742def2009-12-18 20:14:40 +00001238 if (const StructType *ST = dyn_cast<StructType>(T)) {
1239 const StructLayout *Layout = TD->getStructLayout(ST);
1240 Idx = Layout->getElementContainingOffset(Offset);
1241 T = ST->getContainedType(Idx);
1242 Offset -= Layout->getElementOffset(Idx);
Bob Wilsone88728d2009-12-19 06:53:17 +00001243 IdxTy = Type::getInt32Ty(T->getContext());
1244 return Idx;
Chris Lattnera59adc42009-12-14 05:11:02 +00001245 }
Bob Wilsone88728d2009-12-19 06:53:17 +00001246 const ArrayType *AT = cast<ArrayType>(T);
1247 T = AT->getElementType();
1248 uint64_t EltSize = TD->getTypeAllocSize(T);
1249 Idx = Offset / EltSize;
1250 Offset -= Idx * EltSize;
1251 IdxTy = Type::getInt64Ty(T->getContext());
Bob Wilsonb742def2009-12-18 20:14:40 +00001252 return Idx;
1253}
1254
1255/// RewriteGEP - Check if this GEP instruction moves the pointer across
1256/// elements of the alloca that are being split apart, and if so, rewrite
1257/// the GEP to be relative to the new element.
1258void SROA::RewriteGEP(GetElementPtrInst *GEPI, AllocaInst *AI, uint64_t Offset,
1259 SmallVector<AllocaInst*, 32> &NewElts) {
1260 uint64_t OldOffset = Offset;
1261 SmallVector<Value*, 8> Indices(GEPI->op_begin() + 1, GEPI->op_end());
1262 Offset += TD->getIndexedOffset(GEPI->getPointerOperandType(),
1263 &Indices[0], Indices.size());
1264
1265 RewriteForScalarRepl(GEPI, AI, Offset, NewElts);
1266
1267 const Type *T = AI->getAllocatedType();
Bob Wilsone88728d2009-12-19 06:53:17 +00001268 const Type *IdxTy;
1269 uint64_t OldIdx = FindElementAndOffset(T, OldOffset, IdxTy);
Bob Wilsonb742def2009-12-18 20:14:40 +00001270 if (GEPI->getOperand(0) == AI)
Bob Wilsone88728d2009-12-19 06:53:17 +00001271 OldIdx = ~0ULL; // Force the GEP to be rewritten.
Bob Wilsonb742def2009-12-18 20:14:40 +00001272
1273 T = AI->getAllocatedType();
1274 uint64_t EltOffset = Offset;
Bob Wilsone88728d2009-12-19 06:53:17 +00001275 uint64_t Idx = FindElementAndOffset(T, EltOffset, IdxTy);
Bob Wilsonb742def2009-12-18 20:14:40 +00001276
1277 // If this GEP does not move the pointer across elements of the alloca
1278 // being split, then it does not needs to be rewritten.
1279 if (Idx == OldIdx)
1280 return;
1281
1282 const Type *i32Ty = Type::getInt32Ty(AI->getContext());
1283 SmallVector<Value*, 8> NewArgs;
1284 NewArgs.push_back(Constant::getNullValue(i32Ty));
1285 while (EltOffset != 0) {
Bob Wilsone88728d2009-12-19 06:53:17 +00001286 uint64_t EltIdx = FindElementAndOffset(T, EltOffset, IdxTy);
1287 NewArgs.push_back(ConstantInt::get(IdxTy, EltIdx));
Bob Wilsonb742def2009-12-18 20:14:40 +00001288 }
1289 Instruction *Val = NewElts[Idx];
1290 if (NewArgs.size() > 1) {
1291 Val = GetElementPtrInst::CreateInBounds(Val, NewArgs.begin(),
1292 NewArgs.end(), "", GEPI);
1293 Val->takeName(GEPI);
1294 }
1295 if (Val->getType() != GEPI->getType())
Benjamin Kramer2d64ca02010-01-27 19:46:52 +00001296 Val = new BitCastInst(Val, GEPI->getType(), Val->getName(), GEPI);
Bob Wilsonb742def2009-12-18 20:14:40 +00001297 GEPI->replaceAllUsesWith(Val);
1298 DeadInsts.push_back(GEPI);
Chris Lattnerd93afec2009-01-07 07:18:45 +00001299}
1300
1301/// RewriteMemIntrinUserOfAlloca - MI is a memcpy/memset/memmove from or to AI.
1302/// Rewrite it to copy or set the elements of the scalarized memory.
Bob Wilsonb742def2009-12-18 20:14:40 +00001303void SROA::RewriteMemIntrinUserOfAlloca(MemIntrinsic *MI, Instruction *Inst,
Victor Hernandez7b929da2009-10-23 21:09:37 +00001304 AllocaInst *AI,
Chris Lattnerd93afec2009-01-07 07:18:45 +00001305 SmallVector<AllocaInst*, 32> &NewElts) {
Chris Lattnerd93afec2009-01-07 07:18:45 +00001306 // If this is a memcpy/memmove, construct the other pointer as the
Chris Lattner88fe1ad2009-03-04 19:23:25 +00001307 // appropriate type. The "Other" pointer is the pointer that goes to memory
1308 // that doesn't have anything to do with the alloca that we are promoting. For
1309 // memset, this Value* stays null.
Chris Lattnerd93afec2009-01-07 07:18:45 +00001310 Value *OtherPtr = 0;
Chris Lattnerdfe964c2009-03-08 03:59:00 +00001311 unsigned MemAlignment = MI->getAlignment();
Chris Lattner3ce5e882009-03-08 03:37:16 +00001312 if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(MI)) { // memmove/memcopy
Bob Wilsonb742def2009-12-18 20:14:40 +00001313 if (Inst == MTI->getRawDest())
Chris Lattner3ce5e882009-03-08 03:37:16 +00001314 OtherPtr = MTI->getRawSource();
Chris Lattnerd93afec2009-01-07 07:18:45 +00001315 else {
Bob Wilsonb742def2009-12-18 20:14:40 +00001316 assert(Inst == MTI->getRawSource());
Chris Lattner3ce5e882009-03-08 03:37:16 +00001317 OtherPtr = MTI->getRawDest();
Chris Lattnerd93afec2009-01-07 07:18:45 +00001318 }
1319 }
Bob Wilson78c50b82009-12-08 18:22:03 +00001320
Chris Lattnerd93afec2009-01-07 07:18:45 +00001321 // If there is an other pointer, we want to convert it to the same pointer
1322 // type as AI has, so we can GEP through it safely.
1323 if (OtherPtr) {
Chris Lattner0238f8c2010-07-08 00:27:05 +00001324 unsigned AddrSpace =
1325 cast<PointerType>(OtherPtr->getType())->getAddressSpace();
Bob Wilsonb742def2009-12-18 20:14:40 +00001326
1327 // Remove bitcasts and all-zero GEPs from OtherPtr. This is an
1328 // optimization, but it's also required to detect the corner case where
1329 // both pointer operands are referencing the same memory, and where
1330 // OtherPtr may be a bitcast or GEP that currently being rewritten. (This
1331 // function is only called for mem intrinsics that access the whole
1332 // aggregate, so non-zero GEPs are not an issue here.)
Chris Lattner0238f8c2010-07-08 00:27:05 +00001333 OtherPtr = OtherPtr->stripPointerCasts();
1334
Bob Wilsona756b1d2010-01-19 04:32:48 +00001335 // Copying the alloca to itself is a no-op: just delete it.
1336 if (OtherPtr == AI || OtherPtr == NewElts[0]) {
1337 // This code will run twice for a no-op memcpy -- once for each operand.
1338 // Put only one reference to MI on the DeadInsts list.
1339 for (SmallVector<Value*, 32>::const_iterator I = DeadInsts.begin(),
1340 E = DeadInsts.end(); I != E; ++I)
1341 if (*I == MI) return;
1342 DeadInsts.push_back(MI);
Bob Wilsonb742def2009-12-18 20:14:40 +00001343 return;
Bob Wilsona756b1d2010-01-19 04:32:48 +00001344 }
Chris Lattner372dda82007-03-05 07:52:57 +00001345
Chris Lattnerd93afec2009-01-07 07:18:45 +00001346 // If the pointer is not the right type, insert a bitcast to the right
1347 // type.
Chris Lattner0238f8c2010-07-08 00:27:05 +00001348 const Type *NewTy =
1349 PointerType::get(AI->getType()->getElementType(), AddrSpace);
1350
1351 if (OtherPtr->getType() != NewTy)
1352 OtherPtr = new BitCastInst(OtherPtr, NewTy, OtherPtr->getName(), MI);
Chris Lattnerd93afec2009-01-07 07:18:45 +00001353 }
1354
1355 // Process each element of the aggregate.
Bob Wilsonb742def2009-12-18 20:14:40 +00001356 bool SROADest = MI->getRawDest() == Inst;
Chris Lattnerd93afec2009-01-07 07:18:45 +00001357
Owen Anderson1d0be152009-08-13 21:58:54 +00001358 Constant *Zero = Constant::getNullValue(Type::getInt32Ty(MI->getContext()));
Chris Lattnerd93afec2009-01-07 07:18:45 +00001359
1360 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
1361 // If this is a memcpy/memmove, emit a GEP of the other element address.
1362 Value *OtherElt = 0;
Chris Lattner1541e0f2009-03-04 19:20:50 +00001363 unsigned OtherEltAlign = MemAlignment;
1364
Bob Wilsona756b1d2010-01-19 04:32:48 +00001365 if (OtherPtr) {
Owen Anderson1d0be152009-08-13 21:58:54 +00001366 Value *Idx[2] = { Zero,
1367 ConstantInt::get(Type::getInt32Ty(MI->getContext()), i) };
Bob Wilsonb742def2009-12-18 20:14:40 +00001368 OtherElt = GetElementPtrInst::CreateInBounds(OtherPtr, Idx, Idx + 2,
Benjamin Kramer2d64ca02010-01-27 19:46:52 +00001369 OtherPtr->getName()+"."+Twine(i),
Bob Wilsonb742def2009-12-18 20:14:40 +00001370 MI);
Chris Lattner1541e0f2009-03-04 19:20:50 +00001371 uint64_t EltOffset;
1372 const PointerType *OtherPtrTy = cast<PointerType>(OtherPtr->getType());
Chris Lattnerd55c1c12010-04-16 01:05:38 +00001373 const Type *OtherTy = OtherPtrTy->getElementType();
1374 if (const StructType *ST = dyn_cast<StructType>(OtherTy)) {
Chris Lattner1541e0f2009-03-04 19:20:50 +00001375 EltOffset = TD->getStructLayout(ST)->getElementOffset(i);
1376 } else {
Chris Lattnerd55c1c12010-04-16 01:05:38 +00001377 const Type *EltTy = cast<SequentialType>(OtherTy)->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +00001378 EltOffset = TD->getTypeAllocSize(EltTy)*i;
Chris Lattner1541e0f2009-03-04 19:20:50 +00001379 }
1380
1381 // The alignment of the other pointer is the guaranteed alignment of the
1382 // element, which is affected by both the known alignment of the whole
1383 // mem intrinsic and the alignment of the element. If the alignment of
1384 // the memcpy (f.e.) is 32 but the element is at a 4-byte offset, then the
1385 // known alignment is just 4 bytes.
1386 OtherEltAlign = (unsigned)MinAlign(OtherEltAlign, EltOffset);
Chris Lattnerc14d3ca2007-03-08 06:36:54 +00001387 }
Chris Lattnerd93afec2009-01-07 07:18:45 +00001388
1389 Value *EltPtr = NewElts[i];
Chris Lattner1541e0f2009-03-04 19:20:50 +00001390 const Type *EltTy = cast<PointerType>(EltPtr->getType())->getElementType();
Chris Lattnerd93afec2009-01-07 07:18:45 +00001391
1392 // If we got down to a scalar, insert a load or store as appropriate.
1393 if (EltTy->isSingleValueType()) {
Chris Lattner3ce5e882009-03-08 03:37:16 +00001394 if (isa<MemTransferInst>(MI)) {
Chris Lattner1541e0f2009-03-04 19:20:50 +00001395 if (SROADest) {
1396 // From Other to Alloca.
1397 Value *Elt = new LoadInst(OtherElt, "tmp", false, OtherEltAlign, MI);
1398 new StoreInst(Elt, EltPtr, MI);
1399 } else {
1400 // From Alloca to Other.
1401 Value *Elt = new LoadInst(EltPtr, "tmp", MI);
1402 new StoreInst(Elt, OtherElt, false, OtherEltAlign, MI);
1403 }
Chris Lattnerd93afec2009-01-07 07:18:45 +00001404 continue;
1405 }
1406 assert(isa<MemSetInst>(MI));
1407
1408 // If the stored element is zero (common case), just store a null
1409 // constant.
1410 Constant *StoreVal;
Gabor Greif6f14c8c2010-06-30 09:16:16 +00001411 if (ConstantInt *CI = dyn_cast<ConstantInt>(MI->getArgOperand(1))) {
Chris Lattnerd93afec2009-01-07 07:18:45 +00001412 if (CI->isZero()) {
Owen Andersona7235ea2009-07-31 20:28:14 +00001413 StoreVal = Constant::getNullValue(EltTy); // 0.0, null, 0, <0,0>
Chris Lattnerd93afec2009-01-07 07:18:45 +00001414 } else {
1415 // If EltTy is a vector type, get the element type.
Dan Gohman44118f02009-06-16 00:20:26 +00001416 const Type *ValTy = EltTy->getScalarType();
1417
Chris Lattnerd93afec2009-01-07 07:18:45 +00001418 // Construct an integer with the right value.
1419 unsigned EltSize = TD->getTypeSizeInBits(ValTy);
1420 APInt OneVal(EltSize, CI->getZExtValue());
1421 APInt TotalVal(OneVal);
1422 // Set each byte.
1423 for (unsigned i = 0; 8*i < EltSize; ++i) {
1424 TotalVal = TotalVal.shl(8);
1425 TotalVal |= OneVal;
1426 }
1427
1428 // Convert the integer value to the appropriate type.
Chris Lattnerd55c1c12010-04-16 01:05:38 +00001429 StoreVal = ConstantInt::get(CI->getContext(), TotalVal);
Duncan Sands1df98592010-02-16 11:11:14 +00001430 if (ValTy->isPointerTy())
Owen Andersonbaf3c402009-07-29 18:55:55 +00001431 StoreVal = ConstantExpr::getIntToPtr(StoreVal, ValTy);
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00001432 else if (ValTy->isFloatingPointTy())
Owen Andersonbaf3c402009-07-29 18:55:55 +00001433 StoreVal = ConstantExpr::getBitCast(StoreVal, ValTy);
Chris Lattnerd93afec2009-01-07 07:18:45 +00001434 assert(StoreVal->getType() == ValTy && "Type mismatch!");
1435
1436 // If the requested value was a vector constant, create it.
1437 if (EltTy != ValTy) {
1438 unsigned NumElts = cast<VectorType>(ValTy)->getNumElements();
1439 SmallVector<Constant*, 16> Elts(NumElts, StoreVal);
Owen Andersonaf7ec972009-07-28 21:19:26 +00001440 StoreVal = ConstantVector::get(&Elts[0], NumElts);
Chris Lattnerd93afec2009-01-07 07:18:45 +00001441 }
1442 }
1443 new StoreInst(StoreVal, EltPtr, MI);
1444 continue;
1445 }
1446 // Otherwise, if we're storing a byte variable, use a memset call for
1447 // this element.
1448 }
Chris Lattner61db1f52010-12-26 22:57:41 +00001449
Duncan Sands777d2302009-05-09 07:06:46 +00001450 unsigned EltSize = TD->getTypeAllocSize(EltTy);
Chris Lattnerd93afec2009-01-07 07:18:45 +00001451
Chris Lattner61db1f52010-12-26 22:57:41 +00001452 IRBuilder<> Builder(MI);
1453
Chris Lattnerd93afec2009-01-07 07:18:45 +00001454 // Finally, insert the meminst for this element.
Chris Lattner61db1f52010-12-26 22:57:41 +00001455 if (isa<MemSetInst>(MI)) {
1456 Builder.CreateMemSet(EltPtr, MI->getArgOperand(1), EltSize,
1457 MI->isVolatile());
Chris Lattnerd93afec2009-01-07 07:18:45 +00001458 } else {
Chris Lattner61db1f52010-12-26 22:57:41 +00001459 assert(isa<MemTransferInst>(MI));
1460 Value *Dst = SROADest ? EltPtr : OtherElt; // Dest ptr
1461 Value *Src = SROADest ? OtherElt : EltPtr; // Src ptr
1462
1463 if (isa<MemCpyInst>(MI))
1464 Builder.CreateMemCpy(Dst, Src, EltSize, OtherEltAlign,MI->isVolatile());
1465 else
1466 Builder.CreateMemMove(Dst, Src, EltSize,OtherEltAlign,MI->isVolatile());
Chris Lattnerd93afec2009-01-07 07:18:45 +00001467 }
Chris Lattner372dda82007-03-05 07:52:57 +00001468 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001469 DeadInsts.push_back(MI);
Chris Lattner372dda82007-03-05 07:52:57 +00001470}
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001471
Bob Wilson39fdd692009-12-04 21:57:37 +00001472/// RewriteStoreUserOfWholeAlloca - We found a store of an integer that
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001473/// overwrites the entire allocation. Extract out the pieces of the stored
1474/// integer and store them individually.
Victor Hernandez7b929da2009-10-23 21:09:37 +00001475void SROA::RewriteStoreUserOfWholeAlloca(StoreInst *SI, AllocaInst *AI,
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001476 SmallVector<AllocaInst*, 32> &NewElts){
1477 // Extract each element out of the integer according to its structure offset
1478 // and store the element value to the individual alloca.
1479 Value *SrcVal = SI->getOperand(0);
Bob Wilsonb742def2009-12-18 20:14:40 +00001480 const Type *AllocaEltTy = AI->getAllocatedType();
Duncan Sands777d2302009-05-09 07:06:46 +00001481 uint64_t AllocaSizeBits = TD->getTypeAllocSizeInBits(AllocaEltTy);
Chris Lattnerd93afec2009-01-07 07:18:45 +00001482
Eli Friedman41b33f42009-06-01 09:14:32 +00001483 // Handle tail padding by extending the operand
1484 if (TD->getTypeSizeInBits(SrcVal->getType()) != AllocaSizeBits)
Owen Andersonfa5cbd62009-07-03 19:42:02 +00001485 SrcVal = new ZExtInst(SrcVal,
Owen Anderson1d0be152009-08-13 21:58:54 +00001486 IntegerType::get(SI->getContext(), AllocaSizeBits),
1487 "", SI);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001488
David Greene504c7d82010-01-05 01:27:09 +00001489 DEBUG(dbgs() << "PROMOTING STORE TO WHOLE ALLOCA: " << *AI << '\n' << *SI
Nick Lewycky59136252009-09-15 07:08:25 +00001490 << '\n');
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001491
1492 // There are two forms here: AI could be an array or struct. Both cases
1493 // have different ways to compute the element offset.
1494 if (const StructType *EltSTy = dyn_cast<StructType>(AllocaEltTy)) {
1495 const StructLayout *Layout = TD->getStructLayout(EltSTy);
1496
1497 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
1498 // Get the number of bits to shift SrcVal to get the value.
1499 const Type *FieldTy = EltSTy->getElementType(i);
1500 uint64_t Shift = Layout->getElementOffsetInBits(i);
1501
1502 if (TD->isBigEndian())
Duncan Sands777d2302009-05-09 07:06:46 +00001503 Shift = AllocaSizeBits-Shift-TD->getTypeAllocSizeInBits(FieldTy);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001504
1505 Value *EltVal = SrcVal;
1506 if (Shift) {
Owen Andersoneed707b2009-07-24 23:12:02 +00001507 Value *ShiftVal = ConstantInt::get(EltVal->getType(), Shift);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001508 EltVal = BinaryOperator::CreateLShr(EltVal, ShiftVal,
1509 "sroa.store.elt", SI);
1510 }
1511
1512 // Truncate down to an integer of the right size.
1513 uint64_t FieldSizeBits = TD->getTypeSizeInBits(FieldTy);
Chris Lattner583dd602009-01-09 18:18:43 +00001514
1515 // Ignore zero sized fields like {}, they obviously contain no data.
1516 if (FieldSizeBits == 0) continue;
1517
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001518 if (FieldSizeBits != AllocaSizeBits)
Owen Andersonfa5cbd62009-07-03 19:42:02 +00001519 EltVal = new TruncInst(EltVal,
Owen Anderson1d0be152009-08-13 21:58:54 +00001520 IntegerType::get(SI->getContext(), FieldSizeBits),
1521 "", SI);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001522 Value *DestField = NewElts[i];
1523 if (EltVal->getType() == FieldTy) {
1524 // Storing to an integer field of this size, just do it.
Duncan Sands1df98592010-02-16 11:11:14 +00001525 } else if (FieldTy->isFloatingPointTy() || FieldTy->isVectorTy()) {
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001526 // Bitcast to the right element type (for fp/vector values).
1527 EltVal = new BitCastInst(EltVal, FieldTy, "", SI);
1528 } else {
1529 // Otherwise, bitcast the dest pointer (for aggregates).
1530 DestField = new BitCastInst(DestField,
Owen Andersondebcb012009-07-29 22:17:13 +00001531 PointerType::getUnqual(EltVal->getType()),
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001532 "", SI);
1533 }
1534 new StoreInst(EltVal, DestField, SI);
1535 }
1536
1537 } else {
1538 const ArrayType *ATy = cast<ArrayType>(AllocaEltTy);
1539 const Type *ArrayEltTy = ATy->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +00001540 uint64_t ElementOffset = TD->getTypeAllocSizeInBits(ArrayEltTy);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001541 uint64_t ElementSizeBits = TD->getTypeSizeInBits(ArrayEltTy);
1542
1543 uint64_t Shift;
1544
1545 if (TD->isBigEndian())
1546 Shift = AllocaSizeBits-ElementOffset;
1547 else
1548 Shift = 0;
1549
1550 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
Chris Lattner583dd602009-01-09 18:18:43 +00001551 // Ignore zero sized fields like {}, they obviously contain no data.
1552 if (ElementSizeBits == 0) continue;
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001553
1554 Value *EltVal = SrcVal;
1555 if (Shift) {
Owen Andersoneed707b2009-07-24 23:12:02 +00001556 Value *ShiftVal = ConstantInt::get(EltVal->getType(), Shift);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001557 EltVal = BinaryOperator::CreateLShr(EltVal, ShiftVal,
1558 "sroa.store.elt", SI);
1559 }
1560
1561 // Truncate down to an integer of the right size.
1562 if (ElementSizeBits != AllocaSizeBits)
Owen Andersonfa5cbd62009-07-03 19:42:02 +00001563 EltVal = new TruncInst(EltVal,
Owen Anderson1d0be152009-08-13 21:58:54 +00001564 IntegerType::get(SI->getContext(),
1565 ElementSizeBits),"",SI);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001566 Value *DestField = NewElts[i];
1567 if (EltVal->getType() == ArrayEltTy) {
1568 // Storing to an integer field of this size, just do it.
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00001569 } else if (ArrayEltTy->isFloatingPointTy() ||
Duncan Sands1df98592010-02-16 11:11:14 +00001570 ArrayEltTy->isVectorTy()) {
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001571 // Bitcast to the right element type (for fp/vector values).
1572 EltVal = new BitCastInst(EltVal, ArrayEltTy, "", SI);
1573 } else {
1574 // Otherwise, bitcast the dest pointer (for aggregates).
1575 DestField = new BitCastInst(DestField,
Owen Andersondebcb012009-07-29 22:17:13 +00001576 PointerType::getUnqual(EltVal->getType()),
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001577 "", SI);
1578 }
1579 new StoreInst(EltVal, DestField, SI);
1580
1581 if (TD->isBigEndian())
1582 Shift -= ElementOffset;
1583 else
1584 Shift += ElementOffset;
1585 }
1586 }
1587
Bob Wilsonb742def2009-12-18 20:14:40 +00001588 DeadInsts.push_back(SI);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001589}
1590
Bob Wilson39fdd692009-12-04 21:57:37 +00001591/// RewriteLoadUserOfWholeAlloca - We found a load of the entire allocation to
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00001592/// an integer. Load the individual pieces to form the aggregate value.
Victor Hernandez7b929da2009-10-23 21:09:37 +00001593void SROA::RewriteLoadUserOfWholeAlloca(LoadInst *LI, AllocaInst *AI,
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00001594 SmallVector<AllocaInst*, 32> &NewElts) {
1595 // Extract each element out of the NewElts according to its structure offset
1596 // and form the result value.
Bob Wilsonb742def2009-12-18 20:14:40 +00001597 const Type *AllocaEltTy = AI->getAllocatedType();
Duncan Sands777d2302009-05-09 07:06:46 +00001598 uint64_t AllocaSizeBits = TD->getTypeAllocSizeInBits(AllocaEltTy);
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00001599
David Greene504c7d82010-01-05 01:27:09 +00001600 DEBUG(dbgs() << "PROMOTING LOAD OF WHOLE ALLOCA: " << *AI << '\n' << *LI
Nick Lewycky59136252009-09-15 07:08:25 +00001601 << '\n');
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00001602
1603 // There are two forms here: AI could be an array or struct. Both cases
1604 // have different ways to compute the element offset.
1605 const StructLayout *Layout = 0;
1606 uint64_t ArrayEltBitOffset = 0;
1607 if (const StructType *EltSTy = dyn_cast<StructType>(AllocaEltTy)) {
1608 Layout = TD->getStructLayout(EltSTy);
1609 } else {
1610 const Type *ArrayEltTy = cast<ArrayType>(AllocaEltTy)->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +00001611 ArrayEltBitOffset = TD->getTypeAllocSizeInBits(ArrayEltTy);
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00001612 }
Owen Andersone922c022009-07-22 00:24:57 +00001613
Owen Andersone922c022009-07-22 00:24:57 +00001614 Value *ResultVal =
Owen Anderson1d0be152009-08-13 21:58:54 +00001615 Constant::getNullValue(IntegerType::get(LI->getContext(), AllocaSizeBits));
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00001616
1617 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
1618 // Load the value from the alloca. If the NewElt is an aggregate, cast
1619 // the pointer to an integer of the same size before doing the load.
1620 Value *SrcField = NewElts[i];
1621 const Type *FieldTy =
1622 cast<PointerType>(SrcField->getType())->getElementType();
Chris Lattner583dd602009-01-09 18:18:43 +00001623 uint64_t FieldSizeBits = TD->getTypeSizeInBits(FieldTy);
1624
1625 // Ignore zero sized fields like {}, they obviously contain no data.
1626 if (FieldSizeBits == 0) continue;
1627
Owen Anderson1d0be152009-08-13 21:58:54 +00001628 const IntegerType *FieldIntTy = IntegerType::get(LI->getContext(),
1629 FieldSizeBits);
Duncan Sands1df98592010-02-16 11:11:14 +00001630 if (!FieldTy->isIntegerTy() && !FieldTy->isFloatingPointTy() &&
1631 !FieldTy->isVectorTy())
Owen Andersonfa5cbd62009-07-03 19:42:02 +00001632 SrcField = new BitCastInst(SrcField,
Owen Andersondebcb012009-07-29 22:17:13 +00001633 PointerType::getUnqual(FieldIntTy),
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00001634 "", LI);
1635 SrcField = new LoadInst(SrcField, "sroa.load.elt", LI);
1636
1637 // If SrcField is a fp or vector of the right size but that isn't an
1638 // integer type, bitcast to an integer so we can shift it.
1639 if (SrcField->getType() != FieldIntTy)
1640 SrcField = new BitCastInst(SrcField, FieldIntTy, "", LI);
1641
1642 // Zero extend the field to be the same size as the final alloca so that
1643 // we can shift and insert it.
1644 if (SrcField->getType() != ResultVal->getType())
1645 SrcField = new ZExtInst(SrcField, ResultVal->getType(), "", LI);
1646
1647 // Determine the number of bits to shift SrcField.
1648 uint64_t Shift;
1649 if (Layout) // Struct case.
1650 Shift = Layout->getElementOffsetInBits(i);
1651 else // Array case.
1652 Shift = i*ArrayEltBitOffset;
1653
1654 if (TD->isBigEndian())
1655 Shift = AllocaSizeBits-Shift-FieldIntTy->getBitWidth();
1656
1657 if (Shift) {
Owen Andersoneed707b2009-07-24 23:12:02 +00001658 Value *ShiftVal = ConstantInt::get(SrcField->getType(), Shift);
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00001659 SrcField = BinaryOperator::CreateShl(SrcField, ShiftVal, "", LI);
1660 }
1661
Chris Lattner14952472010-06-27 07:58:26 +00001662 // Don't create an 'or x, 0' on the first iteration.
1663 if (!isa<Constant>(ResultVal) ||
1664 !cast<Constant>(ResultVal)->isNullValue())
1665 ResultVal = BinaryOperator::CreateOr(SrcField, ResultVal, "", LI);
1666 else
1667 ResultVal = SrcField;
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00001668 }
Eli Friedman41b33f42009-06-01 09:14:32 +00001669
1670 // Handle tail padding by truncating the result
1671 if (TD->getTypeSizeInBits(LI->getType()) != AllocaSizeBits)
1672 ResultVal = new TruncInst(ResultVal, LI->getType(), "", LI);
1673
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00001674 LI->replaceAllUsesWith(ResultVal);
Bob Wilsonb742def2009-12-18 20:14:40 +00001675 DeadInsts.push_back(LI);
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00001676}
1677
Duncan Sands3cb36502007-11-04 14:43:57 +00001678/// HasPadding - Return true if the specified type has any structure or
1679/// alignment padding, false otherwise.
Duncan Sandsa0fcc082008-06-04 08:21:45 +00001680static bool HasPadding(const Type *Ty, const TargetData &TD) {
Chris Lattner91abace2010-09-01 05:14:33 +00001681 if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty))
1682 return HasPadding(ATy->getElementType(), TD);
1683
1684 if (const VectorType *VTy = dyn_cast<VectorType>(Ty))
1685 return HasPadding(VTy->getElementType(), TD);
1686
Chris Lattner39a1c042007-05-30 06:11:23 +00001687 if (const StructType *STy = dyn_cast<StructType>(Ty)) {
1688 const StructLayout *SL = TD.getStructLayout(STy);
1689 unsigned PrevFieldBitOffset = 0;
1690 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
Duncan Sands3cb36502007-11-04 14:43:57 +00001691 unsigned FieldBitOffset = SL->getElementOffsetInBits(i);
1692
Chris Lattner39a1c042007-05-30 06:11:23 +00001693 // Padding in sub-elements?
Duncan Sandsa0fcc082008-06-04 08:21:45 +00001694 if (HasPadding(STy->getElementType(i), TD))
Chris Lattner39a1c042007-05-30 06:11:23 +00001695 return true;
Duncan Sands3cb36502007-11-04 14:43:57 +00001696
Chris Lattner39a1c042007-05-30 06:11:23 +00001697 // Check to see if there is any padding between this element and the
1698 // previous one.
1699 if (i) {
Duncan Sands3cb36502007-11-04 14:43:57 +00001700 unsigned PrevFieldEnd =
Chris Lattner39a1c042007-05-30 06:11:23 +00001701 PrevFieldBitOffset+TD.getTypeSizeInBits(STy->getElementType(i-1));
1702 if (PrevFieldEnd < FieldBitOffset)
1703 return true;
1704 }
Duncan Sands3cb36502007-11-04 14:43:57 +00001705
Chris Lattner39a1c042007-05-30 06:11:23 +00001706 PrevFieldBitOffset = FieldBitOffset;
1707 }
Duncan Sands3cb36502007-11-04 14:43:57 +00001708
Chris Lattner39a1c042007-05-30 06:11:23 +00001709 // Check for tail padding.
1710 if (unsigned EltCount = STy->getNumElements()) {
1711 unsigned PrevFieldEnd = PrevFieldBitOffset +
1712 TD.getTypeSizeInBits(STy->getElementType(EltCount-1));
Duncan Sands3cb36502007-11-04 14:43:57 +00001713 if (PrevFieldEnd < SL->getSizeInBits())
Chris Lattner39a1c042007-05-30 06:11:23 +00001714 return true;
1715 }
Chris Lattner39a1c042007-05-30 06:11:23 +00001716 }
Chris Lattner91abace2010-09-01 05:14:33 +00001717
Duncan Sands777d2302009-05-09 07:06:46 +00001718 return TD.getTypeSizeInBits(Ty) != TD.getTypeAllocSizeInBits(Ty);
Chris Lattner39a1c042007-05-30 06:11:23 +00001719}
Chris Lattner372dda82007-03-05 07:52:57 +00001720
Chris Lattnerf5990ed2004-11-14 04:24:28 +00001721/// isSafeStructAllocaToScalarRepl - Check to see if the specified allocation of
1722/// an aggregate can be broken down into elements. Return 0 if not, 3 if safe,
1723/// or 1 if safe after canonicalization has been performed.
Victor Hernandez6c146ee2010-01-21 23:05:53 +00001724bool SROA::isSafeAllocaToScalarRepl(AllocaInst *AI) {
Chris Lattner5e062a12003-05-30 04:15:41 +00001725 // Loop over the use list of the alloca. We can only transform it if all of
1726 // the users are safe to transform.
Chris Lattner39a1c042007-05-30 06:11:23 +00001727 AllocaInfo Info;
1728
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001729 isSafeForScalarRepl(AI, AI, 0, Info);
Bob Wilsonb742def2009-12-18 20:14:40 +00001730 if (Info.isUnsafe) {
David Greene504c7d82010-01-05 01:27:09 +00001731 DEBUG(dbgs() << "Cannot transform: " << *AI << '\n');
Victor Hernandez6c146ee2010-01-21 23:05:53 +00001732 return false;
Chris Lattnerf5990ed2004-11-14 04:24:28 +00001733 }
Chris Lattner39a1c042007-05-30 06:11:23 +00001734
1735 // Okay, we know all the users are promotable. If the aggregate is a memcpy
1736 // source and destination, we have to be careful. In particular, the memcpy
1737 // could be moving around elements that live in structure padding of the LLVM
1738 // types, but may actually be used. In these cases, we refuse to promote the
1739 // struct.
1740 if (Info.isMemCpySrc && Info.isMemCpyDst &&
Bob Wilsonb742def2009-12-18 20:14:40 +00001741 HasPadding(AI->getAllocatedType(), *TD))
Victor Hernandez6c146ee2010-01-21 23:05:53 +00001742 return false;
Duncan Sands3cb36502007-11-04 14:43:57 +00001743
Victor Hernandez6c146ee2010-01-21 23:05:53 +00001744 return true;
Chris Lattner5e062a12003-05-30 04:15:41 +00001745}
Chris Lattnera1888942005-12-12 07:19:13 +00001746
Chris Lattner800de312008-02-29 07:03:13 +00001747
Chris Lattner79b3bd32007-04-25 06:40:51 +00001748
1749/// PointsToConstantGlobal - Return true if V (possibly indirectly) points to
1750/// some part of a constant global variable. This intentionally only accepts
1751/// constant expressions because we don't can't rewrite arbitrary instructions.
1752static bool PointsToConstantGlobal(Value *V) {
1753 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
1754 return GV->isConstant();
1755 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
1756 if (CE->getOpcode() == Instruction::BitCast ||
1757 CE->getOpcode() == Instruction::GetElementPtr)
1758 return PointsToConstantGlobal(CE->getOperand(0));
1759 return false;
1760}
1761
1762/// isOnlyCopiedFromConstantGlobal - Recursively walk the uses of a (derived)
1763/// pointer to an alloca. Ignore any reads of the pointer, return false if we
1764/// see any stores or other unknown uses. If we see pointer arithmetic, keep
1765/// track of whether it moves the pointer (with isOffset) but otherwise traverse
1766/// the uses. If we see a memcpy/memmove that targets an unoffseted pointer to
Nick Lewycky081f8002010-11-24 22:04:20 +00001767/// the alloca, and if the source pointer is a pointer to a constant global, we
Chris Lattner79b3bd32007-04-25 06:40:51 +00001768/// can optimize this.
Chris Lattner31d80102010-04-15 21:59:20 +00001769static bool isOnlyCopiedFromConstantGlobal(Value *V, MemTransferInst *&TheCopy,
Chris Lattner79b3bd32007-04-25 06:40:51 +00001770 bool isOffset) {
1771 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI!=E; ++UI) {
Gabor Greif8a8a4352010-04-06 19:32:30 +00001772 User *U = cast<Instruction>(*UI);
1773
Chris Lattner2e618492010-11-18 06:20:47 +00001774 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattner6e733d32009-01-28 20:16:43 +00001775 // Ignore non-volatile loads, they are always ok.
Chris Lattner2e618492010-11-18 06:20:47 +00001776 if (LI->isVolatile()) return false;
1777 continue;
1778 }
Chris Lattner6e733d32009-01-28 20:16:43 +00001779
Gabor Greif8a8a4352010-04-06 19:32:30 +00001780 if (BitCastInst *BCI = dyn_cast<BitCastInst>(U)) {
Chris Lattner79b3bd32007-04-25 06:40:51 +00001781 // If uses of the bitcast are ok, we are ok.
1782 if (!isOnlyCopiedFromConstantGlobal(BCI, TheCopy, isOffset))
1783 return false;
1784 continue;
1785 }
Gabor Greif8a8a4352010-04-06 19:32:30 +00001786 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner79b3bd32007-04-25 06:40:51 +00001787 // If the GEP has all zero indices, it doesn't offset the pointer. If it
1788 // doesn't, it does.
1789 if (!isOnlyCopiedFromConstantGlobal(GEP, TheCopy,
1790 isOffset || !GEP->hasAllZeroIndices()))
1791 return false;
1792 continue;
1793 }
1794
Chris Lattner62480652010-11-18 06:41:51 +00001795 if (CallSite CS = U) {
1796 // If this is a readonly/readnone call site, then we know it is just a
1797 // load and we can ignore it.
Chris Lattnera9be1df2010-11-18 06:26:49 +00001798 if (CS.onlyReadsMemory())
1799 continue;
Nick Lewycky081f8002010-11-24 22:04:20 +00001800
1801 // If this is the function being called then we treat it like a load and
1802 // ignore it.
1803 if (CS.isCallee(UI))
1804 continue;
Chris Lattner62480652010-11-18 06:41:51 +00001805
1806 // If this is being passed as a byval argument, the caller is making a
1807 // copy, so it is only a read of the alloca.
1808 unsigned ArgNo = CS.getArgumentNo(UI);
1809 if (CS.paramHasAttr(ArgNo+1, Attribute::ByVal))
1810 continue;
1811 }
Chris Lattnera9be1df2010-11-18 06:26:49 +00001812
Chris Lattner79b3bd32007-04-25 06:40:51 +00001813 // If this is isn't our memcpy/memmove, reject it as something we can't
1814 // handle.
Chris Lattner31d80102010-04-15 21:59:20 +00001815 MemTransferInst *MI = dyn_cast<MemTransferInst>(U);
1816 if (MI == 0)
Chris Lattner79b3bd32007-04-25 06:40:51 +00001817 return false;
Chris Lattner2e618492010-11-18 06:20:47 +00001818
1819 // If the transfer is using the alloca as a source of the transfer, then
Chris Lattner2e29ebd2010-11-18 07:32:33 +00001820 // ignore it since it is a load (unless the transfer is volatile).
Chris Lattner2e618492010-11-18 06:20:47 +00001821 if (UI.getOperandNo() == 1) {
1822 if (MI->isVolatile()) return false;
1823 continue;
1824 }
Chris Lattner79b3bd32007-04-25 06:40:51 +00001825
1826 // If we already have seen a copy, reject the second one.
1827 if (TheCopy) return false;
1828
1829 // If the pointer has been offset from the start of the alloca, we can't
1830 // safely handle this.
1831 if (isOffset) return false;
1832
1833 // If the memintrinsic isn't using the alloca as the dest, reject it.
Gabor Greifa6aac4c2010-07-16 09:38:02 +00001834 if (UI.getOperandNo() != 0) return false;
Chris Lattner79b3bd32007-04-25 06:40:51 +00001835
Chris Lattner79b3bd32007-04-25 06:40:51 +00001836 // If the source of the memcpy/move is not a constant global, reject it.
Chris Lattner31d80102010-04-15 21:59:20 +00001837 if (!PointsToConstantGlobal(MI->getSource()))
Chris Lattner79b3bd32007-04-25 06:40:51 +00001838 return false;
1839
1840 // Otherwise, the transform is safe. Remember the copy instruction.
1841 TheCopy = MI;
1842 }
1843 return true;
1844}
1845
1846/// isOnlyCopiedFromConstantGlobal - Return true if the specified alloca is only
1847/// modified by a copy from a constant global. If we can prove this, we can
1848/// replace any uses of the alloca with uses of the global directly.
Chris Lattner31d80102010-04-15 21:59:20 +00001849MemTransferInst *SROA::isOnlyCopiedFromConstantGlobal(AllocaInst *AI) {
1850 MemTransferInst *TheCopy = 0;
Chris Lattner79b3bd32007-04-25 06:40:51 +00001851 if (::isOnlyCopiedFromConstantGlobal(AI, TheCopy, false))
1852 return TheCopy;
1853 return 0;
1854}