blob: bc6035e1faebab9e0c0d046f2f15bbd055a41af6 [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"
Cameron Zwarichb1686c32011-01-18 03:53:26 +000033#include "llvm/Analysis/Dominators.h"
Chris Lattnerc87c50a2011-01-23 22:04:55 +000034#include "llvm/Analysis/Loads.h"
Dan Gohman5034dd32010-12-15 20:02:24 +000035#include "llvm/Analysis/ValueTracking.h"
Chris Lattner38aec322003-09-11 16:45:55 +000036#include "llvm/Target/TargetData.h"
37#include "llvm/Transforms/Utils/PromoteMemToReg.h"
Devang Patel4afc90d2009-02-10 07:00:59 +000038#include "llvm/Transforms/Utils/Local.h"
Chris Lattnere0a1a5b2011-01-14 07:50:47 +000039#include "llvm/Transforms/Utils/SSAUpdater.h"
Chris Lattnera9be1df2010-11-18 06:26:49 +000040#include "llvm/Support/CallSite.h"
Chris Lattner95255282006-06-28 23:17:24 +000041#include "llvm/Support/Debug.h"
Torok Edwin7d696d82009-07-11 13:10:19 +000042#include "llvm/Support/ErrorHandling.h"
Chris Lattnera1888942005-12-12 07:19:13 +000043#include "llvm/Support/GetElementPtrTypeIterator.h"
Chris Lattner65a65022009-02-03 19:41:50 +000044#include "llvm/Support/IRBuilder.h"
Chris Lattnera1888942005-12-12 07:19:13 +000045#include "llvm/Support/MathExtras.h"
Chris Lattnerbdff5482009-08-23 04:37:46 +000046#include "llvm/Support/raw_ostream.h"
Chris Lattnerc87c50a2011-01-23 22:04:55 +000047#include "llvm/ADT/SetVector.h"
Chris Lattner1ccd1852007-02-12 22:56:41 +000048#include "llvm/ADT/SmallVector.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000049#include "llvm/ADT/Statistic.h"
Chris Lattnerd8664732003-12-02 17:43:55 +000050using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000051
Chris Lattner0e5f4992006-12-19 21:40:18 +000052STATISTIC(NumReplaced, "Number of allocas broken up");
53STATISTIC(NumPromoted, "Number of allocas promoted");
Chris Lattnerc87c50a2011-01-23 22:04:55 +000054STATISTIC(NumAdjusted, "Number of scalar allocas adjusted to allow promotion");
Chris Lattner0e5f4992006-12-19 21:40:18 +000055STATISTIC(NumConverted, "Number of aggregates converted to scalar");
Chris Lattner79b3bd32007-04-25 06:40:51 +000056STATISTIC(NumGlobals, "Number of allocas copied from constant global");
Chris Lattnered7b41e2003-05-27 15:45:27 +000057
Chris Lattner0e5f4992006-12-19 21:40:18 +000058namespace {
Chris Lattner3e8b6632009-09-02 06:11:42 +000059 struct SROA : public FunctionPass {
Cameron Zwarichb1686c32011-01-18 03:53:26 +000060 SROA(int T, bool hasDT, char &ID)
61 : FunctionPass(ID), HasDomTree(hasDT) {
Devang Patelff366852007-07-09 21:19:23 +000062 if (T == -1)
Chris Lattnerb0e71ed2007-08-02 21:33:36 +000063 SRThreshold = 128;
Devang Patelff366852007-07-09 21:19:23 +000064 else
65 SRThreshold = T;
66 }
Devang Patel794fd752007-05-01 21:15:47 +000067
Chris Lattnered7b41e2003-05-27 15:45:27 +000068 bool runOnFunction(Function &F);
69
Chris Lattner38aec322003-09-11 16:45:55 +000070 bool performScalarRepl(Function &F);
71 bool performPromotion(Function &F);
72
Chris Lattnered7b41e2003-05-27 15:45:27 +000073 private:
Cameron Zwarichb1686c32011-01-18 03:53:26 +000074 bool HasDomTree;
Chris Lattner56c38522009-01-07 06:34:28 +000075 TargetData *TD;
Bob Wilson69743022011-01-13 20:59:44 +000076
Bob Wilsonb742def2009-12-18 20:14:40 +000077 /// DeadInsts - Keep track of instructions we have made dead, so that
78 /// we can remove them after we are done working.
79 SmallVector<Value*, 32> DeadInsts;
80
Chris Lattner39a1c042007-05-30 06:11:23 +000081 /// AllocaInfo - When analyzing uses of an alloca instruction, this captures
82 /// information about the uses. All these fields are initialized to false
83 /// and set to true when something is learned.
84 struct AllocaInfo {
Chris Lattner6c95d242011-01-23 07:29:29 +000085 /// The alloca to promote.
86 AllocaInst *AI;
87
Chris Lattner145c5322011-01-23 08:27:54 +000088 /// CheckedPHIs - This is a set of verified PHI nodes, to prevent infinite
89 /// looping and avoid redundant work.
90 SmallPtrSet<PHINode*, 8> CheckedPHIs;
91
Chris Lattner39a1c042007-05-30 06:11:23 +000092 /// isUnsafe - This is set to true if the alloca cannot be SROA'd.
93 bool isUnsafe : 1;
Bob Wilson69743022011-01-13 20:59:44 +000094
Chris Lattner39a1c042007-05-30 06:11:23 +000095 /// isMemCpySrc - This is true if this aggregate is memcpy'd from.
96 bool isMemCpySrc : 1;
97
Zhou Sheng33b0b8d2007-07-06 06:01:16 +000098 /// isMemCpyDst - This is true if this aggregate is memcpy'd into.
Chris Lattner39a1c042007-05-30 06:11:23 +000099 bool isMemCpyDst : 1;
100
Chris Lattner7e9b4272011-01-16 06:18:28 +0000101 /// hasSubelementAccess - This is true if a subelement of the alloca is
102 /// ever accessed, or false if the alloca is only accessed with mem
103 /// intrinsics or load/store that only access the entire alloca at once.
104 bool hasSubelementAccess : 1;
105
106 /// hasALoadOrStore - This is true if there are any loads or stores to it.
107 /// The alloca may just be accessed with memcpy, for example, which would
108 /// not set this.
109 bool hasALoadOrStore : 1;
110
Chris Lattner6c95d242011-01-23 07:29:29 +0000111 explicit AllocaInfo(AllocaInst *ai)
112 : AI(ai), isUnsafe(false), isMemCpySrc(false), isMemCpyDst(false),
Chris Lattner7e9b4272011-01-16 06:18:28 +0000113 hasSubelementAccess(false), hasALoadOrStore(false) {}
Chris Lattner39a1c042007-05-30 06:11:23 +0000114 };
Bob Wilson69743022011-01-13 20:59:44 +0000115
Devang Patelff366852007-07-09 21:19:23 +0000116 unsigned SRThreshold;
117
Chris Lattnerd01a0da2011-01-23 07:05:44 +0000118 void MarkUnsafe(AllocaInfo &I, Instruction *User) {
119 I.isUnsafe = true;
120 DEBUG(dbgs() << " Transformation preventing inst: " << *User << '\n');
121 }
Chris Lattner39a1c042007-05-30 06:11:23 +0000122
Victor Hernandez6c146ee2010-01-21 23:05:53 +0000123 bool isSafeAllocaToScalarRepl(AllocaInst *AI);
Chris Lattner39a1c042007-05-30 06:11:23 +0000124
Chris Lattner6c95d242011-01-23 07:29:29 +0000125 void isSafeForScalarRepl(Instruction *I, uint64_t Offset, AllocaInfo &Info);
Chris Lattner145c5322011-01-23 08:27:54 +0000126 void isSafePHISelectUseForScalarRepl(Instruction *User, uint64_t Offset,
127 AllocaInfo &Info);
Chris Lattner6c95d242011-01-23 07:29:29 +0000128 void isSafeGEP(GetElementPtrInst *GEPI, uint64_t &Offset, AllocaInfo &Info);
129 void isSafeMemAccess(uint64_t Offset, uint64_t MemSize,
Chris Lattnerd01a0da2011-01-23 07:05:44 +0000130 const Type *MemOpType, bool isStore, AllocaInfo &Info,
Chris Lattner145c5322011-01-23 08:27:54 +0000131 Instruction *TheAccess, bool AllowWholeAccess);
Bob Wilsonb742def2009-12-18 20:14:40 +0000132 bool TypeHasComponent(const Type *T, uint64_t Offset, uint64_t Size);
Bob Wilsone88728d2009-12-19 06:53:17 +0000133 uint64_t FindElementAndOffset(const Type *&T, uint64_t &Offset,
134 const Type *&IdxTy);
Bob Wilson69743022011-01-13 20:59:44 +0000135
136 void DoScalarReplacement(AllocaInst *AI,
Victor Hernandez7b929da2009-10-23 21:09:37 +0000137 std::vector<AllocaInst*> &WorkList);
Bob Wilsonb742def2009-12-18 20:14:40 +0000138 void DeleteDeadInstructions();
Bob Wilson69743022011-01-13 20:59:44 +0000139
Bob Wilsonb742def2009-12-18 20:14:40 +0000140 void RewriteForScalarRepl(Instruction *I, AllocaInst *AI, uint64_t Offset,
141 SmallVector<AllocaInst*, 32> &NewElts);
142 void RewriteBitCast(BitCastInst *BC, AllocaInst *AI, uint64_t Offset,
143 SmallVector<AllocaInst*, 32> &NewElts);
144 void RewriteGEP(GetElementPtrInst *GEPI, AllocaInst *AI, uint64_t Offset,
145 SmallVector<AllocaInst*, 32> &NewElts);
146 void RewriteMemIntrinUserOfAlloca(MemIntrinsic *MI, Instruction *Inst,
Victor Hernandez7b929da2009-10-23 21:09:37 +0000147 AllocaInst *AI,
Chris Lattnerd93afec2009-01-07 07:18:45 +0000148 SmallVector<AllocaInst*, 32> &NewElts);
Victor Hernandez7b929da2009-10-23 21:09:37 +0000149 void RewriteStoreUserOfWholeAlloca(StoreInst *SI, AllocaInst *AI,
Chris Lattnerd2fa7812009-01-07 08:11:13 +0000150 SmallVector<AllocaInst*, 32> &NewElts);
Victor Hernandez7b929da2009-10-23 21:09:37 +0000151 void RewriteLoadUserOfWholeAlloca(LoadInst *LI, AllocaInst *AI,
Chris Lattner6e733d32009-01-28 20:16:43 +0000152 SmallVector<AllocaInst*, 32> &NewElts);
Bob Wilson69743022011-01-13 20:59:44 +0000153
Chris Lattner31d80102010-04-15 21:59:20 +0000154 static MemTransferInst *isOnlyCopiedFromConstantGlobal(AllocaInst *AI);
Chris Lattnered7b41e2003-05-27 15:45:27 +0000155 };
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000156
Cameron Zwarichb1686c32011-01-18 03:53:26 +0000157 // SROA_DT - SROA that uses DominatorTree.
158 struct SROA_DT : public SROA {
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000159 static char ID;
160 public:
Cameron Zwarichb1686c32011-01-18 03:53:26 +0000161 SROA_DT(int T = -1) : SROA(T, true, ID) {
162 initializeSROA_DTPass(*PassRegistry::getPassRegistry());
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000163 }
164
165 // getAnalysisUsage - This pass does not require any passes, but we know it
166 // will not alter the CFG, so say so.
167 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
168 AU.addRequired<DominatorTree>();
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000169 AU.setPreservesCFG();
170 }
171 };
172
173 // SROA_SSAUp - SROA that uses SSAUpdater.
174 struct SROA_SSAUp : public SROA {
175 static char ID;
176 public:
177 SROA_SSAUp(int T = -1) : SROA(T, false, ID) {
178 initializeSROA_SSAUpPass(*PassRegistry::getPassRegistry());
179 }
180
181 // getAnalysisUsage - This pass does not require any passes, but we know it
182 // will not alter the CFG, so say so.
183 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
184 AU.setPreservesCFG();
185 }
186 };
187
Chris Lattnered7b41e2003-05-27 15:45:27 +0000188}
189
Cameron Zwarichb1686c32011-01-18 03:53:26 +0000190char SROA_DT::ID = 0;
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000191char SROA_SSAUp::ID = 0;
192
Cameron Zwarichb1686c32011-01-18 03:53:26 +0000193INITIALIZE_PASS_BEGIN(SROA_DT, "scalarrepl",
194 "Scalar Replacement of Aggregates (DT)", false, false)
Owen Anderson2ab36d32010-10-12 19:48:12 +0000195INITIALIZE_PASS_DEPENDENCY(DominatorTree)
Cameron Zwarichb1686c32011-01-18 03:53:26 +0000196INITIALIZE_PASS_END(SROA_DT, "scalarrepl",
197 "Scalar Replacement of Aggregates (DT)", false, false)
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000198
199INITIALIZE_PASS_BEGIN(SROA_SSAUp, "scalarrepl-ssa",
200 "Scalar Replacement of Aggregates (SSAUp)", false, false)
201INITIALIZE_PASS_END(SROA_SSAUp, "scalarrepl-ssa",
202 "Scalar Replacement of Aggregates (SSAUp)", false, false)
Dan Gohman844731a2008-05-13 00:00:25 +0000203
Brian Gaeked0fde302003-11-11 22:41:34 +0000204// Public interface to the ScalarReplAggregates pass
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000205FunctionPass *llvm::createScalarReplAggregatesPass(int Threshold,
Cameron Zwarichb1686c32011-01-18 03:53:26 +0000206 bool UseDomTree) {
207 if (UseDomTree)
208 return new SROA_DT(Threshold);
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000209 return new SROA_SSAUp(Threshold);
Devang Patelff366852007-07-09 21:19:23 +0000210}
Chris Lattnered7b41e2003-05-27 15:45:27 +0000211
212
Chris Lattner4cc576b2010-04-16 00:24:57 +0000213//===----------------------------------------------------------------------===//
214// Convert To Scalar Optimization.
215//===----------------------------------------------------------------------===//
216
217namespace {
Chris Lattnera001b662010-04-16 00:38:19 +0000218/// ConvertToScalarInfo - This class implements the "Convert To Scalar"
219/// optimization, which scans the uses of an alloca and determines if it can
220/// rewrite it in terms of a single new alloca that can be mem2reg'd.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000221class ConvertToScalarInfo {
222 /// AllocaSize - The size of the alloca being considered.
223 unsigned AllocaSize;
224 const TargetData &TD;
Bob Wilson69743022011-01-13 20:59:44 +0000225
Chris Lattnera0bada72010-04-16 02:32:17 +0000226 /// IsNotTrivial - This is set to true if there is some access to the object
Chris Lattnera001b662010-04-16 00:38:19 +0000227 /// which means that mem2reg can't promote it.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000228 bool IsNotTrivial;
Bob Wilson69743022011-01-13 20:59:44 +0000229
Chris Lattnera001b662010-04-16 00:38:19 +0000230 /// VectorTy - This tracks the type that we should promote the vector to if
231 /// it is possible to turn it into a vector. This starts out null, and if it
232 /// isn't possible to turn into a vector type, it gets set to VoidTy.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000233 const Type *VectorTy;
Bob Wilson69743022011-01-13 20:59:44 +0000234
Chris Lattnera001b662010-04-16 00:38:19 +0000235 /// HadAVector - True if there is at least one vector access to the alloca.
236 /// We don't want to turn random arrays into vectors and use vector element
237 /// insert/extract, but if there are element accesses to something that is
238 /// also declared as a vector, we do want to promote to a vector.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000239 bool HadAVector;
240
241public:
242 explicit ConvertToScalarInfo(unsigned Size, const TargetData &td)
243 : AllocaSize(Size), TD(td) {
244 IsNotTrivial = false;
245 VectorTy = 0;
246 HadAVector = false;
247 }
Bob Wilson69743022011-01-13 20:59:44 +0000248
Chris Lattnera001b662010-04-16 00:38:19 +0000249 AllocaInst *TryConvert(AllocaInst *AI);
Bob Wilson69743022011-01-13 20:59:44 +0000250
Chris Lattner4cc576b2010-04-16 00:24:57 +0000251private:
252 bool CanConvertToScalar(Value *V, uint64_t Offset);
253 void MergeInType(const Type *In, uint64_t Offset);
Cameron Zwarichc9ecd142011-03-09 05:43:01 +0000254 bool MergeInVectorType(const VectorType *VInTy, uint64_t Offset);
Chris Lattner4cc576b2010-04-16 00:24:57 +0000255 void ConvertUsesToScalar(Value *Ptr, AllocaInst *NewAI, uint64_t Offset);
Bob Wilson69743022011-01-13 20:59:44 +0000256
Chris Lattner4cc576b2010-04-16 00:24:57 +0000257 Value *ConvertScalar_ExtractValue(Value *NV, const Type *ToType,
258 uint64_t Offset, IRBuilder<> &Builder);
259 Value *ConvertScalar_InsertValue(Value *StoredVal, Value *ExistingVal,
260 uint64_t Offset, IRBuilder<> &Builder);
261};
262} // end anonymous namespace.
263
Chris Lattner91abace2010-09-01 05:14:33 +0000264
Chris Lattnera001b662010-04-16 00:38:19 +0000265/// TryConvert - Analyze the specified alloca, and if it is safe to do so,
266/// rewrite it to be a new alloca which is mem2reg'able. This returns the new
267/// alloca if possible or null if not.
268AllocaInst *ConvertToScalarInfo::TryConvert(AllocaInst *AI) {
269 // If we can't convert this scalar, or if mem2reg can trivially do it, bail
270 // out.
271 if (!CanConvertToScalar(AI, 0) || !IsNotTrivial)
272 return 0;
Bob Wilson69743022011-01-13 20:59:44 +0000273
Chris Lattnera001b662010-04-16 00:38:19 +0000274 // If we were able to find a vector type that can handle this with
275 // insert/extract elements, and if there was at least one use that had
276 // a vector type, promote this to a vector. We don't want to promote
277 // random stuff that doesn't use vectors (e.g. <9 x double>) because then
278 // we just get a lot of insert/extracts. If at least one vector is
279 // involved, then we probably really do have a union of vector/array.
280 const Type *NewTy;
Chris Lattner85a7c692011-01-23 06:40:33 +0000281 if (VectorTy && VectorTy->isVectorTy() && HadAVector) {
Chris Lattnera001b662010-04-16 00:38:19 +0000282 DEBUG(dbgs() << "CONVERT TO VECTOR: " << *AI << "\n TYPE = "
283 << *VectorTy << '\n');
284 NewTy = VectorTy; // Use the vector type.
285 } else {
286 DEBUG(dbgs() << "CONVERT TO SCALAR INTEGER: " << *AI << "\n");
287 // Create and insert the integer alloca.
288 NewTy = IntegerType::get(AI->getContext(), AllocaSize*8);
289 }
290 AllocaInst *NewAI = new AllocaInst(NewTy, 0, "", AI->getParent()->begin());
291 ConvertUsesToScalar(AI, NewAI, 0);
292 return NewAI;
293}
294
295/// MergeInType - Add the 'In' type to the accumulated vector type (VectorTy)
296/// so far at the offset specified by Offset (which is specified in bytes).
Chris Lattner4cc576b2010-04-16 00:24:57 +0000297///
298/// There are two cases we handle here:
299/// 1) A union of vector types of the same size and potentially its elements.
300/// Here we turn element accesses into insert/extract element operations.
301/// This promotes a <4 x float> with a store of float to the third element
302/// into a <4 x float> that uses insert element.
303/// 2) A fully general blob of memory, which we turn into some (potentially
304/// large) integer type with extract and insert operations where the loads
Chris Lattnera001b662010-04-16 00:38:19 +0000305/// and stores would mutate the memory. We mark this by setting VectorTy
306/// to VoidTy.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000307void ConvertToScalarInfo::MergeInType(const Type *In, uint64_t Offset) {
Chris Lattnera001b662010-04-16 00:38:19 +0000308 // If we already decided to turn this into a blob of integer memory, there is
309 // nothing to be done.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000310 if (VectorTy && VectorTy->isVoidTy())
311 return;
Bob Wilson69743022011-01-13 20:59:44 +0000312
Chris Lattner4cc576b2010-04-16 00:24:57 +0000313 // If this could be contributing to a vector, analyze it.
314
315 // If the In type is a vector that is the same size as the alloca, see if it
316 // matches the existing VecTy.
317 if (const VectorType *VInTy = dyn_cast<VectorType>(In)) {
Cameron Zwarichc9ecd142011-03-09 05:43:01 +0000318 if (MergeInVectorType(VInTy, Offset))
Chris Lattner4cc576b2010-04-16 00:24:57 +0000319 return;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000320 } else if (In->isFloatTy() || In->isDoubleTy() ||
321 (In->isIntegerTy() && In->getPrimitiveSizeInBits() >= 8 &&
322 isPowerOf2_32(In->getPrimitiveSizeInBits()))) {
323 // If we're accessing something that could be an element of a vector, see
324 // if the implied vector agrees with what we already have and if Offset is
325 // compatible with it.
326 unsigned EltSize = In->getPrimitiveSizeInBits()/8;
327 if (Offset % EltSize == 0 && AllocaSize % EltSize == 0 &&
Bob Wilson69743022011-01-13 20:59:44 +0000328 (VectorTy == 0 ||
Chris Lattner4cc576b2010-04-16 00:24:57 +0000329 cast<VectorType>(VectorTy)->getElementType()
330 ->getPrimitiveSizeInBits()/8 == EltSize)) {
331 if (VectorTy == 0)
332 VectorTy = VectorType::get(In, AllocaSize/EltSize);
333 return;
334 }
335 }
Bob Wilson69743022011-01-13 20:59:44 +0000336
Chris Lattner4cc576b2010-04-16 00:24:57 +0000337 // Otherwise, we have a case that we can't handle with an optimized vector
338 // form. We can still turn this into a large integer.
339 VectorTy = Type::getVoidTy(In->getContext());
340}
341
Cameron Zwarichc9ecd142011-03-09 05:43:01 +0000342/// MergeInVectorType - Handles the vector case of MergeInType, returning true
343/// if the type was successfully merged and false otherwise.
344bool ConvertToScalarInfo::MergeInVectorType(const VectorType *VInTy,
345 uint64_t Offset) {
346 // Remember if we saw a vector type.
347 HadAVector = true;
348
349 if (VInTy->getBitWidth()/8 == AllocaSize && Offset == 0) {
350 // If we're storing/loading a vector of the right size, allow it as a
351 // vector. If this the first vector we see, remember the type so that
352 // we know the element size. If this is a subsequent access, ignore it
353 // even if it is a differing type but the same size. Worst case we can
354 // bitcast the resultant vectors.
355 if (VectorTy == 0)
356 VectorTy = VInTy;
357 return true;
358 }
359
360 return false;
361}
362
Chris Lattner4cc576b2010-04-16 00:24:57 +0000363/// CanConvertToScalar - V is a pointer. If we can convert the pointee and all
364/// its accesses to a single vector type, return true and set VecTy to
365/// the new type. If we could convert the alloca into a single promotable
366/// integer, return true but set VecTy to VoidTy. Further, if the use is not a
367/// completely trivial use that mem2reg could promote, set IsNotTrivial. Offset
368/// is the current offset from the base of the alloca being analyzed.
369///
370/// If we see at least one access to the value that is as a vector type, set the
371/// SawVec flag.
372bool ConvertToScalarInfo::CanConvertToScalar(Value *V, uint64_t Offset) {
373 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI!=E; ++UI) {
374 Instruction *User = cast<Instruction>(*UI);
Bob Wilson69743022011-01-13 20:59:44 +0000375
Chris Lattner4cc576b2010-04-16 00:24:57 +0000376 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
377 // Don't break volatile loads.
378 if (LI->isVolatile())
379 return false;
Dale Johannesen0488fb62010-09-30 23:57:10 +0000380 // Don't touch MMX operations.
381 if (LI->getType()->isX86_MMXTy())
382 return false;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000383 MergeInType(LI->getType(), Offset);
384 continue;
385 }
Bob Wilson69743022011-01-13 20:59:44 +0000386
Chris Lattner4cc576b2010-04-16 00:24:57 +0000387 if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
388 // Storing the pointer, not into the value?
389 if (SI->getOperand(0) == V || SI->isVolatile()) return false;
Dale Johannesen0488fb62010-09-30 23:57:10 +0000390 // Don't touch MMX operations.
391 if (SI->getOperand(0)->getType()->isX86_MMXTy())
392 return false;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000393 MergeInType(SI->getOperand(0)->getType(), Offset);
394 continue;
395 }
Bob Wilson69743022011-01-13 20:59:44 +0000396
Chris Lattner4cc576b2010-04-16 00:24:57 +0000397 if (BitCastInst *BCI = dyn_cast<BitCastInst>(User)) {
Chris Lattnera001b662010-04-16 00:38:19 +0000398 IsNotTrivial = true; // Can't be mem2reg'd.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000399 if (!CanConvertToScalar(BCI, Offset))
400 return false;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000401 continue;
402 }
403
404 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(User)) {
405 // If this is a GEP with a variable indices, we can't handle it.
406 if (!GEP->hasAllConstantIndices())
407 return false;
Bob Wilson69743022011-01-13 20:59:44 +0000408
Chris Lattner4cc576b2010-04-16 00:24:57 +0000409 // Compute the offset that this GEP adds to the pointer.
410 SmallVector<Value*, 8> Indices(GEP->op_begin()+1, GEP->op_end());
411 uint64_t GEPOffset = TD.getIndexedOffset(GEP->getPointerOperandType(),
412 &Indices[0], Indices.size());
413 // See if all uses can be converted.
414 if (!CanConvertToScalar(GEP, Offset+GEPOffset))
415 return false;
Chris Lattnera001b662010-04-16 00:38:19 +0000416 IsNotTrivial = true; // Can't be mem2reg'd.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000417 continue;
418 }
419
420 // If this is a constant sized memset of a constant value (e.g. 0) we can
421 // handle it.
422 if (MemSetInst *MSI = dyn_cast<MemSetInst>(User)) {
423 // Store of constant value and constant size.
Chris Lattnera001b662010-04-16 00:38:19 +0000424 if (!isa<ConstantInt>(MSI->getValue()) ||
425 !isa<ConstantInt>(MSI->getLength()))
426 return false;
427 IsNotTrivial = true; // Can't be mem2reg'd.
428 continue;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000429 }
430
431 // If this is a memcpy or memmove into or out of the whole allocation, we
432 // can handle it like a load or store of the scalar type.
433 if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(User)) {
Chris Lattnera001b662010-04-16 00:38:19 +0000434 ConstantInt *Len = dyn_cast<ConstantInt>(MTI->getLength());
435 if (Len == 0 || Len->getZExtValue() != AllocaSize || Offset != 0)
436 return false;
Bob Wilson69743022011-01-13 20:59:44 +0000437
Chris Lattnera001b662010-04-16 00:38:19 +0000438 IsNotTrivial = true; // Can't be mem2reg'd.
439 continue;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000440 }
Bob Wilson69743022011-01-13 20:59:44 +0000441
Chris Lattner4cc576b2010-04-16 00:24:57 +0000442 // Otherwise, we cannot handle this!
443 return false;
444 }
Bob Wilson69743022011-01-13 20:59:44 +0000445
Chris Lattner4cc576b2010-04-16 00:24:57 +0000446 return true;
447}
448
449/// ConvertUsesToScalar - Convert all of the users of Ptr to use the new alloca
450/// directly. This happens when we are converting an "integer union" to a
451/// single integer scalar, or when we are converting a "vector union" to a
452/// vector with insert/extractelement instructions.
453///
454/// Offset is an offset from the original alloca, in bits that need to be
455/// shifted to the right. By the end of this, there should be no uses of Ptr.
456void ConvertToScalarInfo::ConvertUsesToScalar(Value *Ptr, AllocaInst *NewAI,
457 uint64_t Offset) {
458 while (!Ptr->use_empty()) {
459 Instruction *User = cast<Instruction>(Ptr->use_back());
460
461 if (BitCastInst *CI = dyn_cast<BitCastInst>(User)) {
462 ConvertUsesToScalar(CI, NewAI, Offset);
463 CI->eraseFromParent();
464 continue;
465 }
466
467 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(User)) {
468 // Compute the offset that this GEP adds to the pointer.
469 SmallVector<Value*, 8> Indices(GEP->op_begin()+1, GEP->op_end());
470 uint64_t GEPOffset = TD.getIndexedOffset(GEP->getPointerOperandType(),
471 &Indices[0], Indices.size());
472 ConvertUsesToScalar(GEP, NewAI, Offset+GEPOffset*8);
473 GEP->eraseFromParent();
474 continue;
475 }
Bob Wilson69743022011-01-13 20:59:44 +0000476
Chris Lattner61db1f52010-12-26 22:57:41 +0000477 IRBuilder<> Builder(User);
Bob Wilson69743022011-01-13 20:59:44 +0000478
Chris Lattner4cc576b2010-04-16 00:24:57 +0000479 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
480 // The load is a bit extract from NewAI shifted right by Offset bits.
481 Value *LoadedVal = Builder.CreateLoad(NewAI, "tmp");
482 Value *NewLoadVal
483 = ConvertScalar_ExtractValue(LoadedVal, LI->getType(), Offset, Builder);
484 LI->replaceAllUsesWith(NewLoadVal);
485 LI->eraseFromParent();
486 continue;
487 }
Bob Wilson69743022011-01-13 20:59:44 +0000488
Chris Lattner4cc576b2010-04-16 00:24:57 +0000489 if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
490 assert(SI->getOperand(0) != Ptr && "Consistency error!");
491 Instruction *Old = Builder.CreateLoad(NewAI, NewAI->getName()+".in");
492 Value *New = ConvertScalar_InsertValue(SI->getOperand(0), Old, Offset,
493 Builder);
494 Builder.CreateStore(New, NewAI);
495 SI->eraseFromParent();
Bob Wilson69743022011-01-13 20:59:44 +0000496
Chris Lattner4cc576b2010-04-16 00:24:57 +0000497 // If the load we just inserted is now dead, then the inserted store
498 // overwrote the entire thing.
499 if (Old->use_empty())
500 Old->eraseFromParent();
501 continue;
502 }
Bob Wilson69743022011-01-13 20:59:44 +0000503
Chris Lattner4cc576b2010-04-16 00:24:57 +0000504 // If this is a constant sized memset of a constant value (e.g. 0) we can
505 // transform it into a store of the expanded constant value.
506 if (MemSetInst *MSI = dyn_cast<MemSetInst>(User)) {
507 assert(MSI->getRawDest() == Ptr && "Consistency error!");
508 unsigned NumBytes = cast<ConstantInt>(MSI->getLength())->getZExtValue();
509 if (NumBytes != 0) {
510 unsigned Val = cast<ConstantInt>(MSI->getValue())->getZExtValue();
Bob Wilson69743022011-01-13 20:59:44 +0000511
Chris Lattner4cc576b2010-04-16 00:24:57 +0000512 // Compute the value replicated the right number of times.
513 APInt APVal(NumBytes*8, Val);
514
515 // Splat the value if non-zero.
516 if (Val)
517 for (unsigned i = 1; i != NumBytes; ++i)
518 APVal |= APVal << 8;
Bob Wilson69743022011-01-13 20:59:44 +0000519
Chris Lattner4cc576b2010-04-16 00:24:57 +0000520 Instruction *Old = Builder.CreateLoad(NewAI, NewAI->getName()+".in");
521 Value *New = ConvertScalar_InsertValue(
522 ConstantInt::get(User->getContext(), APVal),
523 Old, Offset, Builder);
524 Builder.CreateStore(New, NewAI);
Bob Wilson69743022011-01-13 20:59:44 +0000525
Chris Lattner4cc576b2010-04-16 00:24:57 +0000526 // If the load we just inserted is now dead, then the memset overwrote
527 // the entire thing.
528 if (Old->use_empty())
Bob Wilson69743022011-01-13 20:59:44 +0000529 Old->eraseFromParent();
Chris Lattner4cc576b2010-04-16 00:24:57 +0000530 }
531 MSI->eraseFromParent();
532 continue;
533 }
534
535 // If this is a memcpy or memmove into or out of the whole allocation, we
536 // can handle it like a load or store of the scalar type.
537 if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(User)) {
538 assert(Offset == 0 && "must be store to start of alloca");
Bob Wilson69743022011-01-13 20:59:44 +0000539
Chris Lattner4cc576b2010-04-16 00:24:57 +0000540 // If the source and destination are both to the same alloca, then this is
541 // a noop copy-to-self, just delete it. Otherwise, emit a load and store
542 // as appropriate.
Dan Gohmanbd1801b2011-01-24 18:53:32 +0000543 AllocaInst *OrigAI = cast<AllocaInst>(GetUnderlyingObject(Ptr, &TD, 0));
Bob Wilson69743022011-01-13 20:59:44 +0000544
Dan Gohmanbd1801b2011-01-24 18:53:32 +0000545 if (GetUnderlyingObject(MTI->getSource(), &TD, 0) != OrigAI) {
Chris Lattner4cc576b2010-04-16 00:24:57 +0000546 // Dest must be OrigAI, change this to be a load from the original
547 // pointer (bitcasted), then a store to our new alloca.
548 assert(MTI->getRawDest() == Ptr && "Neither use is of pointer?");
549 Value *SrcPtr = MTI->getSource();
Mon P Wange90a6332010-12-23 01:41:32 +0000550 const PointerType* SPTy = cast<PointerType>(SrcPtr->getType());
551 const PointerType* AIPTy = cast<PointerType>(NewAI->getType());
552 if (SPTy->getAddressSpace() != AIPTy->getAddressSpace()) {
553 AIPTy = PointerType::get(AIPTy->getElementType(),
554 SPTy->getAddressSpace());
555 }
556 SrcPtr = Builder.CreateBitCast(SrcPtr, AIPTy);
557
Chris Lattner4cc576b2010-04-16 00:24:57 +0000558 LoadInst *SrcVal = Builder.CreateLoad(SrcPtr, "srcval");
559 SrcVal->setAlignment(MTI->getAlignment());
560 Builder.CreateStore(SrcVal, NewAI);
Dan Gohmanbd1801b2011-01-24 18:53:32 +0000561 } else if (GetUnderlyingObject(MTI->getDest(), &TD, 0) != OrigAI) {
Chris Lattner4cc576b2010-04-16 00:24:57 +0000562 // Src must be OrigAI, change this to be a load from NewAI then a store
563 // through the original dest pointer (bitcasted).
564 assert(MTI->getRawSource() == Ptr && "Neither use is of pointer?");
565 LoadInst *SrcVal = Builder.CreateLoad(NewAI, "srcval");
566
Mon P Wange90a6332010-12-23 01:41:32 +0000567 const PointerType* DPTy = cast<PointerType>(MTI->getDest()->getType());
568 const PointerType* AIPTy = cast<PointerType>(NewAI->getType());
569 if (DPTy->getAddressSpace() != AIPTy->getAddressSpace()) {
570 AIPTy = PointerType::get(AIPTy->getElementType(),
571 DPTy->getAddressSpace());
572 }
573 Value *DstPtr = Builder.CreateBitCast(MTI->getDest(), AIPTy);
574
Chris Lattner4cc576b2010-04-16 00:24:57 +0000575 StoreInst *NewStore = Builder.CreateStore(SrcVal, DstPtr);
576 NewStore->setAlignment(MTI->getAlignment());
577 } else {
578 // Noop transfer. Src == Dst
579 }
580
581 MTI->eraseFromParent();
582 continue;
583 }
Bob Wilson69743022011-01-13 20:59:44 +0000584
Chris Lattner4cc576b2010-04-16 00:24:57 +0000585 llvm_unreachable("Unsupported operation!");
586 }
587}
588
589/// ConvertScalar_ExtractValue - Extract a value of type ToType from an integer
590/// or vector value FromVal, extracting the bits from the offset specified by
591/// Offset. This returns the value, which is of type ToType.
592///
593/// This happens when we are converting an "integer union" to a single
594/// integer scalar, or when we are converting a "vector union" to a vector with
595/// insert/extractelement instructions.
596///
597/// Offset is an offset from the original alloca, in bits that need to be
598/// shifted to the right.
599Value *ConvertToScalarInfo::
600ConvertScalar_ExtractValue(Value *FromVal, const Type *ToType,
601 uint64_t Offset, IRBuilder<> &Builder) {
602 // If the load is of the whole new alloca, no conversion is needed.
603 if (FromVal->getType() == ToType && Offset == 0)
604 return FromVal;
605
606 // If the result alloca is a vector type, this is either an element
607 // access or a bitcast to another vector type of the same size.
608 if (const VectorType *VTy = dyn_cast<VectorType>(FromVal->getType())) {
609 if (ToType->isVectorTy())
610 return Builder.CreateBitCast(FromVal, ToType, "tmp");
611
612 // Otherwise it must be an element access.
613 unsigned Elt = 0;
614 if (Offset) {
615 unsigned EltSize = TD.getTypeAllocSizeInBits(VTy->getElementType());
616 Elt = Offset/EltSize;
617 assert(EltSize*Elt == Offset && "Invalid modulus in validity checking");
618 }
619 // Return the element extracted out of it.
620 Value *V = Builder.CreateExtractElement(FromVal, ConstantInt::get(
621 Type::getInt32Ty(FromVal->getContext()), Elt), "tmp");
622 if (V->getType() != ToType)
623 V = Builder.CreateBitCast(V, ToType, "tmp");
624 return V;
625 }
Bob Wilson69743022011-01-13 20:59:44 +0000626
Chris Lattner4cc576b2010-04-16 00:24:57 +0000627 // If ToType is a first class aggregate, extract out each of the pieces and
628 // use insertvalue's to form the FCA.
629 if (const StructType *ST = dyn_cast<StructType>(ToType)) {
630 const StructLayout &Layout = *TD.getStructLayout(ST);
631 Value *Res = UndefValue::get(ST);
632 for (unsigned i = 0, e = ST->getNumElements(); i != e; ++i) {
633 Value *Elt = ConvertScalar_ExtractValue(FromVal, ST->getElementType(i),
634 Offset+Layout.getElementOffsetInBits(i),
635 Builder);
636 Res = Builder.CreateInsertValue(Res, Elt, i, "tmp");
637 }
638 return Res;
639 }
Bob Wilson69743022011-01-13 20:59:44 +0000640
Chris Lattner4cc576b2010-04-16 00:24:57 +0000641 if (const ArrayType *AT = dyn_cast<ArrayType>(ToType)) {
642 uint64_t EltSize = TD.getTypeAllocSizeInBits(AT->getElementType());
643 Value *Res = UndefValue::get(AT);
644 for (unsigned i = 0, e = AT->getNumElements(); i != e; ++i) {
645 Value *Elt = ConvertScalar_ExtractValue(FromVal, AT->getElementType(),
646 Offset+i*EltSize, Builder);
647 Res = Builder.CreateInsertValue(Res, Elt, i, "tmp");
648 }
649 return Res;
650 }
651
652 // Otherwise, this must be a union that was converted to an integer value.
653 const IntegerType *NTy = cast<IntegerType>(FromVal->getType());
654
655 // If this is a big-endian system and the load is narrower than the
656 // full alloca type, we need to do a shift to get the right bits.
657 int ShAmt = 0;
658 if (TD.isBigEndian()) {
659 // On big-endian machines, the lowest bit is stored at the bit offset
660 // from the pointer given by getTypeStoreSizeInBits. This matters for
661 // integers with a bitwidth that is not a multiple of 8.
662 ShAmt = TD.getTypeStoreSizeInBits(NTy) -
663 TD.getTypeStoreSizeInBits(ToType) - Offset;
664 } else {
665 ShAmt = Offset;
666 }
667
668 // Note: we support negative bitwidths (with shl) which are not defined.
669 // We do this to support (f.e.) loads off the end of a structure where
670 // only some bits are used.
671 if (ShAmt > 0 && (unsigned)ShAmt < NTy->getBitWidth())
672 FromVal = Builder.CreateLShr(FromVal,
673 ConstantInt::get(FromVal->getType(),
674 ShAmt), "tmp");
675 else if (ShAmt < 0 && (unsigned)-ShAmt < NTy->getBitWidth())
Bob Wilson69743022011-01-13 20:59:44 +0000676 FromVal = Builder.CreateShl(FromVal,
Chris Lattner4cc576b2010-04-16 00:24:57 +0000677 ConstantInt::get(FromVal->getType(),
678 -ShAmt), "tmp");
679
680 // Finally, unconditionally truncate the integer to the right width.
681 unsigned LIBitWidth = TD.getTypeSizeInBits(ToType);
682 if (LIBitWidth < NTy->getBitWidth())
683 FromVal =
Bob Wilson69743022011-01-13 20:59:44 +0000684 Builder.CreateTrunc(FromVal, IntegerType::get(FromVal->getContext(),
Chris Lattner4cc576b2010-04-16 00:24:57 +0000685 LIBitWidth), "tmp");
686 else if (LIBitWidth > NTy->getBitWidth())
687 FromVal =
Bob Wilson69743022011-01-13 20:59:44 +0000688 Builder.CreateZExt(FromVal, IntegerType::get(FromVal->getContext(),
Chris Lattner4cc576b2010-04-16 00:24:57 +0000689 LIBitWidth), "tmp");
690
691 // If the result is an integer, this is a trunc or bitcast.
692 if (ToType->isIntegerTy()) {
693 // Should be done.
694 } else if (ToType->isFloatingPointTy() || ToType->isVectorTy()) {
695 // Just do a bitcast, we know the sizes match up.
696 FromVal = Builder.CreateBitCast(FromVal, ToType, "tmp");
697 } else {
698 // Otherwise must be a pointer.
699 FromVal = Builder.CreateIntToPtr(FromVal, ToType, "tmp");
700 }
701 assert(FromVal->getType() == ToType && "Didn't convert right?");
702 return FromVal;
703}
704
705/// ConvertScalar_InsertValue - Insert the value "SV" into the existing integer
706/// or vector value "Old" at the offset specified by Offset.
707///
708/// This happens when we are converting an "integer union" to a
709/// single integer scalar, or when we are converting a "vector union" to a
710/// vector with insert/extractelement instructions.
711///
712/// Offset is an offset from the original alloca, in bits that need to be
713/// shifted to the right.
714Value *ConvertToScalarInfo::
715ConvertScalar_InsertValue(Value *SV, Value *Old,
716 uint64_t Offset, IRBuilder<> &Builder) {
717 // Convert the stored type to the actual type, shift it left to insert
718 // then 'or' into place.
719 const Type *AllocaType = Old->getType();
720 LLVMContext &Context = Old->getContext();
721
722 if (const VectorType *VTy = dyn_cast<VectorType>(AllocaType)) {
723 uint64_t VecSize = TD.getTypeAllocSizeInBits(VTy);
724 uint64_t ValSize = TD.getTypeAllocSizeInBits(SV->getType());
Bob Wilson69743022011-01-13 20:59:44 +0000725
Chris Lattner4cc576b2010-04-16 00:24:57 +0000726 // Changing the whole vector with memset or with an access of a different
727 // vector type?
728 if (ValSize == VecSize)
729 return Builder.CreateBitCast(SV, AllocaType, "tmp");
730
731 uint64_t EltSize = TD.getTypeAllocSizeInBits(VTy->getElementType());
732
733 // Must be an element insertion.
734 unsigned Elt = Offset/EltSize;
Bob Wilson69743022011-01-13 20:59:44 +0000735
Chris Lattner4cc576b2010-04-16 00:24:57 +0000736 if (SV->getType() != VTy->getElementType())
737 SV = Builder.CreateBitCast(SV, VTy->getElementType(), "tmp");
Bob Wilson69743022011-01-13 20:59:44 +0000738
739 SV = Builder.CreateInsertElement(Old, SV,
Chris Lattner4cc576b2010-04-16 00:24:57 +0000740 ConstantInt::get(Type::getInt32Ty(SV->getContext()), Elt),
741 "tmp");
742 return SV;
743 }
Bob Wilson69743022011-01-13 20:59:44 +0000744
Chris Lattner4cc576b2010-04-16 00:24:57 +0000745 // If SV is a first-class aggregate value, insert each value recursively.
746 if (const StructType *ST = dyn_cast<StructType>(SV->getType())) {
747 const StructLayout &Layout = *TD.getStructLayout(ST);
748 for (unsigned i = 0, e = ST->getNumElements(); i != e; ++i) {
749 Value *Elt = Builder.CreateExtractValue(SV, i, "tmp");
Bob Wilson69743022011-01-13 20:59:44 +0000750 Old = ConvertScalar_InsertValue(Elt, Old,
Chris Lattner4cc576b2010-04-16 00:24:57 +0000751 Offset+Layout.getElementOffsetInBits(i),
752 Builder);
753 }
754 return Old;
755 }
Bob Wilson69743022011-01-13 20:59:44 +0000756
Chris Lattner4cc576b2010-04-16 00:24:57 +0000757 if (const ArrayType *AT = dyn_cast<ArrayType>(SV->getType())) {
758 uint64_t EltSize = TD.getTypeAllocSizeInBits(AT->getElementType());
759 for (unsigned i = 0, e = AT->getNumElements(); i != e; ++i) {
760 Value *Elt = Builder.CreateExtractValue(SV, i, "tmp");
761 Old = ConvertScalar_InsertValue(Elt, Old, Offset+i*EltSize, Builder);
762 }
763 return Old;
764 }
765
766 // If SV is a float, convert it to the appropriate integer type.
767 // If it is a pointer, do the same.
768 unsigned SrcWidth = TD.getTypeSizeInBits(SV->getType());
769 unsigned DestWidth = TD.getTypeSizeInBits(AllocaType);
770 unsigned SrcStoreWidth = TD.getTypeStoreSizeInBits(SV->getType());
771 unsigned DestStoreWidth = TD.getTypeStoreSizeInBits(AllocaType);
772 if (SV->getType()->isFloatingPointTy() || SV->getType()->isVectorTy())
773 SV = Builder.CreateBitCast(SV,
774 IntegerType::get(SV->getContext(),SrcWidth), "tmp");
775 else if (SV->getType()->isPointerTy())
776 SV = Builder.CreatePtrToInt(SV, TD.getIntPtrType(SV->getContext()), "tmp");
777
778 // Zero extend or truncate the value if needed.
779 if (SV->getType() != AllocaType) {
780 if (SV->getType()->getPrimitiveSizeInBits() <
781 AllocaType->getPrimitiveSizeInBits())
782 SV = Builder.CreateZExt(SV, AllocaType, "tmp");
783 else {
784 // Truncation may be needed if storing more than the alloca can hold
785 // (undefined behavior).
786 SV = Builder.CreateTrunc(SV, AllocaType, "tmp");
787 SrcWidth = DestWidth;
788 SrcStoreWidth = DestStoreWidth;
789 }
790 }
791
792 // If this is a big-endian system and the store is narrower than the
793 // full alloca type, we need to do a shift to get the right bits.
794 int ShAmt = 0;
795 if (TD.isBigEndian()) {
796 // On big-endian machines, the lowest bit is stored at the bit offset
797 // from the pointer given by getTypeStoreSizeInBits. This matters for
798 // integers with a bitwidth that is not a multiple of 8.
799 ShAmt = DestStoreWidth - SrcStoreWidth - Offset;
800 } else {
801 ShAmt = Offset;
802 }
803
804 // Note: we support negative bitwidths (with shr) which are not defined.
805 // We do this to support (f.e.) stores off the end of a structure where
806 // only some bits in the structure are set.
807 APInt Mask(APInt::getLowBitsSet(DestWidth, SrcWidth));
808 if (ShAmt > 0 && (unsigned)ShAmt < DestWidth) {
809 SV = Builder.CreateShl(SV, ConstantInt::get(SV->getType(),
810 ShAmt), "tmp");
811 Mask <<= ShAmt;
812 } else if (ShAmt < 0 && (unsigned)-ShAmt < DestWidth) {
813 SV = Builder.CreateLShr(SV, ConstantInt::get(SV->getType(),
814 -ShAmt), "tmp");
815 Mask = Mask.lshr(-ShAmt);
816 }
817
818 // Mask out the bits we are about to insert from the old value, and or
819 // in the new bits.
820 if (SrcWidth != DestWidth) {
821 assert(DestWidth > SrcWidth);
822 Old = Builder.CreateAnd(Old, ConstantInt::get(Context, ~Mask), "mask");
823 SV = Builder.CreateOr(Old, SV, "ins");
824 }
825 return SV;
826}
827
828
829//===----------------------------------------------------------------------===//
830// SRoA Driver
831//===----------------------------------------------------------------------===//
832
833
Chris Lattnered7b41e2003-05-27 15:45:27 +0000834bool SROA::runOnFunction(Function &F) {
Dan Gohmane4af1cf2009-08-19 18:22:18 +0000835 TD = getAnalysisIfAvailable<TargetData>();
836
Chris Lattnerfe7ea0d2003-09-12 15:36:03 +0000837 bool Changed = performPromotion(F);
Dan Gohmane4af1cf2009-08-19 18:22:18 +0000838
839 // FIXME: ScalarRepl currently depends on TargetData more than it
840 // theoretically needs to. It should be refactored in order to support
841 // target-independent IR. Until this is done, just skip the actual
842 // scalar-replacement portion of this pass.
843 if (!TD) return Changed;
844
Chris Lattnerfe7ea0d2003-09-12 15:36:03 +0000845 while (1) {
846 bool LocalChange = performScalarRepl(F);
847 if (!LocalChange) break; // No need to repromote if no scalarrepl
848 Changed = true;
849 LocalChange = performPromotion(F);
850 if (!LocalChange) break; // No need to re-scalarrepl if no promotion
851 }
Chris Lattner38aec322003-09-11 16:45:55 +0000852
853 return Changed;
854}
855
Chris Lattnerd0f56132011-01-14 19:50:47 +0000856namespace {
857class AllocaPromoter : public LoadAndStorePromoter {
858 AllocaInst *AI;
859public:
Chris Lattnerdeaf55f2011-01-15 00:12:35 +0000860 AllocaPromoter(const SmallVectorImpl<Instruction*> &Insts, SSAUpdater &S)
861 : LoadAndStorePromoter(Insts, S), AI(0) {}
Chris Lattnerd0f56132011-01-14 19:50:47 +0000862
Chris Lattnerdeaf55f2011-01-15 00:12:35 +0000863 void run(AllocaInst *AI, const SmallVectorImpl<Instruction*> &Insts) {
Chris Lattnerd0f56132011-01-14 19:50:47 +0000864 // Remember which alloca we're promoting (for isInstInList).
865 this->AI = AI;
Chris Lattnerdeaf55f2011-01-15 00:12:35 +0000866 LoadAndStorePromoter::run(Insts);
Chris Lattnerd0f56132011-01-14 19:50:47 +0000867 AI->eraseFromParent();
Chris Lattnere0a1a5b2011-01-14 07:50:47 +0000868 }
869
Chris Lattnerd0f56132011-01-14 19:50:47 +0000870 virtual bool isInstInList(Instruction *I,
871 const SmallVectorImpl<Instruction*> &Insts) const {
872 if (LoadInst *LI = dyn_cast<LoadInst>(I))
873 return LI->getOperand(0) == AI;
874 return cast<StoreInst>(I)->getPointerOperand() == AI;
Chris Lattnere0a1a5b2011-01-14 07:50:47 +0000875 }
Chris Lattnerd0f56132011-01-14 19:50:47 +0000876};
877} // end anon namespace
Chris Lattner38aec322003-09-11 16:45:55 +0000878
Chris Lattnerc87c50a2011-01-23 22:04:55 +0000879/// isSafeSelectToSpeculate - Select instructions that use an alloca and are
880/// subsequently loaded can be rewritten to load both input pointers and then
881/// select between the result, allowing the load of the alloca to be promoted.
882/// From this:
883/// %P2 = select i1 %cond, i32* %Alloca, i32* %Other
884/// %V = load i32* %P2
885/// to:
886/// %V1 = load i32* %Alloca -> will be mem2reg'd
887/// %V2 = load i32* %Other
Chris Lattnere3357862011-01-24 01:07:11 +0000888/// %V = select i1 %cond, i32 %V1, i32 %V2
Chris Lattnerc87c50a2011-01-23 22:04:55 +0000889///
890/// We can do this to a select if its only uses are loads and if the operand to
891/// the select can be loaded unconditionally.
892static bool isSafeSelectToSpeculate(SelectInst *SI, const TargetData *TD) {
893 bool TDerefable = SI->getTrueValue()->isDereferenceablePointer();
894 bool FDerefable = SI->getFalseValue()->isDereferenceablePointer();
895
896 for (Value::use_iterator UI = SI->use_begin(), UE = SI->use_end();
897 UI != UE; ++UI) {
898 LoadInst *LI = dyn_cast<LoadInst>(*UI);
899 if (LI == 0 || LI->isVolatile()) return false;
900
Chris Lattnere3357862011-01-24 01:07:11 +0000901 // Both operands to the select need to be dereferencable, either absolutely
Chris Lattnerc87c50a2011-01-23 22:04:55 +0000902 // (e.g. allocas) or at this point because we can see other accesses to it.
903 if (!TDerefable && !isSafeToLoadUnconditionally(SI->getTrueValue(), LI,
904 LI->getAlignment(), TD))
905 return false;
906 if (!FDerefable && !isSafeToLoadUnconditionally(SI->getFalseValue(), LI,
907 LI->getAlignment(), TD))
908 return false;
909 }
910
911 return true;
912}
913
Chris Lattnere3357862011-01-24 01:07:11 +0000914/// isSafePHIToSpeculate - PHI instructions that use an alloca and are
915/// subsequently loaded can be rewritten to load both input pointers in the pred
916/// blocks and then PHI the results, allowing the load of the alloca to be
917/// promoted.
918/// From this:
919/// %P2 = phi [i32* %Alloca, i32* %Other]
920/// %V = load i32* %P2
921/// to:
922/// %V1 = load i32* %Alloca -> will be mem2reg'd
923/// ...
924/// %V2 = load i32* %Other
925/// ...
926/// %V = phi [i32 %V1, i32 %V2]
927///
928/// We can do this to a select if its only uses are loads and if the operand to
929/// the select can be loaded unconditionally.
930static bool isSafePHIToSpeculate(PHINode *PN, const TargetData *TD) {
931 // For now, we can only do this promotion if the load is in the same block as
932 // the PHI, and if there are no stores between the phi and load.
933 // TODO: Allow recursive phi users.
934 // TODO: Allow stores.
935 BasicBlock *BB = PN->getParent();
936 unsigned MaxAlign = 0;
937 for (Value::use_iterator UI = PN->use_begin(), UE = PN->use_end();
938 UI != UE; ++UI) {
939 LoadInst *LI = dyn_cast<LoadInst>(*UI);
940 if (LI == 0 || LI->isVolatile()) return false;
941
942 // For now we only allow loads in the same block as the PHI. This is a
943 // common case that happens when instcombine merges two loads through a PHI.
944 if (LI->getParent() != BB) return false;
945
946 // Ensure that there are no instructions between the PHI and the load that
947 // could store.
948 for (BasicBlock::iterator BBI = PN; &*BBI != LI; ++BBI)
949 if (BBI->mayWriteToMemory())
950 return false;
951
952 MaxAlign = std::max(MaxAlign, LI->getAlignment());
953 }
954
955 // Okay, we know that we have one or more loads in the same block as the PHI.
956 // We can transform this if it is safe to push the loads into the predecessor
957 // blocks. The only thing to watch out for is that we can't put a possibly
958 // trapping load in the predecessor if it is a critical edge.
959 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
960 BasicBlock *Pred = PN->getIncomingBlock(i);
961
962 // If the predecessor has a single successor, then the edge isn't critical.
963 if (Pred->getTerminator()->getNumSuccessors() == 1)
964 continue;
965
966 Value *InVal = PN->getIncomingValue(i);
967
968 // If the InVal is an invoke in the pred, we can't put a load on the edge.
969 if (InvokeInst *II = dyn_cast<InvokeInst>(InVal))
970 if (II->getParent() == Pred)
971 return false;
972
973 // If this pointer is always safe to load, or if we can prove that there is
974 // already a load in the block, then we can move the load to the pred block.
975 if (InVal->isDereferenceablePointer() ||
976 isSafeToLoadUnconditionally(InVal, Pred->getTerminator(), MaxAlign, TD))
977 continue;
978
979 return false;
980 }
981
982 return true;
983}
984
Chris Lattnerc87c50a2011-01-23 22:04:55 +0000985
986/// tryToMakeAllocaBePromotable - This returns true if the alloca only has
987/// direct (non-volatile) loads and stores to it. If the alloca is close but
988/// not quite there, this will transform the code to allow promotion. As such,
989/// it is a non-pure predicate.
990static bool tryToMakeAllocaBePromotable(AllocaInst *AI, const TargetData *TD) {
991 SetVector<Instruction*, SmallVector<Instruction*, 4>,
992 SmallPtrSet<Instruction*, 4> > InstsToRewrite;
993
994 for (Value::use_iterator UI = AI->use_begin(), UE = AI->use_end();
995 UI != UE; ++UI) {
996 User *U = *UI;
997 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
998 if (LI->isVolatile())
999 return false;
1000 continue;
1001 }
1002
1003 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
1004 if (SI->getOperand(0) == AI || SI->isVolatile())
1005 return false; // Don't allow a store OF the AI, only INTO the AI.
1006 continue;
1007 }
1008
1009 if (SelectInst *SI = dyn_cast<SelectInst>(U)) {
1010 // If the condition being selected on is a constant, fold the select, yes
1011 // this does (rarely) happen early on.
1012 if (ConstantInt *CI = dyn_cast<ConstantInt>(SI->getCondition())) {
1013 Value *Result = SI->getOperand(1+CI->isZero());
1014 SI->replaceAllUsesWith(Result);
1015 SI->eraseFromParent();
1016
1017 // This is very rare and we just scrambled the use list of AI, start
1018 // over completely.
1019 return tryToMakeAllocaBePromotable(AI, TD);
1020 }
1021
1022 // If it is safe to turn "load (select c, AI, ptr)" into a select of two
1023 // loads, then we can transform this by rewriting the select.
1024 if (!isSafeSelectToSpeculate(SI, TD))
1025 return false;
1026
1027 InstsToRewrite.insert(SI);
1028 continue;
1029 }
1030
Chris Lattnere3357862011-01-24 01:07:11 +00001031 if (PHINode *PN = dyn_cast<PHINode>(U)) {
1032 if (PN->use_empty()) { // Dead PHIs can be stripped.
1033 InstsToRewrite.insert(PN);
1034 continue;
1035 }
1036
1037 // If it is safe to turn "load (phi [AI, ptr, ...])" into a PHI of loads
1038 // in the pred blocks, then we can transform this by rewriting the PHI.
1039 if (!isSafePHIToSpeculate(PN, TD))
1040 return false;
1041
1042 InstsToRewrite.insert(PN);
1043 continue;
1044 }
1045
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001046 return false;
1047 }
1048
1049 // If there are no instructions to rewrite, then all uses are load/stores and
1050 // we're done!
1051 if (InstsToRewrite.empty())
1052 return true;
1053
1054 // If we have instructions that need to be rewritten for this to be promotable
1055 // take care of it now.
1056 for (unsigned i = 0, e = InstsToRewrite.size(); i != e; ++i) {
Chris Lattnere3357862011-01-24 01:07:11 +00001057 if (SelectInst *SI = dyn_cast<SelectInst>(InstsToRewrite[i])) {
1058 // Selects in InstsToRewrite only have load uses. Rewrite each as two
1059 // loads with a new select.
1060 while (!SI->use_empty()) {
1061 LoadInst *LI = cast<LoadInst>(SI->use_back());
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001062
Chris Lattnere3357862011-01-24 01:07:11 +00001063 IRBuilder<> Builder(LI);
1064 LoadInst *TrueLoad =
1065 Builder.CreateLoad(SI->getTrueValue(), LI->getName()+".t");
1066 LoadInst *FalseLoad =
1067 Builder.CreateLoad(SI->getFalseValue(), LI->getName()+".t");
1068
1069 // Transfer alignment and TBAA info if present.
1070 TrueLoad->setAlignment(LI->getAlignment());
1071 FalseLoad->setAlignment(LI->getAlignment());
1072 if (MDNode *Tag = LI->getMetadata(LLVMContext::MD_tbaa)) {
1073 TrueLoad->setMetadata(LLVMContext::MD_tbaa, Tag);
1074 FalseLoad->setMetadata(LLVMContext::MD_tbaa, Tag);
1075 }
1076
1077 Value *V = Builder.CreateSelect(SI->getCondition(), TrueLoad, FalseLoad);
1078 V->takeName(LI);
1079 LI->replaceAllUsesWith(V);
1080 LI->eraseFromParent();
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001081 }
Chris Lattnere3357862011-01-24 01:07:11 +00001082
1083 // Now that all the loads are gone, the select is gone too.
1084 SI->eraseFromParent();
1085 continue;
1086 }
1087
1088 // Otherwise, we have a PHI node which allows us to push the loads into the
1089 // predecessors.
1090 PHINode *PN = cast<PHINode>(InstsToRewrite[i]);
1091 if (PN->use_empty()) {
1092 PN->eraseFromParent();
1093 continue;
1094 }
1095
1096 const Type *LoadTy = cast<PointerType>(PN->getType())->getElementType();
1097 PHINode *NewPN = PHINode::Create(LoadTy, PN->getName()+".ld", PN);
1098
1099 // Get the TBAA tag and alignment to use from one of the loads. It doesn't
1100 // matter which one we get and if any differ, it doesn't matter.
1101 LoadInst *SomeLoad = cast<LoadInst>(PN->use_back());
1102 MDNode *TBAATag = SomeLoad->getMetadata(LLVMContext::MD_tbaa);
1103 unsigned Align = SomeLoad->getAlignment();
1104
1105 // Rewrite all loads of the PN to use the new PHI.
1106 while (!PN->use_empty()) {
1107 LoadInst *LI = cast<LoadInst>(PN->use_back());
1108 LI->replaceAllUsesWith(NewPN);
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001109 LI->eraseFromParent();
1110 }
1111
Chris Lattnere3357862011-01-24 01:07:11 +00001112 // Inject loads into all of the pred blocks. Keep track of which blocks we
1113 // insert them into in case we have multiple edges from the same block.
1114 DenseMap<BasicBlock*, LoadInst*> InsertedLoads;
1115
1116 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1117 BasicBlock *Pred = PN->getIncomingBlock(i);
1118 LoadInst *&Load = InsertedLoads[Pred];
1119 if (Load == 0) {
1120 Load = new LoadInst(PN->getIncomingValue(i),
1121 PN->getName() + "." + Pred->getName(),
1122 Pred->getTerminator());
1123 Load->setAlignment(Align);
1124 if (TBAATag) Load->setMetadata(LLVMContext::MD_tbaa, TBAATag);
1125 }
1126
1127 NewPN->addIncoming(Load, Pred);
1128 }
1129
1130 PN->eraseFromParent();
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001131 }
1132
1133 ++NumAdjusted;
1134 return true;
1135}
1136
1137
Chris Lattner38aec322003-09-11 16:45:55 +00001138bool SROA::performPromotion(Function &F) {
1139 std::vector<AllocaInst*> Allocas;
Chris Lattnere0a1a5b2011-01-14 07:50:47 +00001140 DominatorTree *DT = 0;
Cameron Zwarichb1686c32011-01-18 03:53:26 +00001141 if (HasDomTree)
Chris Lattnere0a1a5b2011-01-14 07:50:47 +00001142 DT = &getAnalysis<DominatorTree>();
Chris Lattner38aec322003-09-11 16:45:55 +00001143
Chris Lattner02a3be02003-09-20 14:39:18 +00001144 BasicBlock &BB = F.getEntryBlock(); // Get the entry node for the function
Chris Lattner38aec322003-09-11 16:45:55 +00001145
Chris Lattnerfe7ea0d2003-09-12 15:36:03 +00001146 bool Changed = false;
Chris Lattnerdeaf55f2011-01-15 00:12:35 +00001147 SmallVector<Instruction*, 64> Insts;
Chris Lattner38aec322003-09-11 16:45:55 +00001148 while (1) {
1149 Allocas.clear();
1150
1151 // Find allocas that are safe to promote, by looking at all instructions in
1152 // the entry node
1153 for (BasicBlock::iterator I = BB.begin(), E = --BB.end(); I != E; ++I)
1154 if (AllocaInst *AI = dyn_cast<AllocaInst>(I)) // Is it an alloca?
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001155 if (tryToMakeAllocaBePromotable(AI, TD))
Chris Lattner38aec322003-09-11 16:45:55 +00001156 Allocas.push_back(AI);
1157
1158 if (Allocas.empty()) break;
1159
Cameron Zwarichb1686c32011-01-18 03:53:26 +00001160 if (HasDomTree)
Cameron Zwarich419e8a62011-01-17 17:38:41 +00001161 PromoteMemToReg(Allocas, *DT);
Chris Lattnere0a1a5b2011-01-14 07:50:47 +00001162 else {
1163 SSAUpdater SSA;
Chris Lattnerdeaf55f2011-01-15 00:12:35 +00001164 for (unsigned i = 0, e = Allocas.size(); i != e; ++i) {
1165 AllocaInst *AI = Allocas[i];
1166
1167 // Build list of instructions to promote.
1168 for (Value::use_iterator UI = AI->use_begin(), E = AI->use_end();
1169 UI != E; ++UI)
1170 Insts.push_back(cast<Instruction>(*UI));
1171
1172 AllocaPromoter(Insts, SSA).run(AI, Insts);
1173 Insts.clear();
1174 }
Chris Lattnere0a1a5b2011-01-14 07:50:47 +00001175 }
Chris Lattner38aec322003-09-11 16:45:55 +00001176 NumPromoted += Allocas.size();
1177 Changed = true;
1178 }
1179
1180 return Changed;
1181}
1182
Chris Lattner4cc576b2010-04-16 00:24:57 +00001183
Bob Wilson3992feb2010-02-03 17:23:56 +00001184/// ShouldAttemptScalarRepl - Decide if an alloca is a good candidate for
1185/// SROA. It must be a struct or array type with a small number of elements.
1186static bool ShouldAttemptScalarRepl(AllocaInst *AI) {
1187 const Type *T = AI->getAllocatedType();
1188 // Do not promote any struct into more than 32 separate vars.
Chris Lattner963a97f2008-06-22 17:46:21 +00001189 if (const StructType *ST = dyn_cast<StructType>(T))
Bob Wilson3992feb2010-02-03 17:23:56 +00001190 return ST->getNumElements() <= 32;
1191 // Arrays are much less likely to be safe for SROA; only consider
1192 // them if they are very small.
1193 if (const ArrayType *AT = dyn_cast<ArrayType>(T))
1194 return AT->getNumElements() <= 8;
1195 return false;
Chris Lattner963a97f2008-06-22 17:46:21 +00001196}
1197
Chris Lattnerc4472072010-04-15 23:50:26 +00001198
Chris Lattner38aec322003-09-11 16:45:55 +00001199// performScalarRepl - This algorithm is a simple worklist driven algorithm,
1200// which runs on all of the malloc/alloca instructions in the function, removing
1201// them if they are only used by getelementptr instructions.
1202//
1203bool SROA::performScalarRepl(Function &F) {
Victor Hernandez7b929da2009-10-23 21:09:37 +00001204 std::vector<AllocaInst*> WorkList;
Chris Lattnered7b41e2003-05-27 15:45:27 +00001205
Chris Lattner31d80102010-04-15 21:59:20 +00001206 // Scan the entry basic block, adding allocas to the worklist.
Chris Lattner02a3be02003-09-20 14:39:18 +00001207 BasicBlock &BB = F.getEntryBlock();
Chris Lattnered7b41e2003-05-27 15:45:27 +00001208 for (BasicBlock::iterator I = BB.begin(), E = BB.end(); I != E; ++I)
Victor Hernandez7b929da2009-10-23 21:09:37 +00001209 if (AllocaInst *A = dyn_cast<AllocaInst>(I))
Chris Lattnered7b41e2003-05-27 15:45:27 +00001210 WorkList.push_back(A);
1211
1212 // Process the worklist
1213 bool Changed = false;
1214 while (!WorkList.empty()) {
Victor Hernandez7b929da2009-10-23 21:09:37 +00001215 AllocaInst *AI = WorkList.back();
Chris Lattnered7b41e2003-05-27 15:45:27 +00001216 WorkList.pop_back();
Bob Wilson69743022011-01-13 20:59:44 +00001217
Chris Lattneradd2bd72006-12-22 23:14:42 +00001218 // Handle dead allocas trivially. These can be formed by SROA'ing arrays
1219 // with unused elements.
1220 if (AI->use_empty()) {
1221 AI->eraseFromParent();
Chris Lattnerc4472072010-04-15 23:50:26 +00001222 Changed = true;
Chris Lattneradd2bd72006-12-22 23:14:42 +00001223 continue;
1224 }
Chris Lattner7809ecd2009-02-03 01:30:09 +00001225
1226 // If this alloca is impossible for us to promote, reject it early.
1227 if (AI->isArrayAllocation() || !AI->getAllocatedType()->isSized())
1228 continue;
Bob Wilson69743022011-01-13 20:59:44 +00001229
Chris Lattner79b3bd32007-04-25 06:40:51 +00001230 // Check to see if this allocation is only modified by a memcpy/memmove from
1231 // a constant global. If this is the case, we can change all users to use
1232 // the constant global instead. This is commonly produced by the CFE by
1233 // constructs like "void foo() { int A[] = {1,2,3,4,5,6,7,8,9...}; }" if 'A'
1234 // is only subsequently read.
Chris Lattner31d80102010-04-15 21:59:20 +00001235 if (MemTransferInst *TheCopy = isOnlyCopiedFromConstantGlobal(AI)) {
David Greene504c7d82010-01-05 01:27:09 +00001236 DEBUG(dbgs() << "Found alloca equal to global: " << *AI << '\n');
1237 DEBUG(dbgs() << " memcpy = " << *TheCopy << '\n');
Chris Lattner31d80102010-04-15 21:59:20 +00001238 Constant *TheSrc = cast<Constant>(TheCopy->getSource());
Owen Andersonbaf3c402009-07-29 18:55:55 +00001239 AI->replaceAllUsesWith(ConstantExpr::getBitCast(TheSrc, AI->getType()));
Chris Lattner79b3bd32007-04-25 06:40:51 +00001240 TheCopy->eraseFromParent(); // Don't mutate the global.
1241 AI->eraseFromParent();
1242 ++NumGlobals;
1243 Changed = true;
1244 continue;
1245 }
Bob Wilson69743022011-01-13 20:59:44 +00001246
Chris Lattner7809ecd2009-02-03 01:30:09 +00001247 // Check to see if we can perform the core SROA transformation. We cannot
1248 // transform the allocation instruction if it is an array allocation
1249 // (allocations OF arrays are ok though), and an allocation of a scalar
1250 // value cannot be decomposed at all.
Duncan Sands777d2302009-05-09 07:06:46 +00001251 uint64_t AllocaSize = TD->getTypeAllocSize(AI->getAllocatedType());
Bill Wendling5a377cb2009-03-03 12:12:58 +00001252
Nick Lewyckyd3aa25e2009-08-17 05:37:31 +00001253 // Do not promote [0 x %struct].
1254 if (AllocaSize == 0) continue;
Bob Wilson69743022011-01-13 20:59:44 +00001255
Chris Lattner31d80102010-04-15 21:59:20 +00001256 // Do not promote any struct whose size is too big.
1257 if (AllocaSize > SRThreshold) continue;
Bob Wilson69743022011-01-13 20:59:44 +00001258
Bob Wilson3992feb2010-02-03 17:23:56 +00001259 // If the alloca looks like a good candidate for scalar replacement, and if
1260 // all its users can be transformed, then split up the aggregate into its
1261 // separate elements.
1262 if (ShouldAttemptScalarRepl(AI) && isSafeAllocaToScalarRepl(AI)) {
1263 DoScalarReplacement(AI, WorkList);
1264 Changed = true;
1265 continue;
1266 }
1267
Chris Lattner6e733d32009-01-28 20:16:43 +00001268 // If we can turn this aggregate value (potentially with casts) into a
1269 // simple scalar value that can be mem2reg'd into a register value.
Chris Lattner2e0d5f82009-01-31 02:28:54 +00001270 // IsNotTrivial tracks whether this is something that mem2reg could have
1271 // promoted itself. If so, we don't want to transform it needlessly. Note
1272 // that we can't just check based on the type: the alloca may be of an i32
1273 // but that has pointer arithmetic to set byte 3 of it or something.
Chris Lattner593375d2010-04-16 00:20:00 +00001274 if (AllocaInst *NewAI =
1275 ConvertToScalarInfo((unsigned)AllocaSize, *TD).TryConvert(AI)) {
Chris Lattner7809ecd2009-02-03 01:30:09 +00001276 NewAI->takeName(AI);
1277 AI->eraseFromParent();
1278 ++NumConverted;
1279 Changed = true;
1280 continue;
Bob Wilson69743022011-01-13 20:59:44 +00001281 }
1282
Chris Lattner7809ecd2009-02-03 01:30:09 +00001283 // Otherwise, couldn't process this alloca.
Chris Lattnered7b41e2003-05-27 15:45:27 +00001284 }
1285
1286 return Changed;
1287}
Chris Lattner5e062a12003-05-30 04:15:41 +00001288
Chris Lattnera10b29b2007-04-25 05:02:56 +00001289/// DoScalarReplacement - This alloca satisfied the isSafeAllocaToScalarRepl
1290/// predicate, do SROA now.
Bob Wilson69743022011-01-13 20:59:44 +00001291void SROA::DoScalarReplacement(AllocaInst *AI,
Victor Hernandez7b929da2009-10-23 21:09:37 +00001292 std::vector<AllocaInst*> &WorkList) {
David Greene504c7d82010-01-05 01:27:09 +00001293 DEBUG(dbgs() << "Found inst to SROA: " << *AI << '\n');
Chris Lattnera10b29b2007-04-25 05:02:56 +00001294 SmallVector<AllocaInst*, 32> ElementAllocas;
1295 if (const StructType *ST = dyn_cast<StructType>(AI->getAllocatedType())) {
1296 ElementAllocas.reserve(ST->getNumContainedTypes());
1297 for (unsigned i = 0, e = ST->getNumContainedTypes(); i != e; ++i) {
Bob Wilson69743022011-01-13 20:59:44 +00001298 AllocaInst *NA = new AllocaInst(ST->getContainedType(i), 0,
Chris Lattnera10b29b2007-04-25 05:02:56 +00001299 AI->getAlignment(),
Daniel Dunbarfe09b202009-07-30 17:37:43 +00001300 AI->getName() + "." + Twine(i), AI);
Chris Lattnera10b29b2007-04-25 05:02:56 +00001301 ElementAllocas.push_back(NA);
1302 WorkList.push_back(NA); // Add to worklist for recursive processing
1303 }
1304 } else {
1305 const ArrayType *AT = cast<ArrayType>(AI->getAllocatedType());
1306 ElementAllocas.reserve(AT->getNumElements());
1307 const Type *ElTy = AT->getElementType();
1308 for (unsigned i = 0, e = AT->getNumElements(); i != e; ++i) {
Owen Anderson50dead02009-07-15 23:53:25 +00001309 AllocaInst *NA = new AllocaInst(ElTy, 0, AI->getAlignment(),
Daniel Dunbarfe09b202009-07-30 17:37:43 +00001310 AI->getName() + "." + Twine(i), AI);
Chris Lattnera10b29b2007-04-25 05:02:56 +00001311 ElementAllocas.push_back(NA);
1312 WorkList.push_back(NA); // Add to worklist for recursive processing
1313 }
1314 }
1315
Bob Wilsonb742def2009-12-18 20:14:40 +00001316 // Now that we have created the new alloca instructions, rewrite all the
1317 // uses of the old alloca.
1318 RewriteForScalarRepl(AI, AI, 0, ElementAllocas);
Chris Lattnera59adc42009-12-14 05:11:02 +00001319
Bob Wilsonb742def2009-12-18 20:14:40 +00001320 // Now erase any instructions that were made dead while rewriting the alloca.
1321 DeleteDeadInstructions();
Bob Wilson39c88a62009-12-17 18:34:24 +00001322 AI->eraseFromParent();
Bob Wilsonb742def2009-12-18 20:14:40 +00001323
Dan Gohmanfe601042010-06-22 15:08:57 +00001324 ++NumReplaced;
Chris Lattnera10b29b2007-04-25 05:02:56 +00001325}
Chris Lattnera59adc42009-12-14 05:11:02 +00001326
Bob Wilsonb742def2009-12-18 20:14:40 +00001327/// DeleteDeadInstructions - Erase instructions on the DeadInstrs list,
1328/// recursively including all their operands that become trivially dead.
1329void SROA::DeleteDeadInstructions() {
1330 while (!DeadInsts.empty()) {
1331 Instruction *I = cast<Instruction>(DeadInsts.pop_back_val());
Chris Lattnera59adc42009-12-14 05:11:02 +00001332
Bob Wilsonb742def2009-12-18 20:14:40 +00001333 for (User::op_iterator OI = I->op_begin(), E = I->op_end(); OI != E; ++OI)
1334 if (Instruction *U = dyn_cast<Instruction>(*OI)) {
1335 // Zero out the operand and see if it becomes trivially dead.
1336 // (But, don't add allocas to the dead instruction list -- they are
1337 // already on the worklist and will be deleted separately.)
1338 *OI = 0;
1339 if (isInstructionTriviallyDead(U) && !isa<AllocaInst>(U))
1340 DeadInsts.push_back(U);
Chris Lattnera59adc42009-12-14 05:11:02 +00001341 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001342
1343 I->eraseFromParent();
Chris Lattnera59adc42009-12-14 05:11:02 +00001344 }
Chris Lattnera59adc42009-12-14 05:11:02 +00001345}
Bob Wilson69743022011-01-13 20:59:44 +00001346
Bob Wilsonb742def2009-12-18 20:14:40 +00001347/// isSafeForScalarRepl - Check if instruction I is a safe use with regard to
1348/// performing scalar replacement of alloca AI. The results are flagged in
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001349/// the Info parameter. Offset indicates the position within AI that is
1350/// referenced by this instruction.
Chris Lattner6c95d242011-01-23 07:29:29 +00001351void SROA::isSafeForScalarRepl(Instruction *I, uint64_t Offset,
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001352 AllocaInfo &Info) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001353 for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI!=E; ++UI) {
1354 Instruction *User = cast<Instruction>(*UI);
Chris Lattnerbe883a22003-11-25 21:09:18 +00001355
Bob Wilsonb742def2009-12-18 20:14:40 +00001356 if (BitCastInst *BC = dyn_cast<BitCastInst>(User)) {
Chris Lattner6c95d242011-01-23 07:29:29 +00001357 isSafeForScalarRepl(BC, Offset, Info);
Bob Wilsonb742def2009-12-18 20:14:40 +00001358 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001359 uint64_t GEPOffset = Offset;
Chris Lattner6c95d242011-01-23 07:29:29 +00001360 isSafeGEP(GEPI, GEPOffset, Info);
Bob Wilsonb742def2009-12-18 20:14:40 +00001361 if (!Info.isUnsafe)
Chris Lattner6c95d242011-01-23 07:29:29 +00001362 isSafeForScalarRepl(GEPI, GEPOffset, Info);
Gabor Greif19101c72010-06-28 11:20:42 +00001363 } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(User)) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001364 ConstantInt *Length = dyn_cast<ConstantInt>(MI->getLength());
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001365 if (Length == 0)
1366 return MarkUnsafe(Info, User);
Chris Lattner6c95d242011-01-23 07:29:29 +00001367 isSafeMemAccess(Offset, Length->getZExtValue(), 0,
Chris Lattner145c5322011-01-23 08:27:54 +00001368 UI.getOperandNo() == 0, Info, MI,
1369 true /*AllowWholeAccess*/);
Bob Wilsonb742def2009-12-18 20:14:40 +00001370 } else if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001371 if (LI->isVolatile())
1372 return MarkUnsafe(Info, User);
1373 const Type *LIType = LI->getType();
Chris Lattner6c95d242011-01-23 07:29:29 +00001374 isSafeMemAccess(Offset, TD->getTypeAllocSize(LIType),
Chris Lattner145c5322011-01-23 08:27:54 +00001375 LIType, false, Info, LI, true /*AllowWholeAccess*/);
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001376 Info.hasALoadOrStore = true;
1377
Bob Wilsonb742def2009-12-18 20:14:40 +00001378 } else if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
1379 // Store is ok if storing INTO the pointer, not storing the pointer
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001380 if (SI->isVolatile() || SI->getOperand(0) == I)
1381 return MarkUnsafe(Info, User);
1382
1383 const Type *SIType = SI->getOperand(0)->getType();
Chris Lattner6c95d242011-01-23 07:29:29 +00001384 isSafeMemAccess(Offset, TD->getTypeAllocSize(SIType),
Chris Lattner145c5322011-01-23 08:27:54 +00001385 SIType, true, Info, SI, true /*AllowWholeAccess*/);
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001386 Info.hasALoadOrStore = true;
Chris Lattner145c5322011-01-23 08:27:54 +00001387 } else if (isa<PHINode>(User) || isa<SelectInst>(User)) {
1388 isSafePHISelectUseForScalarRepl(User, Offset, Info);
1389 } else {
1390 return MarkUnsafe(Info, User);
1391 }
1392 if (Info.isUnsafe) return;
1393 }
1394}
1395
1396
1397/// isSafePHIUseForScalarRepl - If we see a PHI node or select using a pointer
1398/// derived from the alloca, we can often still split the alloca into elements.
1399/// This is useful if we have a large alloca where one element is phi'd
1400/// together somewhere: we can SRoA and promote all the other elements even if
1401/// we end up not being able to promote this one.
1402///
1403/// All we require is that the uses of the PHI do not index into other parts of
1404/// the alloca. The most important use case for this is single load and stores
1405/// that are PHI'd together, which can happen due to code sinking.
1406void SROA::isSafePHISelectUseForScalarRepl(Instruction *I, uint64_t Offset,
1407 AllocaInfo &Info) {
1408 // If we've already checked this PHI, don't do it again.
1409 if (PHINode *PN = dyn_cast<PHINode>(I))
1410 if (!Info.CheckedPHIs.insert(PN))
1411 return;
1412
1413 for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI!=E; ++UI) {
1414 Instruction *User = cast<Instruction>(*UI);
1415
1416 if (BitCastInst *BC = dyn_cast<BitCastInst>(User)) {
1417 isSafePHISelectUseForScalarRepl(BC, Offset, Info);
1418 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
1419 // Only allow "bitcast" GEPs for simplicity. We could generalize this,
1420 // but would have to prove that we're staying inside of an element being
1421 // promoted.
1422 if (!GEPI->hasAllZeroIndices())
1423 return MarkUnsafe(Info, User);
1424 isSafePHISelectUseForScalarRepl(GEPI, Offset, Info);
1425 } else if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
1426 if (LI->isVolatile())
1427 return MarkUnsafe(Info, User);
1428 const Type *LIType = LI->getType();
1429 isSafeMemAccess(Offset, TD->getTypeAllocSize(LIType),
1430 LIType, false, Info, LI, false /*AllowWholeAccess*/);
1431 Info.hasALoadOrStore = true;
1432
1433 } else if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
1434 // Store is ok if storing INTO the pointer, not storing the pointer
1435 if (SI->isVolatile() || SI->getOperand(0) == I)
1436 return MarkUnsafe(Info, User);
1437
1438 const Type *SIType = SI->getOperand(0)->getType();
1439 isSafeMemAccess(Offset, TD->getTypeAllocSize(SIType),
1440 SIType, true, Info, SI, false /*AllowWholeAccess*/);
1441 Info.hasALoadOrStore = true;
1442 } else if (isa<PHINode>(User) || isa<SelectInst>(User)) {
1443 isSafePHISelectUseForScalarRepl(User, Offset, Info);
Bob Wilsonb742def2009-12-18 20:14:40 +00001444 } else {
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001445 return MarkUnsafe(Info, User);
Bob Wilsonb742def2009-12-18 20:14:40 +00001446 }
1447 if (Info.isUnsafe) return;
Bob Wilson39c88a62009-12-17 18:34:24 +00001448 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001449}
Bob Wilson39c88a62009-12-17 18:34:24 +00001450
Bob Wilsonb742def2009-12-18 20:14:40 +00001451/// isSafeGEP - Check if a GEP instruction can be handled for scalar
1452/// replacement. It is safe when all the indices are constant, in-bounds
1453/// references, and when the resulting offset corresponds to an element within
1454/// the alloca type. The results are flagged in the Info parameter. Upon
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001455/// return, Offset is adjusted as specified by the GEP indices.
Chris Lattner6c95d242011-01-23 07:29:29 +00001456void SROA::isSafeGEP(GetElementPtrInst *GEPI,
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001457 uint64_t &Offset, AllocaInfo &Info) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001458 gep_type_iterator GEPIt = gep_type_begin(GEPI), E = gep_type_end(GEPI);
1459 if (GEPIt == E)
1460 return;
Bob Wilson39c88a62009-12-17 18:34:24 +00001461
Chris Lattner88e6dc82008-08-23 05:21:06 +00001462 // Walk through the GEP type indices, checking the types that this indexes
1463 // into.
Bob Wilsonb742def2009-12-18 20:14:40 +00001464 for (; GEPIt != E; ++GEPIt) {
Chris Lattner88e6dc82008-08-23 05:21:06 +00001465 // Ignore struct elements, no extra checking needed for these.
Duncan Sands1df98592010-02-16 11:11:14 +00001466 if ((*GEPIt)->isStructTy())
Chris Lattner88e6dc82008-08-23 05:21:06 +00001467 continue;
Matthijs Kooijman5fac55f2008-10-06 16:23:31 +00001468
Bob Wilsonb742def2009-12-18 20:14:40 +00001469 ConstantInt *IdxVal = dyn_cast<ConstantInt>(GEPIt.getOperand());
1470 if (!IdxVal)
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001471 return MarkUnsafe(Info, GEPI);
Chris Lattner88e6dc82008-08-23 05:21:06 +00001472 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001473
Bob Wilsonf27a4cd2009-12-22 06:57:14 +00001474 // Compute the offset due to this GEP and check if the alloca has a
1475 // component element at that offset.
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001476 SmallVector<Value*, 8> Indices(GEPI->op_begin() + 1, GEPI->op_end());
1477 Offset += TD->getIndexedOffset(GEPI->getPointerOperandType(),
1478 &Indices[0], Indices.size());
Chris Lattner6c95d242011-01-23 07:29:29 +00001479 if (!TypeHasComponent(Info.AI->getAllocatedType(), Offset, 0))
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001480 MarkUnsafe(Info, GEPI);
Chris Lattner5e062a12003-05-30 04:15:41 +00001481}
1482
Bob Wilson704d1342011-01-13 17:45:11 +00001483/// isHomogeneousAggregate - Check if type T is a struct or array containing
1484/// elements of the same type (which is always true for arrays). If so,
1485/// return true with NumElts and EltTy set to the number of elements and the
1486/// element type, respectively.
1487static bool isHomogeneousAggregate(const Type *T, unsigned &NumElts,
1488 const Type *&EltTy) {
1489 if (const ArrayType *AT = dyn_cast<ArrayType>(T)) {
1490 NumElts = AT->getNumElements();
Bob Wilsonf0908ae2011-01-13 18:26:59 +00001491 EltTy = (NumElts == 0 ? 0 : AT->getElementType());
Bob Wilson704d1342011-01-13 17:45:11 +00001492 return true;
1493 }
1494 if (const StructType *ST = dyn_cast<StructType>(T)) {
1495 NumElts = ST->getNumContainedTypes();
Bob Wilsonf0908ae2011-01-13 18:26:59 +00001496 EltTy = (NumElts == 0 ? 0 : ST->getContainedType(0));
Bob Wilson704d1342011-01-13 17:45:11 +00001497 for (unsigned n = 1; n < NumElts; ++n) {
1498 if (ST->getContainedType(n) != EltTy)
1499 return false;
1500 }
1501 return true;
1502 }
1503 return false;
1504}
1505
1506/// isCompatibleAggregate - Check if T1 and T2 are either the same type or are
1507/// "homogeneous" aggregates with the same element type and number of elements.
1508static bool isCompatibleAggregate(const Type *T1, const Type *T2) {
1509 if (T1 == T2)
1510 return true;
1511
1512 unsigned NumElts1, NumElts2;
1513 const Type *EltTy1, *EltTy2;
1514 if (isHomogeneousAggregate(T1, NumElts1, EltTy1) &&
1515 isHomogeneousAggregate(T2, NumElts2, EltTy2) &&
1516 NumElts1 == NumElts2 &&
1517 EltTy1 == EltTy2)
1518 return true;
1519
1520 return false;
1521}
1522
Bob Wilsonb742def2009-12-18 20:14:40 +00001523/// isSafeMemAccess - Check if a load/store/memcpy operates on the entire AI
1524/// alloca or has an offset and size that corresponds to a component element
1525/// within it. The offset checked here may have been formed from a GEP with a
1526/// pointer bitcasted to a different type.
Chris Lattner145c5322011-01-23 08:27:54 +00001527///
1528/// If AllowWholeAccess is true, then this allows uses of the entire alloca as a
1529/// unit. If false, it only allows accesses known to be in a single element.
Chris Lattner6c95d242011-01-23 07:29:29 +00001530void SROA::isSafeMemAccess(uint64_t Offset, uint64_t MemSize,
Bob Wilsonb742def2009-12-18 20:14:40 +00001531 const Type *MemOpType, bool isStore,
Chris Lattner145c5322011-01-23 08:27:54 +00001532 AllocaInfo &Info, Instruction *TheAccess,
1533 bool AllowWholeAccess) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001534 // Check if this is a load/store of the entire alloca.
Chris Lattner145c5322011-01-23 08:27:54 +00001535 if (Offset == 0 && AllowWholeAccess &&
Chris Lattner6c95d242011-01-23 07:29:29 +00001536 MemSize == TD->getTypeAllocSize(Info.AI->getAllocatedType())) {
Bob Wilson704d1342011-01-13 17:45:11 +00001537 // This can be safe for MemIntrinsics (where MemOpType is 0) and integer
1538 // loads/stores (which are essentially the same as the MemIntrinsics with
1539 // regard to copying padding between elements). But, if an alloca is
1540 // flagged as both a source and destination of such operations, we'll need
1541 // to check later for padding between elements.
1542 if (!MemOpType || MemOpType->isIntegerTy()) {
1543 if (isStore)
1544 Info.isMemCpyDst = true;
1545 else
1546 Info.isMemCpySrc = true;
Bob Wilsonb742def2009-12-18 20:14:40 +00001547 return;
1548 }
Bob Wilson704d1342011-01-13 17:45:11 +00001549 // This is also safe for references using a type that is compatible with
1550 // the type of the alloca, so that loads/stores can be rewritten using
1551 // insertvalue/extractvalue.
Chris Lattner6c95d242011-01-23 07:29:29 +00001552 if (isCompatibleAggregate(MemOpType, Info.AI->getAllocatedType())) {
Chris Lattner7e9b4272011-01-16 06:18:28 +00001553 Info.hasSubelementAccess = true;
Bob Wilson704d1342011-01-13 17:45:11 +00001554 return;
Chris Lattner7e9b4272011-01-16 06:18:28 +00001555 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001556 }
1557 // Check if the offset/size correspond to a component within the alloca type.
Chris Lattner6c95d242011-01-23 07:29:29 +00001558 const Type *T = Info.AI->getAllocatedType();
Chris Lattner7e9b4272011-01-16 06:18:28 +00001559 if (TypeHasComponent(T, Offset, MemSize)) {
1560 Info.hasSubelementAccess = true;
Bob Wilsonb742def2009-12-18 20:14:40 +00001561 return;
Chris Lattner7e9b4272011-01-16 06:18:28 +00001562 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001563
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001564 return MarkUnsafe(Info, TheAccess);
Bob Wilsonb742def2009-12-18 20:14:40 +00001565}
1566
1567/// TypeHasComponent - Return true if T has a component type with the
1568/// specified offset and size. If Size is zero, do not check the size.
1569bool SROA::TypeHasComponent(const Type *T, uint64_t Offset, uint64_t Size) {
1570 const Type *EltTy;
1571 uint64_t EltSize;
1572 if (const StructType *ST = dyn_cast<StructType>(T)) {
1573 const StructLayout *Layout = TD->getStructLayout(ST);
1574 unsigned EltIdx = Layout->getElementContainingOffset(Offset);
1575 EltTy = ST->getContainedType(EltIdx);
1576 EltSize = TD->getTypeAllocSize(EltTy);
1577 Offset -= Layout->getElementOffset(EltIdx);
1578 } else if (const ArrayType *AT = dyn_cast<ArrayType>(T)) {
1579 EltTy = AT->getElementType();
1580 EltSize = TD->getTypeAllocSize(EltTy);
Bob Wilsonf27a4cd2009-12-22 06:57:14 +00001581 if (Offset >= AT->getNumElements() * EltSize)
1582 return false;
Bob Wilsonb742def2009-12-18 20:14:40 +00001583 Offset %= EltSize;
1584 } else {
1585 return false;
1586 }
1587 if (Offset == 0 && (Size == 0 || EltSize == Size))
1588 return true;
1589 // Check if the component spans multiple elements.
1590 if (Offset + Size > EltSize)
1591 return false;
1592 return TypeHasComponent(EltTy, Offset, Size);
1593}
1594
1595/// RewriteForScalarRepl - Alloca AI is being split into NewElts, so rewrite
1596/// the instruction I, which references it, to use the separate elements.
1597/// Offset indicates the position within AI that is referenced by this
1598/// instruction.
1599void SROA::RewriteForScalarRepl(Instruction *I, AllocaInst *AI, uint64_t Offset,
1600 SmallVector<AllocaInst*, 32> &NewElts) {
Chris Lattner145c5322011-01-23 08:27:54 +00001601 for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI!=E;) {
1602 Use &TheUse = UI.getUse();
1603 Instruction *User = cast<Instruction>(*UI++);
Bob Wilsonb742def2009-12-18 20:14:40 +00001604
1605 if (BitCastInst *BC = dyn_cast<BitCastInst>(User)) {
1606 RewriteBitCast(BC, AI, Offset, NewElts);
Chris Lattner145c5322011-01-23 08:27:54 +00001607 continue;
1608 }
1609
1610 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001611 RewriteGEP(GEPI, AI, Offset, NewElts);
Chris Lattner145c5322011-01-23 08:27:54 +00001612 continue;
1613 }
1614
1615 if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(User)) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001616 ConstantInt *Length = dyn_cast<ConstantInt>(MI->getLength());
1617 uint64_t MemSize = Length->getZExtValue();
1618 if (Offset == 0 &&
1619 MemSize == TD->getTypeAllocSize(AI->getAllocatedType()))
1620 RewriteMemIntrinUserOfAlloca(MI, I, AI, NewElts);
Bob Wilsone88728d2009-12-19 06:53:17 +00001621 // Otherwise the intrinsic can only touch a single element and the
1622 // address operand will be updated, so nothing else needs to be done.
Chris Lattner145c5322011-01-23 08:27:54 +00001623 continue;
1624 }
1625
1626 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001627 const Type *LIType = LI->getType();
Chris Lattner192228e2011-01-16 05:28:59 +00001628
Bob Wilson704d1342011-01-13 17:45:11 +00001629 if (isCompatibleAggregate(LIType, AI->getAllocatedType())) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001630 // Replace:
1631 // %res = load { i32, i32 }* %alloc
1632 // with:
1633 // %load.0 = load i32* %alloc.0
1634 // %insert.0 insertvalue { i32, i32 } zeroinitializer, i32 %load.0, 0
1635 // %load.1 = load i32* %alloc.1
1636 // %insert = insertvalue { i32, i32 } %insert.0, i32 %load.1, 1
1637 // (Also works for arrays instead of structs)
1638 Value *Insert = UndefValue::get(LIType);
1639 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
1640 Value *Load = new LoadInst(NewElts[i], "load", LI);
1641 Insert = InsertValueInst::Create(Insert, Load, i, "insert", LI);
1642 }
1643 LI->replaceAllUsesWith(Insert);
1644 DeadInsts.push_back(LI);
Duncan Sands1df98592010-02-16 11:11:14 +00001645 } else if (LIType->isIntegerTy() &&
Bob Wilsonb742def2009-12-18 20:14:40 +00001646 TD->getTypeAllocSize(LIType) ==
1647 TD->getTypeAllocSize(AI->getAllocatedType())) {
1648 // If this is a load of the entire alloca to an integer, rewrite it.
1649 RewriteLoadUserOfWholeAlloca(LI, AI, NewElts);
1650 }
Chris Lattner145c5322011-01-23 08:27:54 +00001651 continue;
1652 }
1653
1654 if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001655 Value *Val = SI->getOperand(0);
1656 const Type *SIType = Val->getType();
Bob Wilson704d1342011-01-13 17:45:11 +00001657 if (isCompatibleAggregate(SIType, AI->getAllocatedType())) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001658 // Replace:
1659 // store { i32, i32 } %val, { i32, i32 }* %alloc
1660 // with:
1661 // %val.0 = extractvalue { i32, i32 } %val, 0
1662 // store i32 %val.0, i32* %alloc.0
1663 // %val.1 = extractvalue { i32, i32 } %val, 1
1664 // store i32 %val.1, i32* %alloc.1
1665 // (Also works for arrays instead of structs)
1666 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
1667 Value *Extract = ExtractValueInst::Create(Val, i, Val->getName(), SI);
1668 new StoreInst(Extract, NewElts[i], SI);
1669 }
1670 DeadInsts.push_back(SI);
Duncan Sands1df98592010-02-16 11:11:14 +00001671 } else if (SIType->isIntegerTy() &&
Bob Wilsonb742def2009-12-18 20:14:40 +00001672 TD->getTypeAllocSize(SIType) ==
1673 TD->getTypeAllocSize(AI->getAllocatedType())) {
1674 // If this is a store of the entire alloca from an integer, rewrite it.
1675 RewriteStoreUserOfWholeAlloca(SI, AI, NewElts);
1676 }
Chris Lattner145c5322011-01-23 08:27:54 +00001677 continue;
1678 }
1679
1680 if (isa<SelectInst>(User) || isa<PHINode>(User)) {
1681 // If we have a PHI user of the alloca itself (as opposed to a GEP or
1682 // bitcast) we have to rewrite it. GEP and bitcast uses will be RAUW'd to
1683 // the new pointer.
1684 if (!isa<AllocaInst>(I)) continue;
1685
1686 assert(Offset == 0 && NewElts[0] &&
1687 "Direct alloca use should have a zero offset");
1688
1689 // If we have a use of the alloca, we know the derived uses will be
1690 // utilizing just the first element of the scalarized result. Insert a
1691 // bitcast of the first alloca before the user as required.
1692 AllocaInst *NewAI = NewElts[0];
1693 BitCastInst *BCI = new BitCastInst(NewAI, AI->getType(), "", NewAI);
1694 NewAI->moveBefore(BCI);
1695 TheUse = BCI;
1696 continue;
Bob Wilsonb742def2009-12-18 20:14:40 +00001697 }
Bob Wilson39c88a62009-12-17 18:34:24 +00001698 }
1699}
1700
Bob Wilsonb742def2009-12-18 20:14:40 +00001701/// RewriteBitCast - Update a bitcast reference to the alloca being replaced
1702/// and recursively continue updating all of its uses.
1703void SROA::RewriteBitCast(BitCastInst *BC, AllocaInst *AI, uint64_t Offset,
1704 SmallVector<AllocaInst*, 32> &NewElts) {
1705 RewriteForScalarRepl(BC, AI, Offset, NewElts);
1706 if (BC->getOperand(0) != AI)
1707 return;
Bob Wilson39c88a62009-12-17 18:34:24 +00001708
Bob Wilsonb742def2009-12-18 20:14:40 +00001709 // The bitcast references the original alloca. Replace its uses with
1710 // references to the first new element alloca.
1711 Instruction *Val = NewElts[0];
1712 if (Val->getType() != BC->getDestTy()) {
1713 Val = new BitCastInst(Val, BC->getDestTy(), "", BC);
1714 Val->takeName(BC);
Daniel Dunbarfca55c82009-12-16 10:56:17 +00001715 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001716 BC->replaceAllUsesWith(Val);
1717 DeadInsts.push_back(BC);
Daniel Dunbarfca55c82009-12-16 10:56:17 +00001718}
1719
Bob Wilsonb742def2009-12-18 20:14:40 +00001720/// FindElementAndOffset - Return the index of the element containing Offset
1721/// within the specified type, which must be either a struct or an array.
1722/// Sets T to the type of the element and Offset to the offset within that
Bob Wilsone88728d2009-12-19 06:53:17 +00001723/// element. IdxTy is set to the type of the index result to be used in a
1724/// GEP instruction.
1725uint64_t SROA::FindElementAndOffset(const Type *&T, uint64_t &Offset,
1726 const Type *&IdxTy) {
1727 uint64_t Idx = 0;
Bob Wilsonb742def2009-12-18 20:14:40 +00001728 if (const StructType *ST = dyn_cast<StructType>(T)) {
1729 const StructLayout *Layout = TD->getStructLayout(ST);
1730 Idx = Layout->getElementContainingOffset(Offset);
1731 T = ST->getContainedType(Idx);
1732 Offset -= Layout->getElementOffset(Idx);
Bob Wilsone88728d2009-12-19 06:53:17 +00001733 IdxTy = Type::getInt32Ty(T->getContext());
1734 return Idx;
Chris Lattnera59adc42009-12-14 05:11:02 +00001735 }
Bob Wilsone88728d2009-12-19 06:53:17 +00001736 const ArrayType *AT = cast<ArrayType>(T);
1737 T = AT->getElementType();
1738 uint64_t EltSize = TD->getTypeAllocSize(T);
1739 Idx = Offset / EltSize;
1740 Offset -= Idx * EltSize;
1741 IdxTy = Type::getInt64Ty(T->getContext());
Bob Wilsonb742def2009-12-18 20:14:40 +00001742 return Idx;
1743}
1744
1745/// RewriteGEP - Check if this GEP instruction moves the pointer across
1746/// elements of the alloca that are being split apart, and if so, rewrite
1747/// the GEP to be relative to the new element.
1748void SROA::RewriteGEP(GetElementPtrInst *GEPI, AllocaInst *AI, uint64_t Offset,
1749 SmallVector<AllocaInst*, 32> &NewElts) {
1750 uint64_t OldOffset = Offset;
1751 SmallVector<Value*, 8> Indices(GEPI->op_begin() + 1, GEPI->op_end());
1752 Offset += TD->getIndexedOffset(GEPI->getPointerOperandType(),
1753 &Indices[0], Indices.size());
1754
1755 RewriteForScalarRepl(GEPI, AI, Offset, NewElts);
1756
1757 const Type *T = AI->getAllocatedType();
Bob Wilsone88728d2009-12-19 06:53:17 +00001758 const Type *IdxTy;
1759 uint64_t OldIdx = FindElementAndOffset(T, OldOffset, IdxTy);
Bob Wilsonb742def2009-12-18 20:14:40 +00001760 if (GEPI->getOperand(0) == AI)
Bob Wilsone88728d2009-12-19 06:53:17 +00001761 OldIdx = ~0ULL; // Force the GEP to be rewritten.
Bob Wilsonb742def2009-12-18 20:14:40 +00001762
1763 T = AI->getAllocatedType();
1764 uint64_t EltOffset = Offset;
Bob Wilsone88728d2009-12-19 06:53:17 +00001765 uint64_t Idx = FindElementAndOffset(T, EltOffset, IdxTy);
Bob Wilsonb742def2009-12-18 20:14:40 +00001766
1767 // If this GEP does not move the pointer across elements of the alloca
1768 // being split, then it does not needs to be rewritten.
1769 if (Idx == OldIdx)
1770 return;
1771
1772 const Type *i32Ty = Type::getInt32Ty(AI->getContext());
1773 SmallVector<Value*, 8> NewArgs;
1774 NewArgs.push_back(Constant::getNullValue(i32Ty));
1775 while (EltOffset != 0) {
Bob Wilsone88728d2009-12-19 06:53:17 +00001776 uint64_t EltIdx = FindElementAndOffset(T, EltOffset, IdxTy);
1777 NewArgs.push_back(ConstantInt::get(IdxTy, EltIdx));
Bob Wilsonb742def2009-12-18 20:14:40 +00001778 }
1779 Instruction *Val = NewElts[Idx];
1780 if (NewArgs.size() > 1) {
1781 Val = GetElementPtrInst::CreateInBounds(Val, NewArgs.begin(),
1782 NewArgs.end(), "", GEPI);
1783 Val->takeName(GEPI);
1784 }
1785 if (Val->getType() != GEPI->getType())
Benjamin Kramer2d64ca02010-01-27 19:46:52 +00001786 Val = new BitCastInst(Val, GEPI->getType(), Val->getName(), GEPI);
Bob Wilsonb742def2009-12-18 20:14:40 +00001787 GEPI->replaceAllUsesWith(Val);
1788 DeadInsts.push_back(GEPI);
Chris Lattnerd93afec2009-01-07 07:18:45 +00001789}
1790
1791/// RewriteMemIntrinUserOfAlloca - MI is a memcpy/memset/memmove from or to AI.
1792/// Rewrite it to copy or set the elements of the scalarized memory.
Bob Wilsonb742def2009-12-18 20:14:40 +00001793void SROA::RewriteMemIntrinUserOfAlloca(MemIntrinsic *MI, Instruction *Inst,
Victor Hernandez7b929da2009-10-23 21:09:37 +00001794 AllocaInst *AI,
Chris Lattnerd93afec2009-01-07 07:18:45 +00001795 SmallVector<AllocaInst*, 32> &NewElts) {
Chris Lattnerd93afec2009-01-07 07:18:45 +00001796 // If this is a memcpy/memmove, construct the other pointer as the
Chris Lattner88fe1ad2009-03-04 19:23:25 +00001797 // appropriate type. The "Other" pointer is the pointer that goes to memory
1798 // that doesn't have anything to do with the alloca that we are promoting. For
1799 // memset, this Value* stays null.
Chris Lattnerd93afec2009-01-07 07:18:45 +00001800 Value *OtherPtr = 0;
Chris Lattnerdfe964c2009-03-08 03:59:00 +00001801 unsigned MemAlignment = MI->getAlignment();
Chris Lattner3ce5e882009-03-08 03:37:16 +00001802 if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(MI)) { // memmove/memcopy
Bob Wilsonb742def2009-12-18 20:14:40 +00001803 if (Inst == MTI->getRawDest())
Chris Lattner3ce5e882009-03-08 03:37:16 +00001804 OtherPtr = MTI->getRawSource();
Chris Lattnerd93afec2009-01-07 07:18:45 +00001805 else {
Bob Wilsonb742def2009-12-18 20:14:40 +00001806 assert(Inst == MTI->getRawSource());
Chris Lattner3ce5e882009-03-08 03:37:16 +00001807 OtherPtr = MTI->getRawDest();
Chris Lattnerd93afec2009-01-07 07:18:45 +00001808 }
1809 }
Bob Wilson78c50b82009-12-08 18:22:03 +00001810
Chris Lattnerd93afec2009-01-07 07:18:45 +00001811 // If there is an other pointer, we want to convert it to the same pointer
1812 // type as AI has, so we can GEP through it safely.
1813 if (OtherPtr) {
Chris Lattner0238f8c2010-07-08 00:27:05 +00001814 unsigned AddrSpace =
1815 cast<PointerType>(OtherPtr->getType())->getAddressSpace();
Bob Wilsonb742def2009-12-18 20:14:40 +00001816
1817 // Remove bitcasts and all-zero GEPs from OtherPtr. This is an
1818 // optimization, but it's also required to detect the corner case where
1819 // both pointer operands are referencing the same memory, and where
1820 // OtherPtr may be a bitcast or GEP that currently being rewritten. (This
1821 // function is only called for mem intrinsics that access the whole
1822 // aggregate, so non-zero GEPs are not an issue here.)
Chris Lattner0238f8c2010-07-08 00:27:05 +00001823 OtherPtr = OtherPtr->stripPointerCasts();
Bob Wilson69743022011-01-13 20:59:44 +00001824
Bob Wilsona756b1d2010-01-19 04:32:48 +00001825 // Copying the alloca to itself is a no-op: just delete it.
1826 if (OtherPtr == AI || OtherPtr == NewElts[0]) {
1827 // This code will run twice for a no-op memcpy -- once for each operand.
1828 // Put only one reference to MI on the DeadInsts list.
1829 for (SmallVector<Value*, 32>::const_iterator I = DeadInsts.begin(),
1830 E = DeadInsts.end(); I != E; ++I)
1831 if (*I == MI) return;
1832 DeadInsts.push_back(MI);
Bob Wilsonb742def2009-12-18 20:14:40 +00001833 return;
Bob Wilsona756b1d2010-01-19 04:32:48 +00001834 }
Bob Wilson69743022011-01-13 20:59:44 +00001835
Chris Lattnerd93afec2009-01-07 07:18:45 +00001836 // If the pointer is not the right type, insert a bitcast to the right
1837 // type.
Chris Lattner0238f8c2010-07-08 00:27:05 +00001838 const Type *NewTy =
1839 PointerType::get(AI->getType()->getElementType(), AddrSpace);
Bob Wilson69743022011-01-13 20:59:44 +00001840
Chris Lattner0238f8c2010-07-08 00:27:05 +00001841 if (OtherPtr->getType() != NewTy)
1842 OtherPtr = new BitCastInst(OtherPtr, NewTy, OtherPtr->getName(), MI);
Chris Lattnerd93afec2009-01-07 07:18:45 +00001843 }
Bob Wilson69743022011-01-13 20:59:44 +00001844
Chris Lattnerd93afec2009-01-07 07:18:45 +00001845 // Process each element of the aggregate.
Bob Wilsonb742def2009-12-18 20:14:40 +00001846 bool SROADest = MI->getRawDest() == Inst;
Bob Wilson69743022011-01-13 20:59:44 +00001847
Owen Anderson1d0be152009-08-13 21:58:54 +00001848 Constant *Zero = Constant::getNullValue(Type::getInt32Ty(MI->getContext()));
Chris Lattnerd93afec2009-01-07 07:18:45 +00001849
1850 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
1851 // If this is a memcpy/memmove, emit a GEP of the other element address.
1852 Value *OtherElt = 0;
Chris Lattner1541e0f2009-03-04 19:20:50 +00001853 unsigned OtherEltAlign = MemAlignment;
Bob Wilson69743022011-01-13 20:59:44 +00001854
Bob Wilsona756b1d2010-01-19 04:32:48 +00001855 if (OtherPtr) {
Owen Anderson1d0be152009-08-13 21:58:54 +00001856 Value *Idx[2] = { Zero,
1857 ConstantInt::get(Type::getInt32Ty(MI->getContext()), i) };
Bob Wilsonb742def2009-12-18 20:14:40 +00001858 OtherElt = GetElementPtrInst::CreateInBounds(OtherPtr, Idx, Idx + 2,
Benjamin Kramer2d64ca02010-01-27 19:46:52 +00001859 OtherPtr->getName()+"."+Twine(i),
Bob Wilsonb742def2009-12-18 20:14:40 +00001860 MI);
Chris Lattner1541e0f2009-03-04 19:20:50 +00001861 uint64_t EltOffset;
1862 const PointerType *OtherPtrTy = cast<PointerType>(OtherPtr->getType());
Chris Lattnerd55c1c12010-04-16 01:05:38 +00001863 const Type *OtherTy = OtherPtrTy->getElementType();
1864 if (const StructType *ST = dyn_cast<StructType>(OtherTy)) {
Chris Lattner1541e0f2009-03-04 19:20:50 +00001865 EltOffset = TD->getStructLayout(ST)->getElementOffset(i);
1866 } else {
Chris Lattnerd55c1c12010-04-16 01:05:38 +00001867 const Type *EltTy = cast<SequentialType>(OtherTy)->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +00001868 EltOffset = TD->getTypeAllocSize(EltTy)*i;
Chris Lattner1541e0f2009-03-04 19:20:50 +00001869 }
Bob Wilson69743022011-01-13 20:59:44 +00001870
Chris Lattner1541e0f2009-03-04 19:20:50 +00001871 // The alignment of the other pointer is the guaranteed alignment of the
1872 // element, which is affected by both the known alignment of the whole
1873 // mem intrinsic and the alignment of the element. If the alignment of
1874 // the memcpy (f.e.) is 32 but the element is at a 4-byte offset, then the
1875 // known alignment is just 4 bytes.
1876 OtherEltAlign = (unsigned)MinAlign(OtherEltAlign, EltOffset);
Chris Lattnerc14d3ca2007-03-08 06:36:54 +00001877 }
Bob Wilson69743022011-01-13 20:59:44 +00001878
Chris Lattnerd93afec2009-01-07 07:18:45 +00001879 Value *EltPtr = NewElts[i];
Chris Lattner1541e0f2009-03-04 19:20:50 +00001880 const Type *EltTy = cast<PointerType>(EltPtr->getType())->getElementType();
Bob Wilson69743022011-01-13 20:59:44 +00001881
Chris Lattnerd93afec2009-01-07 07:18:45 +00001882 // If we got down to a scalar, insert a load or store as appropriate.
1883 if (EltTy->isSingleValueType()) {
Chris Lattner3ce5e882009-03-08 03:37:16 +00001884 if (isa<MemTransferInst>(MI)) {
Chris Lattner1541e0f2009-03-04 19:20:50 +00001885 if (SROADest) {
1886 // From Other to Alloca.
1887 Value *Elt = new LoadInst(OtherElt, "tmp", false, OtherEltAlign, MI);
1888 new StoreInst(Elt, EltPtr, MI);
1889 } else {
1890 // From Alloca to Other.
1891 Value *Elt = new LoadInst(EltPtr, "tmp", MI);
1892 new StoreInst(Elt, OtherElt, false, OtherEltAlign, MI);
1893 }
Chris Lattnerd93afec2009-01-07 07:18:45 +00001894 continue;
1895 }
1896 assert(isa<MemSetInst>(MI));
Bob Wilson69743022011-01-13 20:59:44 +00001897
Chris Lattnerd93afec2009-01-07 07:18:45 +00001898 // If the stored element is zero (common case), just store a null
1899 // constant.
1900 Constant *StoreVal;
Gabor Greif6f14c8c2010-06-30 09:16:16 +00001901 if (ConstantInt *CI = dyn_cast<ConstantInt>(MI->getArgOperand(1))) {
Chris Lattnerd93afec2009-01-07 07:18:45 +00001902 if (CI->isZero()) {
Owen Andersona7235ea2009-07-31 20:28:14 +00001903 StoreVal = Constant::getNullValue(EltTy); // 0.0, null, 0, <0,0>
Chris Lattnerd93afec2009-01-07 07:18:45 +00001904 } else {
1905 // If EltTy is a vector type, get the element type.
Dan Gohman44118f02009-06-16 00:20:26 +00001906 const Type *ValTy = EltTy->getScalarType();
1907
Chris Lattnerd93afec2009-01-07 07:18:45 +00001908 // Construct an integer with the right value.
1909 unsigned EltSize = TD->getTypeSizeInBits(ValTy);
1910 APInt OneVal(EltSize, CI->getZExtValue());
1911 APInt TotalVal(OneVal);
1912 // Set each byte.
1913 for (unsigned i = 0; 8*i < EltSize; ++i) {
1914 TotalVal = TotalVal.shl(8);
1915 TotalVal |= OneVal;
1916 }
Bob Wilson69743022011-01-13 20:59:44 +00001917
Chris Lattnerd93afec2009-01-07 07:18:45 +00001918 // Convert the integer value to the appropriate type.
Chris Lattnerd55c1c12010-04-16 01:05:38 +00001919 StoreVal = ConstantInt::get(CI->getContext(), TotalVal);
Duncan Sands1df98592010-02-16 11:11:14 +00001920 if (ValTy->isPointerTy())
Owen Andersonbaf3c402009-07-29 18:55:55 +00001921 StoreVal = ConstantExpr::getIntToPtr(StoreVal, ValTy);
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00001922 else if (ValTy->isFloatingPointTy())
Owen Andersonbaf3c402009-07-29 18:55:55 +00001923 StoreVal = ConstantExpr::getBitCast(StoreVal, ValTy);
Chris Lattnerd93afec2009-01-07 07:18:45 +00001924 assert(StoreVal->getType() == ValTy && "Type mismatch!");
Bob Wilson69743022011-01-13 20:59:44 +00001925
Chris Lattnerd93afec2009-01-07 07:18:45 +00001926 // If the requested value was a vector constant, create it.
1927 if (EltTy != ValTy) {
1928 unsigned NumElts = cast<VectorType>(ValTy)->getNumElements();
1929 SmallVector<Constant*, 16> Elts(NumElts, StoreVal);
Chris Lattner2ca5c862011-02-15 00:14:00 +00001930 StoreVal = ConstantVector::get(Elts);
Chris Lattnerd93afec2009-01-07 07:18:45 +00001931 }
1932 }
1933 new StoreInst(StoreVal, EltPtr, MI);
1934 continue;
1935 }
1936 // Otherwise, if we're storing a byte variable, use a memset call for
1937 // this element.
1938 }
Bob Wilson69743022011-01-13 20:59:44 +00001939
Duncan Sands777d2302009-05-09 07:06:46 +00001940 unsigned EltSize = TD->getTypeAllocSize(EltTy);
Bob Wilson69743022011-01-13 20:59:44 +00001941
Chris Lattner61db1f52010-12-26 22:57:41 +00001942 IRBuilder<> Builder(MI);
Bob Wilson69743022011-01-13 20:59:44 +00001943
Chris Lattnerd93afec2009-01-07 07:18:45 +00001944 // Finally, insert the meminst for this element.
Chris Lattner61db1f52010-12-26 22:57:41 +00001945 if (isa<MemSetInst>(MI)) {
1946 Builder.CreateMemSet(EltPtr, MI->getArgOperand(1), EltSize,
1947 MI->isVolatile());
Chris Lattnerd93afec2009-01-07 07:18:45 +00001948 } else {
Chris Lattner61db1f52010-12-26 22:57:41 +00001949 assert(isa<MemTransferInst>(MI));
1950 Value *Dst = SROADest ? EltPtr : OtherElt; // Dest ptr
1951 Value *Src = SROADest ? OtherElt : EltPtr; // Src ptr
Bob Wilson69743022011-01-13 20:59:44 +00001952
Chris Lattner61db1f52010-12-26 22:57:41 +00001953 if (isa<MemCpyInst>(MI))
1954 Builder.CreateMemCpy(Dst, Src, EltSize, OtherEltAlign,MI->isVolatile());
1955 else
1956 Builder.CreateMemMove(Dst, Src, EltSize,OtherEltAlign,MI->isVolatile());
Chris Lattnerd93afec2009-01-07 07:18:45 +00001957 }
Chris Lattner372dda82007-03-05 07:52:57 +00001958 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001959 DeadInsts.push_back(MI);
Chris Lattner372dda82007-03-05 07:52:57 +00001960}
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001961
Bob Wilson39fdd692009-12-04 21:57:37 +00001962/// RewriteStoreUserOfWholeAlloca - We found a store of an integer that
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001963/// overwrites the entire allocation. Extract out the pieces of the stored
1964/// integer and store them individually.
Victor Hernandez7b929da2009-10-23 21:09:37 +00001965void SROA::RewriteStoreUserOfWholeAlloca(StoreInst *SI, AllocaInst *AI,
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001966 SmallVector<AllocaInst*, 32> &NewElts){
1967 // Extract each element out of the integer according to its structure offset
1968 // and store the element value to the individual alloca.
1969 Value *SrcVal = SI->getOperand(0);
Bob Wilsonb742def2009-12-18 20:14:40 +00001970 const Type *AllocaEltTy = AI->getAllocatedType();
Duncan Sands777d2302009-05-09 07:06:46 +00001971 uint64_t AllocaSizeBits = TD->getTypeAllocSizeInBits(AllocaEltTy);
Bob Wilson69743022011-01-13 20:59:44 +00001972
Chris Lattner70728532011-01-16 05:58:24 +00001973 IRBuilder<> Builder(SI);
1974
Eli Friedman41b33f42009-06-01 09:14:32 +00001975 // Handle tail padding by extending the operand
1976 if (TD->getTypeSizeInBits(SrcVal->getType()) != AllocaSizeBits)
Chris Lattner70728532011-01-16 05:58:24 +00001977 SrcVal = Builder.CreateZExt(SrcVal,
1978 IntegerType::get(SI->getContext(), AllocaSizeBits));
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001979
David Greene504c7d82010-01-05 01:27:09 +00001980 DEBUG(dbgs() << "PROMOTING STORE TO WHOLE ALLOCA: " << *AI << '\n' << *SI
Nick Lewycky59136252009-09-15 07:08:25 +00001981 << '\n');
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001982
1983 // There are two forms here: AI could be an array or struct. Both cases
1984 // have different ways to compute the element offset.
1985 if (const StructType *EltSTy = dyn_cast<StructType>(AllocaEltTy)) {
1986 const StructLayout *Layout = TD->getStructLayout(EltSTy);
Bob Wilson69743022011-01-13 20:59:44 +00001987
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001988 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
1989 // Get the number of bits to shift SrcVal to get the value.
1990 const Type *FieldTy = EltSTy->getElementType(i);
1991 uint64_t Shift = Layout->getElementOffsetInBits(i);
Bob Wilson69743022011-01-13 20:59:44 +00001992
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001993 if (TD->isBigEndian())
Duncan Sands777d2302009-05-09 07:06:46 +00001994 Shift = AllocaSizeBits-Shift-TD->getTypeAllocSizeInBits(FieldTy);
Bob Wilson69743022011-01-13 20:59:44 +00001995
Chris Lattnerd2fa7812009-01-07 08:11:13 +00001996 Value *EltVal = SrcVal;
1997 if (Shift) {
Owen Andersoneed707b2009-07-24 23:12:02 +00001998 Value *ShiftVal = ConstantInt::get(EltVal->getType(), Shift);
Chris Lattner70728532011-01-16 05:58:24 +00001999 EltVal = Builder.CreateLShr(EltVal, ShiftVal, "sroa.store.elt");
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002000 }
Bob Wilson69743022011-01-13 20:59:44 +00002001
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002002 // Truncate down to an integer of the right size.
2003 uint64_t FieldSizeBits = TD->getTypeSizeInBits(FieldTy);
Bob Wilson69743022011-01-13 20:59:44 +00002004
Chris Lattner583dd602009-01-09 18:18:43 +00002005 // Ignore zero sized fields like {}, they obviously contain no data.
2006 if (FieldSizeBits == 0) continue;
Bob Wilson69743022011-01-13 20:59:44 +00002007
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002008 if (FieldSizeBits != AllocaSizeBits)
Chris Lattner70728532011-01-16 05:58:24 +00002009 EltVal = Builder.CreateTrunc(EltVal,
2010 IntegerType::get(SI->getContext(), FieldSizeBits));
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002011 Value *DestField = NewElts[i];
2012 if (EltVal->getType() == FieldTy) {
2013 // Storing to an integer field of this size, just do it.
Duncan Sands1df98592010-02-16 11:11:14 +00002014 } else if (FieldTy->isFloatingPointTy() || FieldTy->isVectorTy()) {
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002015 // Bitcast to the right element type (for fp/vector values).
Chris Lattner70728532011-01-16 05:58:24 +00002016 EltVal = Builder.CreateBitCast(EltVal, FieldTy);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002017 } else {
2018 // Otherwise, bitcast the dest pointer (for aggregates).
Chris Lattner70728532011-01-16 05:58:24 +00002019 DestField = Builder.CreateBitCast(DestField,
2020 PointerType::getUnqual(EltVal->getType()));
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002021 }
2022 new StoreInst(EltVal, DestField, SI);
2023 }
Bob Wilson69743022011-01-13 20:59:44 +00002024
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002025 } else {
2026 const ArrayType *ATy = cast<ArrayType>(AllocaEltTy);
2027 const Type *ArrayEltTy = ATy->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +00002028 uint64_t ElementOffset = TD->getTypeAllocSizeInBits(ArrayEltTy);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002029 uint64_t ElementSizeBits = TD->getTypeSizeInBits(ArrayEltTy);
2030
2031 uint64_t Shift;
Bob Wilson69743022011-01-13 20:59:44 +00002032
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002033 if (TD->isBigEndian())
2034 Shift = AllocaSizeBits-ElementOffset;
Bob Wilson69743022011-01-13 20:59:44 +00002035 else
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002036 Shift = 0;
Bob Wilson69743022011-01-13 20:59:44 +00002037
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002038 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
Chris Lattner583dd602009-01-09 18:18:43 +00002039 // Ignore zero sized fields like {}, they obviously contain no data.
2040 if (ElementSizeBits == 0) continue;
Bob Wilson69743022011-01-13 20:59:44 +00002041
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002042 Value *EltVal = SrcVal;
2043 if (Shift) {
Owen Andersoneed707b2009-07-24 23:12:02 +00002044 Value *ShiftVal = ConstantInt::get(EltVal->getType(), Shift);
Chris Lattner70728532011-01-16 05:58:24 +00002045 EltVal = Builder.CreateLShr(EltVal, ShiftVal, "sroa.store.elt");
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002046 }
Bob Wilson69743022011-01-13 20:59:44 +00002047
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002048 // Truncate down to an integer of the right size.
2049 if (ElementSizeBits != AllocaSizeBits)
Chris Lattner70728532011-01-16 05:58:24 +00002050 EltVal = Builder.CreateTrunc(EltVal,
2051 IntegerType::get(SI->getContext(),
2052 ElementSizeBits));
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002053 Value *DestField = NewElts[i];
2054 if (EltVal->getType() == ArrayEltTy) {
2055 // Storing to an integer field of this size, just do it.
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00002056 } else if (ArrayEltTy->isFloatingPointTy() ||
Duncan Sands1df98592010-02-16 11:11:14 +00002057 ArrayEltTy->isVectorTy()) {
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002058 // Bitcast to the right element type (for fp/vector values).
Chris Lattner70728532011-01-16 05:58:24 +00002059 EltVal = Builder.CreateBitCast(EltVal, ArrayEltTy);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002060 } else {
2061 // Otherwise, bitcast the dest pointer (for aggregates).
Chris Lattner70728532011-01-16 05:58:24 +00002062 DestField = Builder.CreateBitCast(DestField,
2063 PointerType::getUnqual(EltVal->getType()));
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002064 }
2065 new StoreInst(EltVal, DestField, SI);
Bob Wilson69743022011-01-13 20:59:44 +00002066
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002067 if (TD->isBigEndian())
2068 Shift -= ElementOffset;
Bob Wilson69743022011-01-13 20:59:44 +00002069 else
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002070 Shift += ElementOffset;
2071 }
2072 }
Bob Wilson69743022011-01-13 20:59:44 +00002073
Bob Wilsonb742def2009-12-18 20:14:40 +00002074 DeadInsts.push_back(SI);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002075}
2076
Bob Wilson39fdd692009-12-04 21:57:37 +00002077/// RewriteLoadUserOfWholeAlloca - We found a load of the entire allocation to
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002078/// an integer. Load the individual pieces to form the aggregate value.
Victor Hernandez7b929da2009-10-23 21:09:37 +00002079void SROA::RewriteLoadUserOfWholeAlloca(LoadInst *LI, AllocaInst *AI,
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002080 SmallVector<AllocaInst*, 32> &NewElts) {
2081 // Extract each element out of the NewElts according to its structure offset
2082 // and form the result value.
Bob Wilsonb742def2009-12-18 20:14:40 +00002083 const Type *AllocaEltTy = AI->getAllocatedType();
Duncan Sands777d2302009-05-09 07:06:46 +00002084 uint64_t AllocaSizeBits = TD->getTypeAllocSizeInBits(AllocaEltTy);
Bob Wilson69743022011-01-13 20:59:44 +00002085
David Greene504c7d82010-01-05 01:27:09 +00002086 DEBUG(dbgs() << "PROMOTING LOAD OF WHOLE ALLOCA: " << *AI << '\n' << *LI
Nick Lewycky59136252009-09-15 07:08:25 +00002087 << '\n');
Bob Wilson69743022011-01-13 20:59:44 +00002088
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002089 // There are two forms here: AI could be an array or struct. Both cases
2090 // have different ways to compute the element offset.
2091 const StructLayout *Layout = 0;
2092 uint64_t ArrayEltBitOffset = 0;
2093 if (const StructType *EltSTy = dyn_cast<StructType>(AllocaEltTy)) {
2094 Layout = TD->getStructLayout(EltSTy);
2095 } else {
2096 const Type *ArrayEltTy = cast<ArrayType>(AllocaEltTy)->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +00002097 ArrayEltBitOffset = TD->getTypeAllocSizeInBits(ArrayEltTy);
Bob Wilson69743022011-01-13 20:59:44 +00002098 }
2099
2100 Value *ResultVal =
Owen Anderson1d0be152009-08-13 21:58:54 +00002101 Constant::getNullValue(IntegerType::get(LI->getContext(), AllocaSizeBits));
Bob Wilson69743022011-01-13 20:59:44 +00002102
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002103 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
2104 // Load the value from the alloca. If the NewElt is an aggregate, cast
2105 // the pointer to an integer of the same size before doing the load.
2106 Value *SrcField = NewElts[i];
2107 const Type *FieldTy =
2108 cast<PointerType>(SrcField->getType())->getElementType();
Chris Lattner583dd602009-01-09 18:18:43 +00002109 uint64_t FieldSizeBits = TD->getTypeSizeInBits(FieldTy);
Bob Wilson69743022011-01-13 20:59:44 +00002110
Chris Lattner583dd602009-01-09 18:18:43 +00002111 // Ignore zero sized fields like {}, they obviously contain no data.
2112 if (FieldSizeBits == 0) continue;
Bob Wilson69743022011-01-13 20:59:44 +00002113
2114 const IntegerType *FieldIntTy = IntegerType::get(LI->getContext(),
Owen Anderson1d0be152009-08-13 21:58:54 +00002115 FieldSizeBits);
Duncan Sands1df98592010-02-16 11:11:14 +00002116 if (!FieldTy->isIntegerTy() && !FieldTy->isFloatingPointTy() &&
2117 !FieldTy->isVectorTy())
Owen Andersonfa5cbd62009-07-03 19:42:02 +00002118 SrcField = new BitCastInst(SrcField,
Owen Andersondebcb012009-07-29 22:17:13 +00002119 PointerType::getUnqual(FieldIntTy),
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002120 "", LI);
2121 SrcField = new LoadInst(SrcField, "sroa.load.elt", LI);
2122
2123 // If SrcField is a fp or vector of the right size but that isn't an
2124 // integer type, bitcast to an integer so we can shift it.
2125 if (SrcField->getType() != FieldIntTy)
2126 SrcField = new BitCastInst(SrcField, FieldIntTy, "", LI);
2127
2128 // Zero extend the field to be the same size as the final alloca so that
2129 // we can shift and insert it.
2130 if (SrcField->getType() != ResultVal->getType())
2131 SrcField = new ZExtInst(SrcField, ResultVal->getType(), "", LI);
Bob Wilson69743022011-01-13 20:59:44 +00002132
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002133 // Determine the number of bits to shift SrcField.
2134 uint64_t Shift;
2135 if (Layout) // Struct case.
2136 Shift = Layout->getElementOffsetInBits(i);
2137 else // Array case.
2138 Shift = i*ArrayEltBitOffset;
Bob Wilson69743022011-01-13 20:59:44 +00002139
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002140 if (TD->isBigEndian())
2141 Shift = AllocaSizeBits-Shift-FieldIntTy->getBitWidth();
Bob Wilson69743022011-01-13 20:59:44 +00002142
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002143 if (Shift) {
Owen Andersoneed707b2009-07-24 23:12:02 +00002144 Value *ShiftVal = ConstantInt::get(SrcField->getType(), Shift);
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002145 SrcField = BinaryOperator::CreateShl(SrcField, ShiftVal, "", LI);
2146 }
2147
Chris Lattner14952472010-06-27 07:58:26 +00002148 // Don't create an 'or x, 0' on the first iteration.
2149 if (!isa<Constant>(ResultVal) ||
2150 !cast<Constant>(ResultVal)->isNullValue())
2151 ResultVal = BinaryOperator::CreateOr(SrcField, ResultVal, "", LI);
2152 else
2153 ResultVal = SrcField;
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002154 }
Eli Friedman41b33f42009-06-01 09:14:32 +00002155
2156 // Handle tail padding by truncating the result
2157 if (TD->getTypeSizeInBits(LI->getType()) != AllocaSizeBits)
2158 ResultVal = new TruncInst(ResultVal, LI->getType(), "", LI);
2159
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002160 LI->replaceAllUsesWith(ResultVal);
Bob Wilsonb742def2009-12-18 20:14:40 +00002161 DeadInsts.push_back(LI);
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002162}
2163
Duncan Sands3cb36502007-11-04 14:43:57 +00002164/// HasPadding - Return true if the specified type has any structure or
Bob Wilson694a10e2011-01-13 17:45:08 +00002165/// alignment padding in between the elements that would be split apart
2166/// by SROA; return false otherwise.
Duncan Sandsa0fcc082008-06-04 08:21:45 +00002167static bool HasPadding(const Type *Ty, const TargetData &TD) {
Bob Wilson694a10e2011-01-13 17:45:08 +00002168 if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
2169 Ty = ATy->getElementType();
2170 return TD.getTypeSizeInBits(Ty) != TD.getTypeAllocSizeInBits(Ty);
Chris Lattner39a1c042007-05-30 06:11:23 +00002171 }
Bob Wilson694a10e2011-01-13 17:45:08 +00002172
2173 // SROA currently handles only Arrays and Structs.
2174 const StructType *STy = cast<StructType>(Ty);
2175 const StructLayout *SL = TD.getStructLayout(STy);
2176 unsigned PrevFieldBitOffset = 0;
2177 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2178 unsigned FieldBitOffset = SL->getElementOffsetInBits(i);
2179
2180 // Check to see if there is any padding between this element and the
2181 // previous one.
2182 if (i) {
2183 unsigned PrevFieldEnd =
2184 PrevFieldBitOffset+TD.getTypeSizeInBits(STy->getElementType(i-1));
2185 if (PrevFieldEnd < FieldBitOffset)
2186 return true;
2187 }
2188 PrevFieldBitOffset = FieldBitOffset;
2189 }
2190 // Check for tail padding.
2191 if (unsigned EltCount = STy->getNumElements()) {
2192 unsigned PrevFieldEnd = PrevFieldBitOffset +
2193 TD.getTypeSizeInBits(STy->getElementType(EltCount-1));
2194 if (PrevFieldEnd < SL->getSizeInBits())
2195 return true;
2196 }
2197 return false;
Chris Lattner39a1c042007-05-30 06:11:23 +00002198}
Chris Lattner372dda82007-03-05 07:52:57 +00002199
Chris Lattnerf5990ed2004-11-14 04:24:28 +00002200/// isSafeStructAllocaToScalarRepl - Check to see if the specified allocation of
2201/// an aggregate can be broken down into elements. Return 0 if not, 3 if safe,
2202/// or 1 if safe after canonicalization has been performed.
Victor Hernandez6c146ee2010-01-21 23:05:53 +00002203bool SROA::isSafeAllocaToScalarRepl(AllocaInst *AI) {
Chris Lattner5e062a12003-05-30 04:15:41 +00002204 // Loop over the use list of the alloca. We can only transform it if all of
2205 // the users are safe to transform.
Chris Lattner6c95d242011-01-23 07:29:29 +00002206 AllocaInfo Info(AI);
Bob Wilson69743022011-01-13 20:59:44 +00002207
Chris Lattner6c95d242011-01-23 07:29:29 +00002208 isSafeForScalarRepl(AI, 0, Info);
Bob Wilsonb742def2009-12-18 20:14:40 +00002209 if (Info.isUnsafe) {
David Greene504c7d82010-01-05 01:27:09 +00002210 DEBUG(dbgs() << "Cannot transform: " << *AI << '\n');
Victor Hernandez6c146ee2010-01-21 23:05:53 +00002211 return false;
Chris Lattnerf5990ed2004-11-14 04:24:28 +00002212 }
Bob Wilson69743022011-01-13 20:59:44 +00002213
Chris Lattner39a1c042007-05-30 06:11:23 +00002214 // Okay, we know all the users are promotable. If the aggregate is a memcpy
2215 // source and destination, we have to be careful. In particular, the memcpy
2216 // could be moving around elements that live in structure padding of the LLVM
2217 // types, but may actually be used. In these cases, we refuse to promote the
2218 // struct.
2219 if (Info.isMemCpySrc && Info.isMemCpyDst &&
Bob Wilsonb742def2009-12-18 20:14:40 +00002220 HasPadding(AI->getAllocatedType(), *TD))
Victor Hernandez6c146ee2010-01-21 23:05:53 +00002221 return false;
Duncan Sands3cb36502007-11-04 14:43:57 +00002222
Chris Lattner396a0562011-01-16 17:46:19 +00002223 // If the alloca never has an access to just *part* of it, but is accessed
2224 // via loads and stores, then we should use ConvertToScalarInfo to promote
Chris Lattner7e9b4272011-01-16 06:18:28 +00002225 // the alloca instead of promoting each piece at a time and inserting fission
2226 // and fusion code.
2227 if (!Info.hasSubelementAccess && Info.hasALoadOrStore) {
2228 // If the struct/array just has one element, use basic SRoA.
2229 if (const StructType *ST = dyn_cast<StructType>(AI->getAllocatedType())) {
2230 if (ST->getNumElements() > 1) return false;
2231 } else {
2232 if (cast<ArrayType>(AI->getAllocatedType())->getNumElements() > 1)
2233 return false;
2234 }
2235 }
Chris Lattner145c5322011-01-23 08:27:54 +00002236
Victor Hernandez6c146ee2010-01-21 23:05:53 +00002237 return true;
Chris Lattner5e062a12003-05-30 04:15:41 +00002238}
Chris Lattnera1888942005-12-12 07:19:13 +00002239
Chris Lattner800de312008-02-29 07:03:13 +00002240
Chris Lattner79b3bd32007-04-25 06:40:51 +00002241
2242/// PointsToConstantGlobal - Return true if V (possibly indirectly) points to
2243/// some part of a constant global variable. This intentionally only accepts
2244/// constant expressions because we don't can't rewrite arbitrary instructions.
2245static bool PointsToConstantGlobal(Value *V) {
2246 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
2247 return GV->isConstant();
2248 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
Bob Wilson69743022011-01-13 20:59:44 +00002249 if (CE->getOpcode() == Instruction::BitCast ||
Chris Lattner79b3bd32007-04-25 06:40:51 +00002250 CE->getOpcode() == Instruction::GetElementPtr)
2251 return PointsToConstantGlobal(CE->getOperand(0));
2252 return false;
2253}
2254
2255/// isOnlyCopiedFromConstantGlobal - Recursively walk the uses of a (derived)
2256/// pointer to an alloca. Ignore any reads of the pointer, return false if we
2257/// see any stores or other unknown uses. If we see pointer arithmetic, keep
2258/// track of whether it moves the pointer (with isOffset) but otherwise traverse
2259/// the uses. If we see a memcpy/memmove that targets an unoffseted pointer to
Nick Lewycky081f8002010-11-24 22:04:20 +00002260/// the alloca, and if the source pointer is a pointer to a constant global, we
Chris Lattner79b3bd32007-04-25 06:40:51 +00002261/// can optimize this.
Chris Lattner31d80102010-04-15 21:59:20 +00002262static bool isOnlyCopiedFromConstantGlobal(Value *V, MemTransferInst *&TheCopy,
Chris Lattner79b3bd32007-04-25 06:40:51 +00002263 bool isOffset) {
2264 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI!=E; ++UI) {
Gabor Greif8a8a4352010-04-06 19:32:30 +00002265 User *U = cast<Instruction>(*UI);
2266
Chris Lattner2e618492010-11-18 06:20:47 +00002267 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattner6e733d32009-01-28 20:16:43 +00002268 // Ignore non-volatile loads, they are always ok.
Chris Lattner2e618492010-11-18 06:20:47 +00002269 if (LI->isVolatile()) return false;
2270 continue;
2271 }
Bob Wilson69743022011-01-13 20:59:44 +00002272
Gabor Greif8a8a4352010-04-06 19:32:30 +00002273 if (BitCastInst *BCI = dyn_cast<BitCastInst>(U)) {
Chris Lattner79b3bd32007-04-25 06:40:51 +00002274 // If uses of the bitcast are ok, we are ok.
2275 if (!isOnlyCopiedFromConstantGlobal(BCI, TheCopy, isOffset))
2276 return false;
2277 continue;
2278 }
Gabor Greif8a8a4352010-04-06 19:32:30 +00002279 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner79b3bd32007-04-25 06:40:51 +00002280 // If the GEP has all zero indices, it doesn't offset the pointer. If it
2281 // doesn't, it does.
2282 if (!isOnlyCopiedFromConstantGlobal(GEP, TheCopy,
2283 isOffset || !GEP->hasAllZeroIndices()))
2284 return false;
2285 continue;
2286 }
Bob Wilson69743022011-01-13 20:59:44 +00002287
Chris Lattner62480652010-11-18 06:41:51 +00002288 if (CallSite CS = U) {
2289 // If this is a readonly/readnone call site, then we know it is just a
2290 // load and we can ignore it.
Chris Lattnera9be1df2010-11-18 06:26:49 +00002291 if (CS.onlyReadsMemory())
2292 continue;
Nick Lewycky081f8002010-11-24 22:04:20 +00002293
2294 // If this is the function being called then we treat it like a load and
2295 // ignore it.
2296 if (CS.isCallee(UI))
2297 continue;
Bob Wilson69743022011-01-13 20:59:44 +00002298
Chris Lattner62480652010-11-18 06:41:51 +00002299 // If this is being passed as a byval argument, the caller is making a
2300 // copy, so it is only a read of the alloca.
2301 unsigned ArgNo = CS.getArgumentNo(UI);
2302 if (CS.paramHasAttr(ArgNo+1, Attribute::ByVal))
2303 continue;
2304 }
Bob Wilson69743022011-01-13 20:59:44 +00002305
Chris Lattner79b3bd32007-04-25 06:40:51 +00002306 // If this is isn't our memcpy/memmove, reject it as something we can't
2307 // handle.
Chris Lattner31d80102010-04-15 21:59:20 +00002308 MemTransferInst *MI = dyn_cast<MemTransferInst>(U);
2309 if (MI == 0)
Chris Lattner79b3bd32007-04-25 06:40:51 +00002310 return false;
Bob Wilson69743022011-01-13 20:59:44 +00002311
Chris Lattner2e618492010-11-18 06:20:47 +00002312 // If the transfer is using the alloca as a source of the transfer, then
Chris Lattner2e29ebd2010-11-18 07:32:33 +00002313 // ignore it since it is a load (unless the transfer is volatile).
Chris Lattner2e618492010-11-18 06:20:47 +00002314 if (UI.getOperandNo() == 1) {
2315 if (MI->isVolatile()) return false;
2316 continue;
2317 }
Chris Lattner79b3bd32007-04-25 06:40:51 +00002318
2319 // If we already have seen a copy, reject the second one.
2320 if (TheCopy) return false;
Bob Wilson69743022011-01-13 20:59:44 +00002321
Chris Lattner79b3bd32007-04-25 06:40:51 +00002322 // If the pointer has been offset from the start of the alloca, we can't
2323 // safely handle this.
2324 if (isOffset) return false;
2325
2326 // If the memintrinsic isn't using the alloca as the dest, reject it.
Gabor Greifa6aac4c2010-07-16 09:38:02 +00002327 if (UI.getOperandNo() != 0) return false;
Bob Wilson69743022011-01-13 20:59:44 +00002328
Chris Lattner79b3bd32007-04-25 06:40:51 +00002329 // If the source of the memcpy/move is not a constant global, reject it.
Chris Lattner31d80102010-04-15 21:59:20 +00002330 if (!PointsToConstantGlobal(MI->getSource()))
Chris Lattner79b3bd32007-04-25 06:40:51 +00002331 return false;
Bob Wilson69743022011-01-13 20:59:44 +00002332
Chris Lattner79b3bd32007-04-25 06:40:51 +00002333 // Otherwise, the transform is safe. Remember the copy instruction.
2334 TheCopy = MI;
2335 }
2336 return true;
2337}
2338
2339/// isOnlyCopiedFromConstantGlobal - Return true if the specified alloca is only
2340/// modified by a copy from a constant global. If we can prove this, we can
2341/// replace any uses of the alloca with uses of the global directly.
Chris Lattner31d80102010-04-15 21:59:20 +00002342MemTransferInst *SROA::isOnlyCopiedFromConstantGlobal(AllocaInst *AI) {
2343 MemTransferInst *TheCopy = 0;
Chris Lattner79b3bd32007-04-25 06:40:51 +00002344 if (::isOnlyCopiedFromConstantGlobal(AI, TheCopy, false))
2345 return TheCopy;
2346 return 0;
2347}