blob: 9f286b564227bf2933e0c98184038f172d458115 [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 Zwarichc8279392011-05-24 03:10:43 +000033#include "llvm/Analysis/DIBuilder.h"
Cameron Zwarichb1686c32011-01-18 03:53:26 +000034#include "llvm/Analysis/Dominators.h"
Chris Lattnerc87c50a2011-01-23 22:04:55 +000035#include "llvm/Analysis/Loads.h"
Dan Gohman5034dd32010-12-15 20:02:24 +000036#include "llvm/Analysis/ValueTracking.h"
Chris Lattner38aec322003-09-11 16:45:55 +000037#include "llvm/Target/TargetData.h"
38#include "llvm/Transforms/Utils/PromoteMemToReg.h"
Devang Patel4afc90d2009-02-10 07:00:59 +000039#include "llvm/Transforms/Utils/Local.h"
Chris Lattnere0a1a5b2011-01-14 07:50:47 +000040#include "llvm/Transforms/Utils/SSAUpdater.h"
Chris Lattnera9be1df2010-11-18 06:26:49 +000041#include "llvm/Support/CallSite.h"
Chris Lattner95255282006-06-28 23:17:24 +000042#include "llvm/Support/Debug.h"
Torok Edwin7d696d82009-07-11 13:10:19 +000043#include "llvm/Support/ErrorHandling.h"
Chris Lattnera1888942005-12-12 07:19:13 +000044#include "llvm/Support/GetElementPtrTypeIterator.h"
Chris Lattner65a65022009-02-03 19:41:50 +000045#include "llvm/Support/IRBuilder.h"
Chris Lattnera1888942005-12-12 07:19:13 +000046#include "llvm/Support/MathExtras.h"
Chris Lattnerbdff5482009-08-23 04:37:46 +000047#include "llvm/Support/raw_ostream.h"
Chris Lattnerc87c50a2011-01-23 22:04:55 +000048#include "llvm/ADT/SetVector.h"
Chris Lattner1ccd1852007-02-12 22:56:41 +000049#include "llvm/ADT/SmallVector.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000050#include "llvm/ADT/Statistic.h"
Chris Lattnerd8664732003-12-02 17:43:55 +000051using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000052
Chris Lattner0e5f4992006-12-19 21:40:18 +000053STATISTIC(NumReplaced, "Number of allocas broken up");
54STATISTIC(NumPromoted, "Number of allocas promoted");
Chris Lattnerc87c50a2011-01-23 22:04:55 +000055STATISTIC(NumAdjusted, "Number of scalar allocas adjusted to allow promotion");
Chris Lattner0e5f4992006-12-19 21:40:18 +000056STATISTIC(NumConverted, "Number of aggregates converted to scalar");
Chris Lattner79b3bd32007-04-25 06:40:51 +000057STATISTIC(NumGlobals, "Number of allocas copied from constant global");
Chris Lattnered7b41e2003-05-27 15:45:27 +000058
Chris Lattner0e5f4992006-12-19 21:40:18 +000059namespace {
Chris Lattner3e8b6632009-09-02 06:11:42 +000060 struct SROA : public FunctionPass {
Cameron Zwarichb1686c32011-01-18 03:53:26 +000061 SROA(int T, bool hasDT, char &ID)
62 : FunctionPass(ID), HasDomTree(hasDT) {
Devang Patelff366852007-07-09 21:19:23 +000063 if (T == -1)
Chris Lattnerb0e71ed2007-08-02 21:33:36 +000064 SRThreshold = 128;
Devang Patelff366852007-07-09 21:19:23 +000065 else
66 SRThreshold = T;
67 }
Devang Patel794fd752007-05-01 21:15:47 +000068
Chris Lattnered7b41e2003-05-27 15:45:27 +000069 bool runOnFunction(Function &F);
70
Chris Lattner38aec322003-09-11 16:45:55 +000071 bool performScalarRepl(Function &F);
72 bool performPromotion(Function &F);
73
Chris Lattnered7b41e2003-05-27 15:45:27 +000074 private:
Cameron Zwarichb1686c32011-01-18 03:53:26 +000075 bool HasDomTree;
Chris Lattner56c38522009-01-07 06:34:28 +000076 TargetData *TD;
Bob Wilson69743022011-01-13 20:59:44 +000077
Bob Wilsonb742def2009-12-18 20:14:40 +000078 /// DeadInsts - Keep track of instructions we have made dead, so that
79 /// we can remove them after we are done working.
80 SmallVector<Value*, 32> DeadInsts;
81
Chris Lattner39a1c042007-05-30 06:11:23 +000082 /// AllocaInfo - When analyzing uses of an alloca instruction, this captures
83 /// information about the uses. All these fields are initialized to false
84 /// and set to true when something is learned.
85 struct AllocaInfo {
Chris Lattner6c95d242011-01-23 07:29:29 +000086 /// The alloca to promote.
87 AllocaInst *AI;
88
Chris Lattner145c5322011-01-23 08:27:54 +000089 /// CheckedPHIs - This is a set of verified PHI nodes, to prevent infinite
90 /// looping and avoid redundant work.
91 SmallPtrSet<PHINode*, 8> CheckedPHIs;
92
Chris Lattner39a1c042007-05-30 06:11:23 +000093 /// isUnsafe - This is set to true if the alloca cannot be SROA'd.
94 bool isUnsafe : 1;
Bob Wilson69743022011-01-13 20:59:44 +000095
Chris Lattner39a1c042007-05-30 06:11:23 +000096 /// isMemCpySrc - This is true if this aggregate is memcpy'd from.
97 bool isMemCpySrc : 1;
98
Zhou Sheng33b0b8d2007-07-06 06:01:16 +000099 /// isMemCpyDst - This is true if this aggregate is memcpy'd into.
Chris Lattner39a1c042007-05-30 06:11:23 +0000100 bool isMemCpyDst : 1;
101
Chris Lattner7e9b4272011-01-16 06:18:28 +0000102 /// hasSubelementAccess - This is true if a subelement of the alloca is
103 /// ever accessed, or false if the alloca is only accessed with mem
104 /// intrinsics or load/store that only access the entire alloca at once.
105 bool hasSubelementAccess : 1;
106
107 /// hasALoadOrStore - This is true if there are any loads or stores to it.
108 /// The alloca may just be accessed with memcpy, for example, which would
109 /// not set this.
110 bool hasALoadOrStore : 1;
111
Chris Lattner6c95d242011-01-23 07:29:29 +0000112 explicit AllocaInfo(AllocaInst *ai)
113 : AI(ai), isUnsafe(false), isMemCpySrc(false), isMemCpyDst(false),
Chris Lattner7e9b4272011-01-16 06:18:28 +0000114 hasSubelementAccess(false), hasALoadOrStore(false) {}
Chris Lattner39a1c042007-05-30 06:11:23 +0000115 };
Bob Wilson69743022011-01-13 20:59:44 +0000116
Devang Patelff366852007-07-09 21:19:23 +0000117 unsigned SRThreshold;
118
Chris Lattnerd01a0da2011-01-23 07:05:44 +0000119 void MarkUnsafe(AllocaInfo &I, Instruction *User) {
120 I.isUnsafe = true;
121 DEBUG(dbgs() << " Transformation preventing inst: " << *User << '\n');
122 }
Chris Lattner39a1c042007-05-30 06:11:23 +0000123
Victor Hernandez6c146ee2010-01-21 23:05:53 +0000124 bool isSafeAllocaToScalarRepl(AllocaInst *AI);
Chris Lattner39a1c042007-05-30 06:11:23 +0000125
Chris Lattner6c95d242011-01-23 07:29:29 +0000126 void isSafeForScalarRepl(Instruction *I, uint64_t Offset, AllocaInfo &Info);
Chris Lattner145c5322011-01-23 08:27:54 +0000127 void isSafePHISelectUseForScalarRepl(Instruction *User, uint64_t Offset,
128 AllocaInfo &Info);
Chris Lattner6c95d242011-01-23 07:29:29 +0000129 void isSafeGEP(GetElementPtrInst *GEPI, uint64_t &Offset, AllocaInfo &Info);
130 void isSafeMemAccess(uint64_t Offset, uint64_t MemSize,
Chris Lattnerd01a0da2011-01-23 07:05:44 +0000131 const Type *MemOpType, bool isStore, AllocaInfo &Info,
Chris Lattner145c5322011-01-23 08:27:54 +0000132 Instruction *TheAccess, bool AllowWholeAccess);
Bob Wilsonb742def2009-12-18 20:14:40 +0000133 bool TypeHasComponent(const Type *T, uint64_t Offset, uint64_t Size);
Bob Wilsone88728d2009-12-19 06:53:17 +0000134 uint64_t FindElementAndOffset(const Type *&T, uint64_t &Offset,
135 const Type *&IdxTy);
Bob Wilson69743022011-01-13 20:59:44 +0000136
137 void DoScalarReplacement(AllocaInst *AI,
Victor Hernandez7b929da2009-10-23 21:09:37 +0000138 std::vector<AllocaInst*> &WorkList);
Bob Wilsonb742def2009-12-18 20:14:40 +0000139 void DeleteDeadInstructions();
Bob Wilson69743022011-01-13 20:59:44 +0000140
Bob Wilsonb742def2009-12-18 20:14:40 +0000141 void RewriteForScalarRepl(Instruction *I, AllocaInst *AI, uint64_t Offset,
142 SmallVector<AllocaInst*, 32> &NewElts);
143 void RewriteBitCast(BitCastInst *BC, AllocaInst *AI, uint64_t Offset,
144 SmallVector<AllocaInst*, 32> &NewElts);
145 void RewriteGEP(GetElementPtrInst *GEPI, AllocaInst *AI, uint64_t Offset,
146 SmallVector<AllocaInst*, 32> &NewElts);
147 void RewriteMemIntrinUserOfAlloca(MemIntrinsic *MI, Instruction *Inst,
Victor Hernandez7b929da2009-10-23 21:09:37 +0000148 AllocaInst *AI,
Chris Lattnerd93afec2009-01-07 07:18:45 +0000149 SmallVector<AllocaInst*, 32> &NewElts);
Victor Hernandez7b929da2009-10-23 21:09:37 +0000150 void RewriteStoreUserOfWholeAlloca(StoreInst *SI, AllocaInst *AI,
Chris Lattnerd2fa7812009-01-07 08:11:13 +0000151 SmallVector<AllocaInst*, 32> &NewElts);
Victor Hernandez7b929da2009-10-23 21:09:37 +0000152 void RewriteLoadUserOfWholeAlloca(LoadInst *LI, AllocaInst *AI,
Chris Lattner6e733d32009-01-28 20:16:43 +0000153 SmallVector<AllocaInst*, 32> &NewElts);
Bob Wilson69743022011-01-13 20:59:44 +0000154
Chris Lattner31d80102010-04-15 21:59:20 +0000155 static MemTransferInst *isOnlyCopiedFromConstantGlobal(AllocaInst *AI);
Chris Lattnered7b41e2003-05-27 15:45:27 +0000156 };
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000157
Cameron Zwarichb1686c32011-01-18 03:53:26 +0000158 // SROA_DT - SROA that uses DominatorTree.
159 struct SROA_DT : public SROA {
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000160 static char ID;
161 public:
Cameron Zwarichb1686c32011-01-18 03:53:26 +0000162 SROA_DT(int T = -1) : SROA(T, true, ID) {
163 initializeSROA_DTPass(*PassRegistry::getPassRegistry());
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000164 }
165
166 // getAnalysisUsage - This pass does not require any passes, but we know it
167 // will not alter the CFG, so say so.
168 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
169 AU.addRequired<DominatorTree>();
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000170 AU.setPreservesCFG();
171 }
172 };
173
174 // SROA_SSAUp - SROA that uses SSAUpdater.
175 struct SROA_SSAUp : public SROA {
176 static char ID;
177 public:
178 SROA_SSAUp(int T = -1) : SROA(T, false, ID) {
179 initializeSROA_SSAUpPass(*PassRegistry::getPassRegistry());
180 }
181
182 // getAnalysisUsage - This pass does not require any passes, but we know it
183 // will not alter the CFG, so say so.
184 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
185 AU.setPreservesCFG();
186 }
187 };
188
Chris Lattnered7b41e2003-05-27 15:45:27 +0000189}
190
Cameron Zwarichb1686c32011-01-18 03:53:26 +0000191char SROA_DT::ID = 0;
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000192char SROA_SSAUp::ID = 0;
193
Cameron Zwarichb1686c32011-01-18 03:53:26 +0000194INITIALIZE_PASS_BEGIN(SROA_DT, "scalarrepl",
195 "Scalar Replacement of Aggregates (DT)", false, false)
Owen Anderson2ab36d32010-10-12 19:48:12 +0000196INITIALIZE_PASS_DEPENDENCY(DominatorTree)
Cameron Zwarichb1686c32011-01-18 03:53:26 +0000197INITIALIZE_PASS_END(SROA_DT, "scalarrepl",
198 "Scalar Replacement of Aggregates (DT)", false, false)
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000199
200INITIALIZE_PASS_BEGIN(SROA_SSAUp, "scalarrepl-ssa",
201 "Scalar Replacement of Aggregates (SSAUp)", false, false)
202INITIALIZE_PASS_END(SROA_SSAUp, "scalarrepl-ssa",
203 "Scalar Replacement of Aggregates (SSAUp)", false, false)
Dan Gohman844731a2008-05-13 00:00:25 +0000204
Brian Gaeked0fde302003-11-11 22:41:34 +0000205// Public interface to the ScalarReplAggregates pass
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000206FunctionPass *llvm::createScalarReplAggregatesPass(int Threshold,
Cameron Zwarichb1686c32011-01-18 03:53:26 +0000207 bool UseDomTree) {
208 if (UseDomTree)
209 return new SROA_DT(Threshold);
Chris Lattnerb352d6e2011-01-14 08:13:00 +0000210 return new SROA_SSAUp(Threshold);
Devang Patelff366852007-07-09 21:19:23 +0000211}
Chris Lattnered7b41e2003-05-27 15:45:27 +0000212
213
Chris Lattner4cc576b2010-04-16 00:24:57 +0000214//===----------------------------------------------------------------------===//
215// Convert To Scalar Optimization.
216//===----------------------------------------------------------------------===//
217
218namespace {
Chris Lattnera001b662010-04-16 00:38:19 +0000219/// ConvertToScalarInfo - This class implements the "Convert To Scalar"
220/// optimization, which scans the uses of an alloca and determines if it can
221/// rewrite it in terms of a single new alloca that can be mem2reg'd.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000222class ConvertToScalarInfo {
Cameron Zwarichd4c9c3e2011-03-16 00:13:35 +0000223 /// AllocaSize - The size of the alloca being considered in bytes.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000224 unsigned AllocaSize;
225 const TargetData &TD;
Bob Wilson69743022011-01-13 20:59:44 +0000226
Chris Lattnera0bada72010-04-16 02:32:17 +0000227 /// IsNotTrivial - This is set to true if there is some access to the object
Chris Lattnera001b662010-04-16 00:38:19 +0000228 /// which means that mem2reg can't promote it.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000229 bool IsNotTrivial;
Bob Wilson69743022011-01-13 20:59:44 +0000230
Chris Lattnera001b662010-04-16 00:38:19 +0000231 /// VectorTy - This tracks the type that we should promote the vector to if
232 /// it is possible to turn it into a vector. This starts out null, and if it
233 /// isn't possible to turn into a vector type, it gets set to VoidTy.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000234 const Type *VectorTy;
Bob Wilson69743022011-01-13 20:59:44 +0000235
Chris Lattnera001b662010-04-16 00:38:19 +0000236 /// HadAVector - True if there is at least one vector access to the alloca.
237 /// We don't want to turn random arrays into vectors and use vector element
238 /// insert/extract, but if there are element accesses to something that is
239 /// also declared as a vector, we do want to promote to a vector.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000240 bool HadAVector;
241
Cameron Zwarich1bcdb6f2011-03-16 08:13:42 +0000242 /// HadNonMemTransferAccess - True if there is at least one access to the
243 /// alloca that is not a MemTransferInst. We don't want to turn structs into
244 /// large integers unless there is some potential for optimization.
Cameron Zwarich85b0f462011-03-16 00:13:44 +0000245 bool HadNonMemTransferAccess;
246
Chris Lattner4cc576b2010-04-16 00:24:57 +0000247public:
248 explicit ConvertToScalarInfo(unsigned Size, const TargetData &td)
Cameron Zwarichdeac2682011-03-16 00:13:37 +0000249 : AllocaSize(Size), TD(td), IsNotTrivial(false), VectorTy(0),
Cameron Zwarich85b0f462011-03-16 00:13:44 +0000250 HadAVector(false), HadNonMemTransferAccess(false) { }
Bob Wilson69743022011-01-13 20:59:44 +0000251
Chris Lattnera001b662010-04-16 00:38:19 +0000252 AllocaInst *TryConvert(AllocaInst *AI);
Bob Wilson69743022011-01-13 20:59:44 +0000253
Chris Lattner4cc576b2010-04-16 00:24:57 +0000254private:
255 bool CanConvertToScalar(Value *V, uint64_t Offset);
Cameron Zwarich9827b782011-03-29 05:19:52 +0000256 void MergeInType(const Type *In, uint64_t Offset, bool IsLoadOrStore);
Cameron Zwarichc9ecd142011-03-09 05:43:01 +0000257 bool MergeInVectorType(const VectorType *VInTy, uint64_t Offset);
Chris Lattner4cc576b2010-04-16 00:24:57 +0000258 void ConvertUsesToScalar(Value *Ptr, AllocaInst *NewAI, uint64_t Offset);
Bob Wilson69743022011-01-13 20:59:44 +0000259
Chris Lattner4cc576b2010-04-16 00:24:57 +0000260 Value *ConvertScalar_ExtractValue(Value *NV, const Type *ToType,
261 uint64_t Offset, IRBuilder<> &Builder);
262 Value *ConvertScalar_InsertValue(Value *StoredVal, Value *ExistingVal,
263 uint64_t Offset, IRBuilder<> &Builder);
264};
265} // end anonymous namespace.
266
Chris Lattner91abace2010-09-01 05:14:33 +0000267
Chris Lattnera001b662010-04-16 00:38:19 +0000268/// TryConvert - Analyze the specified alloca, and if it is safe to do so,
269/// rewrite it to be a new alloca which is mem2reg'able. This returns the new
270/// alloca if possible or null if not.
271AllocaInst *ConvertToScalarInfo::TryConvert(AllocaInst *AI) {
272 // If we can't convert this scalar, or if mem2reg can trivially do it, bail
273 // out.
274 if (!CanConvertToScalar(AI, 0) || !IsNotTrivial)
275 return 0;
Bob Wilson69743022011-01-13 20:59:44 +0000276
Chris Lattnera001b662010-04-16 00:38:19 +0000277 // If we were able to find a vector type that can handle this with
278 // insert/extract elements, and if there was at least one use that had
279 // a vector type, promote this to a vector. We don't want to promote
280 // random stuff that doesn't use vectors (e.g. <9 x double>) because then
281 // we just get a lot of insert/extracts. If at least one vector is
282 // involved, then we probably really do have a union of vector/array.
283 const Type *NewTy;
Chris Lattner85a7c692011-01-23 06:40:33 +0000284 if (VectorTy && VectorTy->isVectorTy() && HadAVector) {
Chris Lattnera001b662010-04-16 00:38:19 +0000285 DEBUG(dbgs() << "CONVERT TO VECTOR: " << *AI << "\n TYPE = "
286 << *VectorTy << '\n');
287 NewTy = VectorTy; // Use the vector type.
288 } else {
Cameron Zwarich85b0f462011-03-16 00:13:44 +0000289 unsigned BitWidth = AllocaSize * 8;
290 if (!HadAVector && !HadNonMemTransferAccess &&
291 !TD.fitsInLegalInteger(BitWidth))
292 return 0;
293
Chris Lattnera001b662010-04-16 00:38:19 +0000294 DEBUG(dbgs() << "CONVERT TO SCALAR INTEGER: " << *AI << "\n");
295 // Create and insert the integer alloca.
Cameron Zwarich85b0f462011-03-16 00:13:44 +0000296 NewTy = IntegerType::get(AI->getContext(), BitWidth);
Chris Lattnera001b662010-04-16 00:38:19 +0000297 }
298 AllocaInst *NewAI = new AllocaInst(NewTy, 0, "", AI->getParent()->begin());
299 ConvertUsesToScalar(AI, NewAI, 0);
300 return NewAI;
301}
302
303/// MergeInType - Add the 'In' type to the accumulated vector type (VectorTy)
304/// so far at the offset specified by Offset (which is specified in bytes).
Chris Lattner4cc576b2010-04-16 00:24:57 +0000305///
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000306/// There are three cases we handle here:
Chris Lattner4cc576b2010-04-16 00:24:57 +0000307/// 1) A union of vector types of the same size and potentially its elements.
308/// Here we turn element accesses into insert/extract element operations.
309/// This promotes a <4 x float> with a store of float to the third element
310/// into a <4 x float> that uses insert element.
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000311/// 2) A union of vector types with power-of-2 size differences, e.g. a float,
312/// <2 x float> and <4 x float>. Here we turn element accesses into insert
313/// and extract element operations, and <2 x float> accesses into a cast to
314/// <2 x double>, an extract, and a cast back to <2 x float>.
315/// 3) A fully general blob of memory, which we turn into some (potentially
Chris Lattner4cc576b2010-04-16 00:24:57 +0000316/// large) integer type with extract and insert operations where the loads
Chris Lattnera001b662010-04-16 00:38:19 +0000317/// and stores would mutate the memory. We mark this by setting VectorTy
318/// to VoidTy.
Cameron Zwarich9827b782011-03-29 05:19:52 +0000319void ConvertToScalarInfo::MergeInType(const Type *In, uint64_t Offset,
320 bool IsLoadOrStore) {
Chris Lattnera001b662010-04-16 00:38:19 +0000321 // If we already decided to turn this into a blob of integer memory, there is
322 // nothing to be done.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000323 if (VectorTy && VectorTy->isVoidTy())
324 return;
Bob Wilson69743022011-01-13 20:59:44 +0000325
Chris Lattner4cc576b2010-04-16 00:24:57 +0000326 // If this could be contributing to a vector, analyze it.
327
328 // If the In type is a vector that is the same size as the alloca, see if it
329 // matches the existing VecTy.
330 if (const VectorType *VInTy = dyn_cast<VectorType>(In)) {
Cameron Zwarichc9ecd142011-03-09 05:43:01 +0000331 if (MergeInVectorType(VInTy, Offset))
Chris Lattner4cc576b2010-04-16 00:24:57 +0000332 return;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000333 } else if (In->isFloatTy() || In->isDoubleTy() ||
334 (In->isIntegerTy() && In->getPrimitiveSizeInBits() >= 8 &&
335 isPowerOf2_32(In->getPrimitiveSizeInBits()))) {
Cameron Zwarich9827b782011-03-29 05:19:52 +0000336 // Full width accesses can be ignored, because they can always be turned
337 // into bitcasts.
338 unsigned EltSize = In->getPrimitiveSizeInBits()/8;
339 if (IsLoadOrStore && EltSize == AllocaSize)
340 return;
Cameron Zwarich5fc12822011-04-20 21:48:16 +0000341
Chris Lattner4cc576b2010-04-16 00:24:57 +0000342 // If we're accessing something that could be an element of a vector, see
343 // if the implied vector agrees with what we already have and if Offset is
344 // compatible with it.
Cameron Zwarich5fc12822011-04-20 21:48:16 +0000345 if (Offset % EltSize == 0 && AllocaSize % EltSize == 0) {
346 if (!VectorTy) {
Chris Lattner4cc576b2010-04-16 00:24:57 +0000347 VectorTy = VectorType::get(In, AllocaSize/EltSize);
Cameron Zwarich5fc12822011-04-20 21:48:16 +0000348 return;
349 }
350
351 unsigned CurrentEltSize = cast<VectorType>(VectorTy)->getElementType()
352 ->getPrimitiveSizeInBits()/8;
353 if (EltSize == CurrentEltSize)
354 return;
Cameron Zwarich344731c2011-04-20 21:48:38 +0000355
356 if (In->isIntegerTy() && isPowerOf2_32(AllocaSize / EltSize))
357 return;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000358 }
359 }
Bob Wilson69743022011-01-13 20:59:44 +0000360
Chris Lattner4cc576b2010-04-16 00:24:57 +0000361 // Otherwise, we have a case that we can't handle with an optimized vector
362 // form. We can still turn this into a large integer.
363 VectorTy = Type::getVoidTy(In->getContext());
364}
365
Cameron Zwarichc9ecd142011-03-09 05:43:01 +0000366/// MergeInVectorType - Handles the vector case of MergeInType, returning true
367/// if the type was successfully merged and false otherwise.
368bool ConvertToScalarInfo::MergeInVectorType(const VectorType *VInTy,
369 uint64_t Offset) {
370 // Remember if we saw a vector type.
371 HadAVector = true;
372
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000373 // TODO: Support nonzero offsets?
374 if (Offset != 0)
375 return false;
376
377 // Only allow vectors that are a power-of-2 away from the size of the alloca.
378 if (!isPowerOf2_64(AllocaSize / (VInTy->getBitWidth() / 8)))
379 return false;
380
381 // If this the first vector we see, remember the type so that we know the
382 // element size.
383 if (!VectorTy) {
384 VectorTy = VInTy;
Cameron Zwarichc9ecd142011-03-09 05:43:01 +0000385 return true;
386 }
387
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000388 unsigned BitWidth = cast<VectorType>(VectorTy)->getBitWidth();
389 unsigned InBitWidth = VInTy->getBitWidth();
390
391 // Vectors of the same size can be converted using a simple bitcast.
392 if (InBitWidth == BitWidth && AllocaSize == (InBitWidth / 8))
393 return true;
394
395 const Type *ElementTy = cast<VectorType>(VectorTy)->getElementType();
Cameron Zwarichc77a10f2011-03-26 04:58:50 +0000396 const Type *InElementTy = cast<VectorType>(VInTy)->getElementType();
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000397
398 // Do not allow mixed integer and floating-point accesses from vectors of
399 // different sizes.
400 if (ElementTy->isFloatingPointTy() != InElementTy->isFloatingPointTy())
401 return false;
402
403 if (ElementTy->isFloatingPointTy()) {
404 // Only allow floating-point vectors of different sizes if they have the
405 // same element type.
406 // TODO: This could be loosened a bit, but would anything benefit?
407 if (ElementTy != InElementTy)
408 return false;
409
410 // There are no arbitrary-precision floating-point types, which limits the
411 // number of legal vector types with larger element types that we can form
412 // to bitcast and extract a subvector.
413 // TODO: We could support some more cases with mixed fp128 and double here.
414 if (!(BitWidth == 64 || BitWidth == 128) ||
415 !(InBitWidth == 64 || InBitWidth == 128))
416 return false;
417 } else {
418 assert(ElementTy->isIntegerTy() && "Vector elements must be either integer "
419 "or floating-point.");
420 unsigned BitWidth = ElementTy->getPrimitiveSizeInBits();
421 unsigned InBitWidth = InElementTy->getPrimitiveSizeInBits();
422
423 // Do not allow integer types smaller than a byte or types whose widths are
424 // not a multiple of a byte.
425 if (BitWidth < 8 || InBitWidth < 8 ||
426 BitWidth % 8 != 0 || InBitWidth % 8 != 0)
427 return false;
428 }
429
430 // Pick the largest of the two vector types.
431 if (InBitWidth > BitWidth)
432 VectorTy = VInTy;
433
434 return true;
Cameron Zwarichc9ecd142011-03-09 05:43:01 +0000435}
436
Chris Lattner4cc576b2010-04-16 00:24:57 +0000437/// CanConvertToScalar - V is a pointer. If we can convert the pointee and all
438/// its accesses to a single vector type, return true and set VecTy to
439/// the new type. If we could convert the alloca into a single promotable
440/// integer, return true but set VecTy to VoidTy. Further, if the use is not a
441/// completely trivial use that mem2reg could promote, set IsNotTrivial. Offset
442/// is the current offset from the base of the alloca being analyzed.
443///
444/// If we see at least one access to the value that is as a vector type, set the
445/// SawVec flag.
446bool ConvertToScalarInfo::CanConvertToScalar(Value *V, uint64_t Offset) {
447 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI!=E; ++UI) {
448 Instruction *User = cast<Instruction>(*UI);
Bob Wilson69743022011-01-13 20:59:44 +0000449
Chris Lattner4cc576b2010-04-16 00:24:57 +0000450 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
451 // Don't break volatile loads.
452 if (LI->isVolatile())
453 return false;
Dale Johannesen0488fb62010-09-30 23:57:10 +0000454 // Don't touch MMX operations.
455 if (LI->getType()->isX86_MMXTy())
456 return false;
Cameron Zwarich85b0f462011-03-16 00:13:44 +0000457 HadNonMemTransferAccess = true;
Cameron Zwarich9827b782011-03-29 05:19:52 +0000458 MergeInType(LI->getType(), Offset, true);
Chris Lattner4cc576b2010-04-16 00:24:57 +0000459 continue;
460 }
Bob Wilson69743022011-01-13 20:59:44 +0000461
Chris Lattner4cc576b2010-04-16 00:24:57 +0000462 if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
463 // Storing the pointer, not into the value?
464 if (SI->getOperand(0) == V || SI->isVolatile()) return false;
Dale Johannesen0488fb62010-09-30 23:57:10 +0000465 // Don't touch MMX operations.
466 if (SI->getOperand(0)->getType()->isX86_MMXTy())
467 return false;
Cameron Zwarich85b0f462011-03-16 00:13:44 +0000468 HadNonMemTransferAccess = true;
Cameron Zwarich9827b782011-03-29 05:19:52 +0000469 MergeInType(SI->getOperand(0)->getType(), Offset, true);
Chris Lattner4cc576b2010-04-16 00:24:57 +0000470 continue;
471 }
Bob Wilson69743022011-01-13 20:59:44 +0000472
Chris Lattner4cc576b2010-04-16 00:24:57 +0000473 if (BitCastInst *BCI = dyn_cast<BitCastInst>(User)) {
Chris Lattnera001b662010-04-16 00:38:19 +0000474 IsNotTrivial = true; // Can't be mem2reg'd.
Chris Lattner4cc576b2010-04-16 00:24:57 +0000475 if (!CanConvertToScalar(BCI, Offset))
476 return false;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000477 continue;
478 }
479
480 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(User)) {
481 // If this is a GEP with a variable indices, we can't handle it.
482 if (!GEP->hasAllConstantIndices())
483 return false;
Bob Wilson69743022011-01-13 20:59:44 +0000484
Chris Lattner4cc576b2010-04-16 00:24:57 +0000485 // Compute the offset that this GEP adds to the pointer.
486 SmallVector<Value*, 8> Indices(GEP->op_begin()+1, GEP->op_end());
487 uint64_t GEPOffset = TD.getIndexedOffset(GEP->getPointerOperandType(),
488 &Indices[0], Indices.size());
489 // See if all uses can be converted.
490 if (!CanConvertToScalar(GEP, Offset+GEPOffset))
491 return false;
Chris Lattnera001b662010-04-16 00:38:19 +0000492 IsNotTrivial = true; // Can't be mem2reg'd.
Cameron Zwarich85b0f462011-03-16 00:13:44 +0000493 HadNonMemTransferAccess = true;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000494 continue;
495 }
496
497 // If this is a constant sized memset of a constant value (e.g. 0) we can
498 // handle it.
499 if (MemSetInst *MSI = dyn_cast<MemSetInst>(User)) {
500 // Store of constant value and constant size.
Chris Lattnera001b662010-04-16 00:38:19 +0000501 if (!isa<ConstantInt>(MSI->getValue()) ||
502 !isa<ConstantInt>(MSI->getLength()))
503 return false;
504 IsNotTrivial = true; // Can't be mem2reg'd.
Cameron Zwarich85b0f462011-03-16 00:13:44 +0000505 HadNonMemTransferAccess = true;
Chris Lattnera001b662010-04-16 00:38:19 +0000506 continue;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000507 }
508
509 // If this is a memcpy or memmove into or out of the whole allocation, we
510 // can handle it like a load or store of the scalar type.
511 if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(User)) {
Chris Lattnera001b662010-04-16 00:38:19 +0000512 ConstantInt *Len = dyn_cast<ConstantInt>(MTI->getLength());
513 if (Len == 0 || Len->getZExtValue() != AllocaSize || Offset != 0)
514 return false;
Bob Wilson69743022011-01-13 20:59:44 +0000515
Chris Lattnera001b662010-04-16 00:38:19 +0000516 IsNotTrivial = true; // Can't be mem2reg'd.
517 continue;
Chris Lattner4cc576b2010-04-16 00:24:57 +0000518 }
Bob Wilson69743022011-01-13 20:59:44 +0000519
Chris Lattner4cc576b2010-04-16 00:24:57 +0000520 // Otherwise, we cannot handle this!
521 return false;
522 }
Bob Wilson69743022011-01-13 20:59:44 +0000523
Chris Lattner4cc576b2010-04-16 00:24:57 +0000524 return true;
525}
526
527/// ConvertUsesToScalar - Convert all of the users of Ptr to use the new alloca
528/// directly. This happens when we are converting an "integer union" to a
529/// single integer scalar, or when we are converting a "vector union" to a
530/// vector with insert/extractelement instructions.
531///
532/// Offset is an offset from the original alloca, in bits that need to be
533/// shifted to the right. By the end of this, there should be no uses of Ptr.
534void ConvertToScalarInfo::ConvertUsesToScalar(Value *Ptr, AllocaInst *NewAI,
535 uint64_t Offset) {
536 while (!Ptr->use_empty()) {
537 Instruction *User = cast<Instruction>(Ptr->use_back());
538
539 if (BitCastInst *CI = dyn_cast<BitCastInst>(User)) {
540 ConvertUsesToScalar(CI, NewAI, Offset);
541 CI->eraseFromParent();
542 continue;
543 }
544
545 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(User)) {
546 // Compute the offset that this GEP adds to the pointer.
547 SmallVector<Value*, 8> Indices(GEP->op_begin()+1, GEP->op_end());
548 uint64_t GEPOffset = TD.getIndexedOffset(GEP->getPointerOperandType(),
549 &Indices[0], Indices.size());
550 ConvertUsesToScalar(GEP, NewAI, Offset+GEPOffset*8);
551 GEP->eraseFromParent();
552 continue;
553 }
Bob Wilson69743022011-01-13 20:59:44 +0000554
Chris Lattner61db1f52010-12-26 22:57:41 +0000555 IRBuilder<> Builder(User);
Bob Wilson69743022011-01-13 20:59:44 +0000556
Chris Lattner4cc576b2010-04-16 00:24:57 +0000557 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
558 // The load is a bit extract from NewAI shifted right by Offset bits.
559 Value *LoadedVal = Builder.CreateLoad(NewAI, "tmp");
560 Value *NewLoadVal
561 = ConvertScalar_ExtractValue(LoadedVal, LI->getType(), Offset, Builder);
562 LI->replaceAllUsesWith(NewLoadVal);
563 LI->eraseFromParent();
564 continue;
565 }
Bob Wilson69743022011-01-13 20:59:44 +0000566
Chris Lattner4cc576b2010-04-16 00:24:57 +0000567 if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
568 assert(SI->getOperand(0) != Ptr && "Consistency error!");
569 Instruction *Old = Builder.CreateLoad(NewAI, NewAI->getName()+".in");
570 Value *New = ConvertScalar_InsertValue(SI->getOperand(0), Old, Offset,
571 Builder);
572 Builder.CreateStore(New, NewAI);
573 SI->eraseFromParent();
Bob Wilson69743022011-01-13 20:59:44 +0000574
Chris Lattner4cc576b2010-04-16 00:24:57 +0000575 // If the load we just inserted is now dead, then the inserted store
576 // overwrote the entire thing.
577 if (Old->use_empty())
578 Old->eraseFromParent();
579 continue;
580 }
Bob Wilson69743022011-01-13 20:59:44 +0000581
Chris Lattner4cc576b2010-04-16 00:24:57 +0000582 // If this is a constant sized memset of a constant value (e.g. 0) we can
583 // transform it into a store of the expanded constant value.
584 if (MemSetInst *MSI = dyn_cast<MemSetInst>(User)) {
585 assert(MSI->getRawDest() == Ptr && "Consistency error!");
586 unsigned NumBytes = cast<ConstantInt>(MSI->getLength())->getZExtValue();
587 if (NumBytes != 0) {
588 unsigned Val = cast<ConstantInt>(MSI->getValue())->getZExtValue();
Bob Wilson69743022011-01-13 20:59:44 +0000589
Chris Lattner4cc576b2010-04-16 00:24:57 +0000590 // Compute the value replicated the right number of times.
591 APInt APVal(NumBytes*8, Val);
592
593 // Splat the value if non-zero.
594 if (Val)
595 for (unsigned i = 1; i != NumBytes; ++i)
596 APVal |= APVal << 8;
Bob Wilson69743022011-01-13 20:59:44 +0000597
Chris Lattner4cc576b2010-04-16 00:24:57 +0000598 Instruction *Old = Builder.CreateLoad(NewAI, NewAI->getName()+".in");
599 Value *New = ConvertScalar_InsertValue(
600 ConstantInt::get(User->getContext(), APVal),
601 Old, Offset, Builder);
602 Builder.CreateStore(New, NewAI);
Bob Wilson69743022011-01-13 20:59:44 +0000603
Chris Lattner4cc576b2010-04-16 00:24:57 +0000604 // If the load we just inserted is now dead, then the memset overwrote
605 // the entire thing.
606 if (Old->use_empty())
Bob Wilson69743022011-01-13 20:59:44 +0000607 Old->eraseFromParent();
Chris Lattner4cc576b2010-04-16 00:24:57 +0000608 }
609 MSI->eraseFromParent();
610 continue;
611 }
612
613 // If this is a memcpy or memmove into or out of the whole allocation, we
614 // can handle it like a load or store of the scalar type.
615 if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(User)) {
616 assert(Offset == 0 && "must be store to start of alloca");
Bob Wilson69743022011-01-13 20:59:44 +0000617
Chris Lattner4cc576b2010-04-16 00:24:57 +0000618 // If the source and destination are both to the same alloca, then this is
619 // a noop copy-to-self, just delete it. Otherwise, emit a load and store
620 // as appropriate.
Dan Gohmanbd1801b2011-01-24 18:53:32 +0000621 AllocaInst *OrigAI = cast<AllocaInst>(GetUnderlyingObject(Ptr, &TD, 0));
Bob Wilson69743022011-01-13 20:59:44 +0000622
Dan Gohmanbd1801b2011-01-24 18:53:32 +0000623 if (GetUnderlyingObject(MTI->getSource(), &TD, 0) != OrigAI) {
Chris Lattner4cc576b2010-04-16 00:24:57 +0000624 // Dest must be OrigAI, change this to be a load from the original
625 // pointer (bitcasted), then a store to our new alloca.
626 assert(MTI->getRawDest() == Ptr && "Neither use is of pointer?");
627 Value *SrcPtr = MTI->getSource();
Mon P Wange90a6332010-12-23 01:41:32 +0000628 const PointerType* SPTy = cast<PointerType>(SrcPtr->getType());
629 const PointerType* AIPTy = cast<PointerType>(NewAI->getType());
630 if (SPTy->getAddressSpace() != AIPTy->getAddressSpace()) {
631 AIPTy = PointerType::get(AIPTy->getElementType(),
632 SPTy->getAddressSpace());
633 }
634 SrcPtr = Builder.CreateBitCast(SrcPtr, AIPTy);
635
Chris Lattner4cc576b2010-04-16 00:24:57 +0000636 LoadInst *SrcVal = Builder.CreateLoad(SrcPtr, "srcval");
637 SrcVal->setAlignment(MTI->getAlignment());
638 Builder.CreateStore(SrcVal, NewAI);
Dan Gohmanbd1801b2011-01-24 18:53:32 +0000639 } else if (GetUnderlyingObject(MTI->getDest(), &TD, 0) != OrigAI) {
Chris Lattner4cc576b2010-04-16 00:24:57 +0000640 // Src must be OrigAI, change this to be a load from NewAI then a store
641 // through the original dest pointer (bitcasted).
642 assert(MTI->getRawSource() == Ptr && "Neither use is of pointer?");
643 LoadInst *SrcVal = Builder.CreateLoad(NewAI, "srcval");
644
Mon P Wange90a6332010-12-23 01:41:32 +0000645 const PointerType* DPTy = cast<PointerType>(MTI->getDest()->getType());
646 const PointerType* AIPTy = cast<PointerType>(NewAI->getType());
647 if (DPTy->getAddressSpace() != AIPTy->getAddressSpace()) {
648 AIPTy = PointerType::get(AIPTy->getElementType(),
649 DPTy->getAddressSpace());
650 }
651 Value *DstPtr = Builder.CreateBitCast(MTI->getDest(), AIPTy);
652
Chris Lattner4cc576b2010-04-16 00:24:57 +0000653 StoreInst *NewStore = Builder.CreateStore(SrcVal, DstPtr);
654 NewStore->setAlignment(MTI->getAlignment());
655 } else {
656 // Noop transfer. Src == Dst
657 }
658
659 MTI->eraseFromParent();
660 continue;
661 }
Bob Wilson69743022011-01-13 20:59:44 +0000662
Chris Lattner4cc576b2010-04-16 00:24:57 +0000663 llvm_unreachable("Unsupported operation!");
664 }
665}
666
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000667/// getScaledElementType - Gets a scaled element type for a partial vector
Cameron Zwarich344731c2011-04-20 21:48:38 +0000668/// access of an alloca. The input types must be integer or floating-point
669/// scalar or vector types, and the resulting type is an integer, float or
670/// double.
671static const Type *getScaledElementType(const Type *Ty1, const Type *Ty2,
Cameron Zwarich1537ce72011-03-23 05:25:55 +0000672 unsigned NewBitWidth) {
Cameron Zwarich344731c2011-04-20 21:48:38 +0000673 bool IsFP1 = Ty1->isFloatingPointTy() ||
674 (Ty1->isVectorTy() &&
675 cast<VectorType>(Ty1)->getElementType()->isFloatingPointTy());
676 bool IsFP2 = Ty2->isFloatingPointTy() ||
677 (Ty2->isVectorTy() &&
678 cast<VectorType>(Ty2)->getElementType()->isFloatingPointTy());
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000679
Cameron Zwarich344731c2011-04-20 21:48:38 +0000680 LLVMContext &Context = Ty1->getContext();
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000681
Cameron Zwarich344731c2011-04-20 21:48:38 +0000682 // Prefer floating-point types over integer types, as integer types may have
683 // been created by earlier scalar replacement.
684 if (IsFP1 || IsFP2) {
685 if (NewBitWidth == 32)
686 return Type::getFloatTy(Context);
687 if (NewBitWidth == 64)
688 return Type::getDoubleTy(Context);
689 }
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000690
Cameron Zwarich344731c2011-04-20 21:48:38 +0000691 return Type::getIntNTy(Context, NewBitWidth);
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000692}
693
Mon P Wangddf9abf2011-04-14 08:04:01 +0000694/// CreateShuffleVectorCast - Creates a shuffle vector to convert one vector
695/// to another vector of the same element type which has the same allocation
696/// size but different primitive sizes (e.g. <3 x i32> and <4 x i32>).
697static Value *CreateShuffleVectorCast(Value *FromVal, const Type *ToType,
698 IRBuilder<> &Builder) {
699 const Type *FromType = FromVal->getType();
Mon P Wang481823a2011-04-14 19:20:42 +0000700 const VectorType *FromVTy = cast<VectorType>(FromType);
701 const VectorType *ToVTy = cast<VectorType>(ToType);
702 assert((ToVTy->getElementType() == FromVTy->getElementType()) &&
Mon P Wangddf9abf2011-04-14 08:04:01 +0000703 "Vectors must have the same element type");
Mon P Wangddf9abf2011-04-14 08:04:01 +0000704 Value *UnV = UndefValue::get(FromType);
705 unsigned numEltsFrom = FromVTy->getNumElements();
706 unsigned numEltsTo = ToVTy->getNumElements();
707
708 SmallVector<Constant*, 3> Args;
Mon P Wang481823a2011-04-14 19:20:42 +0000709 const Type* Int32Ty = Builder.getInt32Ty();
Mon P Wangddf9abf2011-04-14 08:04:01 +0000710 unsigned minNumElts = std::min(numEltsFrom, numEltsTo);
711 unsigned i;
712 for (i=0; i != minNumElts; ++i)
Mon P Wang481823a2011-04-14 19:20:42 +0000713 Args.push_back(ConstantInt::get(Int32Ty, i));
Mon P Wangddf9abf2011-04-14 08:04:01 +0000714
715 if (i < numEltsTo) {
Mon P Wang481823a2011-04-14 19:20:42 +0000716 Constant* UnC = UndefValue::get(Int32Ty);
Mon P Wangddf9abf2011-04-14 08:04:01 +0000717 for (; i != numEltsTo; ++i)
718 Args.push_back(UnC);
719 }
720 Constant *Mask = ConstantVector::get(Args);
721 return Builder.CreateShuffleVector(FromVal, UnV, Mask, "tmpV");
722}
723
Chris Lattner4cc576b2010-04-16 00:24:57 +0000724/// ConvertScalar_ExtractValue - Extract a value of type ToType from an integer
725/// or vector value FromVal, extracting the bits from the offset specified by
726/// Offset. This returns the value, which is of type ToType.
727///
728/// This happens when we are converting an "integer union" to a single
729/// integer scalar, or when we are converting a "vector union" to a vector with
730/// insert/extractelement instructions.
731///
732/// Offset is an offset from the original alloca, in bits that need to be
733/// shifted to the right.
734Value *ConvertToScalarInfo::
735ConvertScalar_ExtractValue(Value *FromVal, const Type *ToType,
736 uint64_t Offset, IRBuilder<> &Builder) {
737 // If the load is of the whole new alloca, no conversion is needed.
Mon P Wangbe0761c2011-04-13 21:40:02 +0000738 const Type *FromType = FromVal->getType();
739 if (FromType == ToType && Offset == 0)
Chris Lattner4cc576b2010-04-16 00:24:57 +0000740 return FromVal;
741
742 // If the result alloca is a vector type, this is either an element
743 // access or a bitcast to another vector type of the same size.
Mon P Wangbe0761c2011-04-13 21:40:02 +0000744 if (const VectorType *VTy = dyn_cast<VectorType>(FromType)) {
Cameron Zwarich0398d612011-06-08 22:08:31 +0000745 unsigned FromTypeSize = TD.getTypeAllocSize(FromType);
Cameron Zwarich9827b782011-03-29 05:19:52 +0000746 unsigned ToTypeSize = TD.getTypeAllocSize(ToType);
Cameron Zwarich0398d612011-06-08 22:08:31 +0000747 if (FromTypeSize == ToTypeSize) {
Mon P Wangddf9abf2011-04-14 08:04:01 +0000748 // If the two types have the same primitive size, use a bit cast.
749 // Otherwise, it is two vectors with the same element type that has
750 // the same allocation size but different number of elements so use
751 // a shuffle vector.
Mon P Wangbe0761c2011-04-13 21:40:02 +0000752 if (FromType->getPrimitiveSizeInBits() ==
753 ToType->getPrimitiveSizeInBits())
754 return Builder.CreateBitCast(FromVal, ToType, "tmp");
Mon P Wangddf9abf2011-04-14 08:04:01 +0000755 else
756 return CreateShuffleVectorCast(FromVal, ToType, Builder);
Mon P Wangbe0761c2011-04-13 21:40:02 +0000757 }
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000758
Cameron Zwarich0398d612011-06-08 22:08:31 +0000759 if (isPowerOf2_64(FromTypeSize / ToTypeSize)) {
Cameron Zwarich344731c2011-04-20 21:48:38 +0000760 assert(!(ToType->isVectorTy() && Offset != 0) && "Can't extract a value "
761 "of a smaller vector type at a nonzero offset.");
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000762
Cameron Zwarich344731c2011-04-20 21:48:38 +0000763 const Type *CastElementTy = getScaledElementType(FromType, ToType,
Cameron Zwarich1537ce72011-03-23 05:25:55 +0000764 ToTypeSize * 8);
Cameron Zwarich0398d612011-06-08 22:08:31 +0000765 unsigned NumCastVectorElements = FromTypeSize / ToTypeSize;
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000766
Cameron Zwarich032c10f2011-03-09 07:34:11 +0000767 LLVMContext &Context = FromVal->getContext();
768 const Type *CastTy = VectorType::get(CastElementTy,
769 NumCastVectorElements);
770 Value *Cast = Builder.CreateBitCast(FromVal, CastTy, "tmp");
Cameron Zwarich344731c2011-04-20 21:48:38 +0000771
772 unsigned EltSize = TD.getTypeAllocSizeInBits(CastElementTy);
773 unsigned Elt = Offset/EltSize;
774 assert(EltSize*Elt == Offset && "Invalid modulus in validity checking");
Cameron Zwarich032c10f2011-03-09 07:34:11 +0000775 Value *Extract = Builder.CreateExtractElement(Cast, ConstantInt::get(
Cameron Zwarich344731c2011-04-20 21:48:38 +0000776 Type::getInt32Ty(Context), Elt), "tmp");
Cameron Zwarich032c10f2011-03-09 07:34:11 +0000777 return Builder.CreateBitCast(Extract, ToType, "tmp");
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000778 }
Chris Lattner4cc576b2010-04-16 00:24:57 +0000779
780 // Otherwise it must be an element access.
781 unsigned Elt = 0;
782 if (Offset) {
783 unsigned EltSize = TD.getTypeAllocSizeInBits(VTy->getElementType());
784 Elt = Offset/EltSize;
785 assert(EltSize*Elt == Offset && "Invalid modulus in validity checking");
786 }
787 // Return the element extracted out of it.
788 Value *V = Builder.CreateExtractElement(FromVal, ConstantInt::get(
789 Type::getInt32Ty(FromVal->getContext()), Elt), "tmp");
790 if (V->getType() != ToType)
791 V = Builder.CreateBitCast(V, ToType, "tmp");
792 return V;
793 }
Bob Wilson69743022011-01-13 20:59:44 +0000794
Chris Lattner4cc576b2010-04-16 00:24:57 +0000795 // If ToType is a first class aggregate, extract out each of the pieces and
796 // use insertvalue's to form the FCA.
797 if (const StructType *ST = dyn_cast<StructType>(ToType)) {
798 const StructLayout &Layout = *TD.getStructLayout(ST);
799 Value *Res = UndefValue::get(ST);
800 for (unsigned i = 0, e = ST->getNumElements(); i != e; ++i) {
801 Value *Elt = ConvertScalar_ExtractValue(FromVal, ST->getElementType(i),
802 Offset+Layout.getElementOffsetInBits(i),
803 Builder);
804 Res = Builder.CreateInsertValue(Res, Elt, i, "tmp");
805 }
806 return Res;
807 }
Bob Wilson69743022011-01-13 20:59:44 +0000808
Chris Lattner4cc576b2010-04-16 00:24:57 +0000809 if (const ArrayType *AT = dyn_cast<ArrayType>(ToType)) {
810 uint64_t EltSize = TD.getTypeAllocSizeInBits(AT->getElementType());
811 Value *Res = UndefValue::get(AT);
812 for (unsigned i = 0, e = AT->getNumElements(); i != e; ++i) {
813 Value *Elt = ConvertScalar_ExtractValue(FromVal, AT->getElementType(),
814 Offset+i*EltSize, Builder);
815 Res = Builder.CreateInsertValue(Res, Elt, i, "tmp");
816 }
817 return Res;
818 }
819
820 // Otherwise, this must be a union that was converted to an integer value.
821 const IntegerType *NTy = cast<IntegerType>(FromVal->getType());
822
823 // If this is a big-endian system and the load is narrower than the
824 // full alloca type, we need to do a shift to get the right bits.
825 int ShAmt = 0;
826 if (TD.isBigEndian()) {
827 // On big-endian machines, the lowest bit is stored at the bit offset
828 // from the pointer given by getTypeStoreSizeInBits. This matters for
829 // integers with a bitwidth that is not a multiple of 8.
830 ShAmt = TD.getTypeStoreSizeInBits(NTy) -
831 TD.getTypeStoreSizeInBits(ToType) - Offset;
832 } else {
833 ShAmt = Offset;
834 }
835
836 // Note: we support negative bitwidths (with shl) which are not defined.
837 // We do this to support (f.e.) loads off the end of a structure where
838 // only some bits are used.
839 if (ShAmt > 0 && (unsigned)ShAmt < NTy->getBitWidth())
840 FromVal = Builder.CreateLShr(FromVal,
841 ConstantInt::get(FromVal->getType(),
842 ShAmt), "tmp");
843 else if (ShAmt < 0 && (unsigned)-ShAmt < NTy->getBitWidth())
Bob Wilson69743022011-01-13 20:59:44 +0000844 FromVal = Builder.CreateShl(FromVal,
Chris Lattner4cc576b2010-04-16 00:24:57 +0000845 ConstantInt::get(FromVal->getType(),
846 -ShAmt), "tmp");
847
848 // Finally, unconditionally truncate the integer to the right width.
849 unsigned LIBitWidth = TD.getTypeSizeInBits(ToType);
850 if (LIBitWidth < NTy->getBitWidth())
851 FromVal =
Bob Wilson69743022011-01-13 20:59:44 +0000852 Builder.CreateTrunc(FromVal, IntegerType::get(FromVal->getContext(),
Chris Lattner4cc576b2010-04-16 00:24:57 +0000853 LIBitWidth), "tmp");
854 else if (LIBitWidth > NTy->getBitWidth())
855 FromVal =
Bob Wilson69743022011-01-13 20:59:44 +0000856 Builder.CreateZExt(FromVal, IntegerType::get(FromVal->getContext(),
Chris Lattner4cc576b2010-04-16 00:24:57 +0000857 LIBitWidth), "tmp");
858
859 // If the result is an integer, this is a trunc or bitcast.
860 if (ToType->isIntegerTy()) {
861 // Should be done.
862 } else if (ToType->isFloatingPointTy() || ToType->isVectorTy()) {
863 // Just do a bitcast, we know the sizes match up.
864 FromVal = Builder.CreateBitCast(FromVal, ToType, "tmp");
865 } else {
866 // Otherwise must be a pointer.
867 FromVal = Builder.CreateIntToPtr(FromVal, ToType, "tmp");
868 }
869 assert(FromVal->getType() == ToType && "Didn't convert right?");
870 return FromVal;
871}
872
873/// ConvertScalar_InsertValue - Insert the value "SV" into the existing integer
874/// or vector value "Old" at the offset specified by Offset.
875///
876/// This happens when we are converting an "integer union" to a
877/// single integer scalar, or when we are converting a "vector union" to a
878/// vector with insert/extractelement instructions.
879///
880/// Offset is an offset from the original alloca, in bits that need to be
881/// shifted to the right.
882Value *ConvertToScalarInfo::
883ConvertScalar_InsertValue(Value *SV, Value *Old,
884 uint64_t Offset, IRBuilder<> &Builder) {
885 // Convert the stored type to the actual type, shift it left to insert
886 // then 'or' into place.
887 const Type *AllocaType = Old->getType();
888 LLVMContext &Context = Old->getContext();
889
890 if (const VectorType *VTy = dyn_cast<VectorType>(AllocaType)) {
891 uint64_t VecSize = TD.getTypeAllocSizeInBits(VTy);
892 uint64_t ValSize = TD.getTypeAllocSizeInBits(SV->getType());
Bob Wilson69743022011-01-13 20:59:44 +0000893
Chris Lattner4cc576b2010-04-16 00:24:57 +0000894 // Changing the whole vector with memset or with an access of a different
895 // vector type?
Mon P Wangbe0761c2011-04-13 21:40:02 +0000896 if (ValSize == VecSize) {
Mon P Wangddf9abf2011-04-14 08:04:01 +0000897 // If the two types have the same primitive size, use a bit cast.
898 // Otherwise, it is two vectors with the same element type that has
899 // the same allocation size but different number of elements so use
900 // a shuffle vector.
Mon P Wangbe0761c2011-04-13 21:40:02 +0000901 if (VTy->getPrimitiveSizeInBits() ==
902 SV->getType()->getPrimitiveSizeInBits())
903 return Builder.CreateBitCast(SV, AllocaType, "tmp");
Mon P Wangddf9abf2011-04-14 08:04:01 +0000904 else
905 return CreateShuffleVectorCast(SV, VTy, Builder);
Mon P Wangbe0761c2011-04-13 21:40:02 +0000906 }
Chris Lattner4cc576b2010-04-16 00:24:57 +0000907
Cameron Zwarich344731c2011-04-20 21:48:38 +0000908 if (isPowerOf2_64(VecSize / ValSize)) {
909 assert(!(SV->getType()->isVectorTy() && Offset != 0) && "Can't insert a "
910 "value of a smaller vector type at a nonzero offset.");
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000911
Cameron Zwarich344731c2011-04-20 21:48:38 +0000912 const Type *CastElementTy = getScaledElementType(VTy, SV->getType(),
913 ValSize);
Cameron Zwarich1537ce72011-03-23 05:25:55 +0000914 unsigned NumCastVectorElements = VecSize / ValSize;
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000915
916 LLVMContext &Context = SV->getContext();
917 const Type *OldCastTy = VectorType::get(CastElementTy,
918 NumCastVectorElements);
919 Value *OldCast = Builder.CreateBitCast(Old, OldCastTy, "tmp");
920
921 Value *SVCast = Builder.CreateBitCast(SV, CastElementTy, "tmp");
Cameron Zwarich344731c2011-04-20 21:48:38 +0000922
923 unsigned EltSize = TD.getTypeAllocSizeInBits(CastElementTy);
924 unsigned Elt = Offset/EltSize;
925 assert(EltSize*Elt == Offset && "Invalid modulus in validity checking");
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000926 Value *Insert =
927 Builder.CreateInsertElement(OldCast, SVCast, ConstantInt::get(
Cameron Zwarich344731c2011-04-20 21:48:38 +0000928 Type::getInt32Ty(Context), Elt), "tmp");
Cameron Zwarichb2fd7702011-03-09 05:43:05 +0000929 return Builder.CreateBitCast(Insert, AllocaType, "tmp");
930 }
931
Chris Lattner4cc576b2010-04-16 00:24:57 +0000932 // Must be an element insertion.
Cameron Zwarichc5c43b92011-04-20 21:48:34 +0000933 assert(SV->getType() == VTy->getElementType());
934 uint64_t EltSize = TD.getTypeAllocSizeInBits(VTy->getElementType());
Chris Lattner4cc576b2010-04-16 00:24:57 +0000935 unsigned Elt = Offset/EltSize;
Cameron Zwarichc5c43b92011-04-20 21:48:34 +0000936 return Builder.CreateInsertElement(Old, SV,
Chris Lattner4cc576b2010-04-16 00:24:57 +0000937 ConstantInt::get(Type::getInt32Ty(SV->getContext()), Elt),
938 "tmp");
Chris Lattner4cc576b2010-04-16 00:24:57 +0000939 }
Bob Wilson69743022011-01-13 20:59:44 +0000940
Chris Lattner4cc576b2010-04-16 00:24:57 +0000941 // If SV is a first-class aggregate value, insert each value recursively.
942 if (const StructType *ST = dyn_cast<StructType>(SV->getType())) {
943 const StructLayout &Layout = *TD.getStructLayout(ST);
944 for (unsigned i = 0, e = ST->getNumElements(); i != e; ++i) {
945 Value *Elt = Builder.CreateExtractValue(SV, i, "tmp");
Bob Wilson69743022011-01-13 20:59:44 +0000946 Old = ConvertScalar_InsertValue(Elt, Old,
Chris Lattner4cc576b2010-04-16 00:24:57 +0000947 Offset+Layout.getElementOffsetInBits(i),
948 Builder);
949 }
950 return Old;
951 }
Bob Wilson69743022011-01-13 20:59:44 +0000952
Chris Lattner4cc576b2010-04-16 00:24:57 +0000953 if (const ArrayType *AT = dyn_cast<ArrayType>(SV->getType())) {
954 uint64_t EltSize = TD.getTypeAllocSizeInBits(AT->getElementType());
955 for (unsigned i = 0, e = AT->getNumElements(); i != e; ++i) {
956 Value *Elt = Builder.CreateExtractValue(SV, i, "tmp");
957 Old = ConvertScalar_InsertValue(Elt, Old, Offset+i*EltSize, Builder);
958 }
959 return Old;
960 }
961
962 // If SV is a float, convert it to the appropriate integer type.
963 // If it is a pointer, do the same.
964 unsigned SrcWidth = TD.getTypeSizeInBits(SV->getType());
965 unsigned DestWidth = TD.getTypeSizeInBits(AllocaType);
966 unsigned SrcStoreWidth = TD.getTypeStoreSizeInBits(SV->getType());
967 unsigned DestStoreWidth = TD.getTypeStoreSizeInBits(AllocaType);
968 if (SV->getType()->isFloatingPointTy() || SV->getType()->isVectorTy())
969 SV = Builder.CreateBitCast(SV,
970 IntegerType::get(SV->getContext(),SrcWidth), "tmp");
971 else if (SV->getType()->isPointerTy())
972 SV = Builder.CreatePtrToInt(SV, TD.getIntPtrType(SV->getContext()), "tmp");
973
974 // Zero extend or truncate the value if needed.
975 if (SV->getType() != AllocaType) {
976 if (SV->getType()->getPrimitiveSizeInBits() <
977 AllocaType->getPrimitiveSizeInBits())
978 SV = Builder.CreateZExt(SV, AllocaType, "tmp");
979 else {
980 // Truncation may be needed if storing more than the alloca can hold
981 // (undefined behavior).
982 SV = Builder.CreateTrunc(SV, AllocaType, "tmp");
983 SrcWidth = DestWidth;
984 SrcStoreWidth = DestStoreWidth;
985 }
986 }
987
988 // If this is a big-endian system and the store is narrower than the
989 // full alloca type, we need to do a shift to get the right bits.
990 int ShAmt = 0;
991 if (TD.isBigEndian()) {
992 // On big-endian machines, the lowest bit is stored at the bit offset
993 // from the pointer given by getTypeStoreSizeInBits. This matters for
994 // integers with a bitwidth that is not a multiple of 8.
995 ShAmt = DestStoreWidth - SrcStoreWidth - Offset;
996 } else {
997 ShAmt = Offset;
998 }
999
1000 // Note: we support negative bitwidths (with shr) which are not defined.
1001 // We do this to support (f.e.) stores off the end of a structure where
1002 // only some bits in the structure are set.
1003 APInt Mask(APInt::getLowBitsSet(DestWidth, SrcWidth));
1004 if (ShAmt > 0 && (unsigned)ShAmt < DestWidth) {
1005 SV = Builder.CreateShl(SV, ConstantInt::get(SV->getType(),
1006 ShAmt), "tmp");
1007 Mask <<= ShAmt;
1008 } else if (ShAmt < 0 && (unsigned)-ShAmt < DestWidth) {
1009 SV = Builder.CreateLShr(SV, ConstantInt::get(SV->getType(),
1010 -ShAmt), "tmp");
1011 Mask = Mask.lshr(-ShAmt);
1012 }
1013
1014 // Mask out the bits we are about to insert from the old value, and or
1015 // in the new bits.
1016 if (SrcWidth != DestWidth) {
1017 assert(DestWidth > SrcWidth);
1018 Old = Builder.CreateAnd(Old, ConstantInt::get(Context, ~Mask), "mask");
1019 SV = Builder.CreateOr(Old, SV, "ins");
1020 }
1021 return SV;
1022}
1023
1024
1025//===----------------------------------------------------------------------===//
1026// SRoA Driver
1027//===----------------------------------------------------------------------===//
1028
1029
Chris Lattnered7b41e2003-05-27 15:45:27 +00001030bool SROA::runOnFunction(Function &F) {
Dan Gohmane4af1cf2009-08-19 18:22:18 +00001031 TD = getAnalysisIfAvailable<TargetData>();
1032
Chris Lattnerfe7ea0d2003-09-12 15:36:03 +00001033 bool Changed = performPromotion(F);
Dan Gohmane4af1cf2009-08-19 18:22:18 +00001034
1035 // FIXME: ScalarRepl currently depends on TargetData more than it
1036 // theoretically needs to. It should be refactored in order to support
1037 // target-independent IR. Until this is done, just skip the actual
1038 // scalar-replacement portion of this pass.
1039 if (!TD) return Changed;
1040
Chris Lattnerfe7ea0d2003-09-12 15:36:03 +00001041 while (1) {
1042 bool LocalChange = performScalarRepl(F);
1043 if (!LocalChange) break; // No need to repromote if no scalarrepl
1044 Changed = true;
1045 LocalChange = performPromotion(F);
1046 if (!LocalChange) break; // No need to re-scalarrepl if no promotion
1047 }
Chris Lattner38aec322003-09-11 16:45:55 +00001048
1049 return Changed;
1050}
1051
Chris Lattnerd0f56132011-01-14 19:50:47 +00001052namespace {
1053class AllocaPromoter : public LoadAndStorePromoter {
1054 AllocaInst *AI;
1055public:
Cameron Zwarichc8279392011-05-24 03:10:43 +00001056 AllocaPromoter(const SmallVectorImpl<Instruction*> &Insts, SSAUpdater &S,
1057 DbgDeclareInst *DD, DIBuilder *&DB)
1058 : LoadAndStorePromoter(Insts, S, DD, DB), AI(0) {}
Chris Lattnerd0f56132011-01-14 19:50:47 +00001059
Chris Lattnerdeaf55f2011-01-15 00:12:35 +00001060 void run(AllocaInst *AI, const SmallVectorImpl<Instruction*> &Insts) {
Chris Lattnerd0f56132011-01-14 19:50:47 +00001061 // Remember which alloca we're promoting (for isInstInList).
1062 this->AI = AI;
Chris Lattnerdeaf55f2011-01-15 00:12:35 +00001063 LoadAndStorePromoter::run(Insts);
Chris Lattnerd0f56132011-01-14 19:50:47 +00001064 AI->eraseFromParent();
Chris Lattnere0a1a5b2011-01-14 07:50:47 +00001065 }
1066
Chris Lattnerd0f56132011-01-14 19:50:47 +00001067 virtual bool isInstInList(Instruction *I,
1068 const SmallVectorImpl<Instruction*> &Insts) const {
1069 if (LoadInst *LI = dyn_cast<LoadInst>(I))
1070 return LI->getOperand(0) == AI;
1071 return cast<StoreInst>(I)->getPointerOperand() == AI;
Chris Lattnere0a1a5b2011-01-14 07:50:47 +00001072 }
Chris Lattnerd0f56132011-01-14 19:50:47 +00001073};
1074} // end anon namespace
Chris Lattner38aec322003-09-11 16:45:55 +00001075
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001076/// isSafeSelectToSpeculate - Select instructions that use an alloca and are
1077/// subsequently loaded can be rewritten to load both input pointers and then
1078/// select between the result, allowing the load of the alloca to be promoted.
1079/// From this:
1080/// %P2 = select i1 %cond, i32* %Alloca, i32* %Other
1081/// %V = load i32* %P2
1082/// to:
1083/// %V1 = load i32* %Alloca -> will be mem2reg'd
1084/// %V2 = load i32* %Other
Chris Lattnere3357862011-01-24 01:07:11 +00001085/// %V = select i1 %cond, i32 %V1, i32 %V2
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001086///
1087/// We can do this to a select if its only uses are loads and if the operand to
1088/// the select can be loaded unconditionally.
1089static bool isSafeSelectToSpeculate(SelectInst *SI, const TargetData *TD) {
1090 bool TDerefable = SI->getTrueValue()->isDereferenceablePointer();
1091 bool FDerefable = SI->getFalseValue()->isDereferenceablePointer();
1092
1093 for (Value::use_iterator UI = SI->use_begin(), UE = SI->use_end();
1094 UI != UE; ++UI) {
1095 LoadInst *LI = dyn_cast<LoadInst>(*UI);
1096 if (LI == 0 || LI->isVolatile()) return false;
1097
Chris Lattnere3357862011-01-24 01:07:11 +00001098 // Both operands to the select need to be dereferencable, either absolutely
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001099 // (e.g. allocas) or at this point because we can see other accesses to it.
1100 if (!TDerefable && !isSafeToLoadUnconditionally(SI->getTrueValue(), LI,
1101 LI->getAlignment(), TD))
1102 return false;
1103 if (!FDerefable && !isSafeToLoadUnconditionally(SI->getFalseValue(), LI,
1104 LI->getAlignment(), TD))
1105 return false;
1106 }
1107
1108 return true;
1109}
1110
Chris Lattnere3357862011-01-24 01:07:11 +00001111/// isSafePHIToSpeculate - PHI instructions that use an alloca and are
1112/// subsequently loaded can be rewritten to load both input pointers in the pred
1113/// blocks and then PHI the results, allowing the load of the alloca to be
1114/// promoted.
1115/// From this:
1116/// %P2 = phi [i32* %Alloca, i32* %Other]
1117/// %V = load i32* %P2
1118/// to:
1119/// %V1 = load i32* %Alloca -> will be mem2reg'd
1120/// ...
1121/// %V2 = load i32* %Other
1122/// ...
1123/// %V = phi [i32 %V1, i32 %V2]
1124///
1125/// We can do this to a select if its only uses are loads and if the operand to
1126/// the select can be loaded unconditionally.
1127static bool isSafePHIToSpeculate(PHINode *PN, const TargetData *TD) {
1128 // For now, we can only do this promotion if the load is in the same block as
1129 // the PHI, and if there are no stores between the phi and load.
1130 // TODO: Allow recursive phi users.
1131 // TODO: Allow stores.
1132 BasicBlock *BB = PN->getParent();
1133 unsigned MaxAlign = 0;
1134 for (Value::use_iterator UI = PN->use_begin(), UE = PN->use_end();
1135 UI != UE; ++UI) {
1136 LoadInst *LI = dyn_cast<LoadInst>(*UI);
1137 if (LI == 0 || LI->isVolatile()) return false;
1138
1139 // For now we only allow loads in the same block as the PHI. This is a
1140 // common case that happens when instcombine merges two loads through a PHI.
1141 if (LI->getParent() != BB) return false;
1142
1143 // Ensure that there are no instructions between the PHI and the load that
1144 // could store.
1145 for (BasicBlock::iterator BBI = PN; &*BBI != LI; ++BBI)
1146 if (BBI->mayWriteToMemory())
1147 return false;
1148
1149 MaxAlign = std::max(MaxAlign, LI->getAlignment());
1150 }
1151
1152 // Okay, we know that we have one or more loads in the same block as the PHI.
1153 // We can transform this if it is safe to push the loads into the predecessor
1154 // blocks. The only thing to watch out for is that we can't put a possibly
1155 // trapping load in the predecessor if it is a critical edge.
1156 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1157 BasicBlock *Pred = PN->getIncomingBlock(i);
1158
1159 // If the predecessor has a single successor, then the edge isn't critical.
1160 if (Pred->getTerminator()->getNumSuccessors() == 1)
1161 continue;
1162
1163 Value *InVal = PN->getIncomingValue(i);
1164
1165 // If the InVal is an invoke in the pred, we can't put a load on the edge.
1166 if (InvokeInst *II = dyn_cast<InvokeInst>(InVal))
1167 if (II->getParent() == Pred)
1168 return false;
1169
1170 // If this pointer is always safe to load, or if we can prove that there is
1171 // already a load in the block, then we can move the load to the pred block.
1172 if (InVal->isDereferenceablePointer() ||
1173 isSafeToLoadUnconditionally(InVal, Pred->getTerminator(), MaxAlign, TD))
1174 continue;
1175
1176 return false;
1177 }
1178
1179 return true;
1180}
1181
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001182
1183/// tryToMakeAllocaBePromotable - This returns true if the alloca only has
1184/// direct (non-volatile) loads and stores to it. If the alloca is close but
1185/// not quite there, this will transform the code to allow promotion. As such,
1186/// it is a non-pure predicate.
1187static bool tryToMakeAllocaBePromotable(AllocaInst *AI, const TargetData *TD) {
1188 SetVector<Instruction*, SmallVector<Instruction*, 4>,
1189 SmallPtrSet<Instruction*, 4> > InstsToRewrite;
1190
1191 for (Value::use_iterator UI = AI->use_begin(), UE = AI->use_end();
1192 UI != UE; ++UI) {
1193 User *U = *UI;
1194 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
1195 if (LI->isVolatile())
1196 return false;
1197 continue;
1198 }
1199
1200 if (StoreInst *SI = dyn_cast<StoreInst>(U)) {
1201 if (SI->getOperand(0) == AI || SI->isVolatile())
1202 return false; // Don't allow a store OF the AI, only INTO the AI.
1203 continue;
1204 }
1205
1206 if (SelectInst *SI = dyn_cast<SelectInst>(U)) {
1207 // If the condition being selected on is a constant, fold the select, yes
1208 // this does (rarely) happen early on.
1209 if (ConstantInt *CI = dyn_cast<ConstantInt>(SI->getCondition())) {
1210 Value *Result = SI->getOperand(1+CI->isZero());
1211 SI->replaceAllUsesWith(Result);
1212 SI->eraseFromParent();
1213
1214 // This is very rare and we just scrambled the use list of AI, start
1215 // over completely.
1216 return tryToMakeAllocaBePromotable(AI, TD);
1217 }
1218
1219 // If it is safe to turn "load (select c, AI, ptr)" into a select of two
1220 // loads, then we can transform this by rewriting the select.
1221 if (!isSafeSelectToSpeculate(SI, TD))
1222 return false;
1223
1224 InstsToRewrite.insert(SI);
1225 continue;
1226 }
1227
Chris Lattnere3357862011-01-24 01:07:11 +00001228 if (PHINode *PN = dyn_cast<PHINode>(U)) {
1229 if (PN->use_empty()) { // Dead PHIs can be stripped.
1230 InstsToRewrite.insert(PN);
1231 continue;
1232 }
1233
1234 // If it is safe to turn "load (phi [AI, ptr, ...])" into a PHI of loads
1235 // in the pred blocks, then we can transform this by rewriting the PHI.
1236 if (!isSafePHIToSpeculate(PN, TD))
1237 return false;
1238
1239 InstsToRewrite.insert(PN);
1240 continue;
1241 }
1242
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001243 return false;
1244 }
1245
1246 // If there are no instructions to rewrite, then all uses are load/stores and
1247 // we're done!
1248 if (InstsToRewrite.empty())
1249 return true;
1250
1251 // If we have instructions that need to be rewritten for this to be promotable
1252 // take care of it now.
1253 for (unsigned i = 0, e = InstsToRewrite.size(); i != e; ++i) {
Chris Lattnere3357862011-01-24 01:07:11 +00001254 if (SelectInst *SI = dyn_cast<SelectInst>(InstsToRewrite[i])) {
1255 // Selects in InstsToRewrite only have load uses. Rewrite each as two
1256 // loads with a new select.
1257 while (!SI->use_empty()) {
1258 LoadInst *LI = cast<LoadInst>(SI->use_back());
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001259
Chris Lattnere3357862011-01-24 01:07:11 +00001260 IRBuilder<> Builder(LI);
1261 LoadInst *TrueLoad =
1262 Builder.CreateLoad(SI->getTrueValue(), LI->getName()+".t");
1263 LoadInst *FalseLoad =
1264 Builder.CreateLoad(SI->getFalseValue(), LI->getName()+".t");
1265
1266 // Transfer alignment and TBAA info if present.
1267 TrueLoad->setAlignment(LI->getAlignment());
1268 FalseLoad->setAlignment(LI->getAlignment());
1269 if (MDNode *Tag = LI->getMetadata(LLVMContext::MD_tbaa)) {
1270 TrueLoad->setMetadata(LLVMContext::MD_tbaa, Tag);
1271 FalseLoad->setMetadata(LLVMContext::MD_tbaa, Tag);
1272 }
1273
1274 Value *V = Builder.CreateSelect(SI->getCondition(), TrueLoad, FalseLoad);
1275 V->takeName(LI);
1276 LI->replaceAllUsesWith(V);
1277 LI->eraseFromParent();
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001278 }
Chris Lattnere3357862011-01-24 01:07:11 +00001279
1280 // Now that all the loads are gone, the select is gone too.
1281 SI->eraseFromParent();
1282 continue;
1283 }
1284
1285 // Otherwise, we have a PHI node which allows us to push the loads into the
1286 // predecessors.
1287 PHINode *PN = cast<PHINode>(InstsToRewrite[i]);
1288 if (PN->use_empty()) {
1289 PN->eraseFromParent();
1290 continue;
1291 }
1292
1293 const Type *LoadTy = cast<PointerType>(PN->getType())->getElementType();
Jay Foad3ecfc862011-03-30 11:28:46 +00001294 PHINode *NewPN = PHINode::Create(LoadTy, PN->getNumIncomingValues(),
1295 PN->getName()+".ld", PN);
Chris Lattnere3357862011-01-24 01:07:11 +00001296
1297 // Get the TBAA tag and alignment to use from one of the loads. It doesn't
1298 // matter which one we get and if any differ, it doesn't matter.
1299 LoadInst *SomeLoad = cast<LoadInst>(PN->use_back());
1300 MDNode *TBAATag = SomeLoad->getMetadata(LLVMContext::MD_tbaa);
1301 unsigned Align = SomeLoad->getAlignment();
1302
1303 // Rewrite all loads of the PN to use the new PHI.
1304 while (!PN->use_empty()) {
1305 LoadInst *LI = cast<LoadInst>(PN->use_back());
1306 LI->replaceAllUsesWith(NewPN);
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001307 LI->eraseFromParent();
1308 }
1309
Chris Lattnere3357862011-01-24 01:07:11 +00001310 // Inject loads into all of the pred blocks. Keep track of which blocks we
1311 // insert them into in case we have multiple edges from the same block.
1312 DenseMap<BasicBlock*, LoadInst*> InsertedLoads;
1313
1314 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1315 BasicBlock *Pred = PN->getIncomingBlock(i);
1316 LoadInst *&Load = InsertedLoads[Pred];
1317 if (Load == 0) {
1318 Load = new LoadInst(PN->getIncomingValue(i),
1319 PN->getName() + "." + Pred->getName(),
1320 Pred->getTerminator());
1321 Load->setAlignment(Align);
1322 if (TBAATag) Load->setMetadata(LLVMContext::MD_tbaa, TBAATag);
1323 }
1324
1325 NewPN->addIncoming(Load, Pred);
1326 }
1327
1328 PN->eraseFromParent();
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001329 }
1330
1331 ++NumAdjusted;
1332 return true;
1333}
1334
Chris Lattner38aec322003-09-11 16:45:55 +00001335bool SROA::performPromotion(Function &F) {
1336 std::vector<AllocaInst*> Allocas;
Chris Lattnere0a1a5b2011-01-14 07:50:47 +00001337 DominatorTree *DT = 0;
Cameron Zwarichb1686c32011-01-18 03:53:26 +00001338 if (HasDomTree)
Chris Lattnere0a1a5b2011-01-14 07:50:47 +00001339 DT = &getAnalysis<DominatorTree>();
Chris Lattner38aec322003-09-11 16:45:55 +00001340
Chris Lattner02a3be02003-09-20 14:39:18 +00001341 BasicBlock &BB = F.getEntryBlock(); // Get the entry node for the function
Chris Lattner38aec322003-09-11 16:45:55 +00001342
Chris Lattnerfe7ea0d2003-09-12 15:36:03 +00001343 bool Changed = false;
Chris Lattnerdeaf55f2011-01-15 00:12:35 +00001344 SmallVector<Instruction*, 64> Insts;
Cameron Zwarichc8279392011-05-24 03:10:43 +00001345 DIBuilder *DIB = 0;
Chris Lattner38aec322003-09-11 16:45:55 +00001346 while (1) {
1347 Allocas.clear();
1348
1349 // Find allocas that are safe to promote, by looking at all instructions in
1350 // the entry node
1351 for (BasicBlock::iterator I = BB.begin(), E = --BB.end(); I != E; ++I)
1352 if (AllocaInst *AI = dyn_cast<AllocaInst>(I)) // Is it an alloca?
Chris Lattnerc87c50a2011-01-23 22:04:55 +00001353 if (tryToMakeAllocaBePromotable(AI, TD))
Chris Lattner38aec322003-09-11 16:45:55 +00001354 Allocas.push_back(AI);
1355
1356 if (Allocas.empty()) break;
1357
Cameron Zwarichb1686c32011-01-18 03:53:26 +00001358 if (HasDomTree)
Cameron Zwarich419e8a62011-01-17 17:38:41 +00001359 PromoteMemToReg(Allocas, *DT);
Chris Lattnere0a1a5b2011-01-14 07:50:47 +00001360 else {
1361 SSAUpdater SSA;
Chris Lattnerdeaf55f2011-01-15 00:12:35 +00001362 for (unsigned i = 0, e = Allocas.size(); i != e; ++i) {
1363 AllocaInst *AI = Allocas[i];
1364
1365 // Build list of instructions to promote.
1366 for (Value::use_iterator UI = AI->use_begin(), E = AI->use_end();
1367 UI != E; ++UI)
1368 Insts.push_back(cast<Instruction>(*UI));
Cameron Zwarichc8279392011-05-24 03:10:43 +00001369
1370 DbgDeclareInst *DDI = FindAllocaDbgDeclare(AI);
Cameron Zwarich13a16082011-05-24 06:00:08 +00001371 if (DDI && !DIB)
1372 DIB = new DIBuilder(*AI->getParent()->getParent()->getParent());
Cameron Zwarichc8279392011-05-24 03:10:43 +00001373 AllocaPromoter(Insts, SSA, DDI, DIB).run(AI, Insts);
Chris Lattnerdeaf55f2011-01-15 00:12:35 +00001374 Insts.clear();
1375 }
Chris Lattnere0a1a5b2011-01-14 07:50:47 +00001376 }
Chris Lattner38aec322003-09-11 16:45:55 +00001377 NumPromoted += Allocas.size();
1378 Changed = true;
1379 }
1380
Cameron Zwarichc8279392011-05-24 03:10:43 +00001381 // FIXME: Is there a better way to handle the lazy initialization of DIB
1382 // so that there doesn't need to be an explicit delete?
1383 delete DIB;
1384
Chris Lattner38aec322003-09-11 16:45:55 +00001385 return Changed;
1386}
1387
Chris Lattner4cc576b2010-04-16 00:24:57 +00001388
Bob Wilson3992feb2010-02-03 17:23:56 +00001389/// ShouldAttemptScalarRepl - Decide if an alloca is a good candidate for
1390/// SROA. It must be a struct or array type with a small number of elements.
1391static bool ShouldAttemptScalarRepl(AllocaInst *AI) {
1392 const Type *T = AI->getAllocatedType();
1393 // Do not promote any struct into more than 32 separate vars.
Chris Lattner963a97f2008-06-22 17:46:21 +00001394 if (const StructType *ST = dyn_cast<StructType>(T))
Bob Wilson3992feb2010-02-03 17:23:56 +00001395 return ST->getNumElements() <= 32;
1396 // Arrays are much less likely to be safe for SROA; only consider
1397 // them if they are very small.
1398 if (const ArrayType *AT = dyn_cast<ArrayType>(T))
1399 return AT->getNumElements() <= 8;
1400 return false;
Chris Lattner963a97f2008-06-22 17:46:21 +00001401}
1402
Chris Lattnerc4472072010-04-15 23:50:26 +00001403
Chris Lattner38aec322003-09-11 16:45:55 +00001404// performScalarRepl - This algorithm is a simple worklist driven algorithm,
1405// which runs on all of the malloc/alloca instructions in the function, removing
1406// them if they are only used by getelementptr instructions.
1407//
1408bool SROA::performScalarRepl(Function &F) {
Victor Hernandez7b929da2009-10-23 21:09:37 +00001409 std::vector<AllocaInst*> WorkList;
Chris Lattnered7b41e2003-05-27 15:45:27 +00001410
Chris Lattner31d80102010-04-15 21:59:20 +00001411 // Scan the entry basic block, adding allocas to the worklist.
Chris Lattner02a3be02003-09-20 14:39:18 +00001412 BasicBlock &BB = F.getEntryBlock();
Chris Lattnered7b41e2003-05-27 15:45:27 +00001413 for (BasicBlock::iterator I = BB.begin(), E = BB.end(); I != E; ++I)
Victor Hernandez7b929da2009-10-23 21:09:37 +00001414 if (AllocaInst *A = dyn_cast<AllocaInst>(I))
Chris Lattnered7b41e2003-05-27 15:45:27 +00001415 WorkList.push_back(A);
1416
1417 // Process the worklist
1418 bool Changed = false;
1419 while (!WorkList.empty()) {
Victor Hernandez7b929da2009-10-23 21:09:37 +00001420 AllocaInst *AI = WorkList.back();
Chris Lattnered7b41e2003-05-27 15:45:27 +00001421 WorkList.pop_back();
Bob Wilson69743022011-01-13 20:59:44 +00001422
Chris Lattneradd2bd72006-12-22 23:14:42 +00001423 // Handle dead allocas trivially. These can be formed by SROA'ing arrays
1424 // with unused elements.
1425 if (AI->use_empty()) {
1426 AI->eraseFromParent();
Chris Lattnerc4472072010-04-15 23:50:26 +00001427 Changed = true;
Chris Lattneradd2bd72006-12-22 23:14:42 +00001428 continue;
1429 }
Chris Lattner7809ecd2009-02-03 01:30:09 +00001430
1431 // If this alloca is impossible for us to promote, reject it early.
1432 if (AI->isArrayAllocation() || !AI->getAllocatedType()->isSized())
1433 continue;
Bob Wilson69743022011-01-13 20:59:44 +00001434
Chris Lattner79b3bd32007-04-25 06:40:51 +00001435 // Check to see if this allocation is only modified by a memcpy/memmove from
1436 // a constant global. If this is the case, we can change all users to use
1437 // the constant global instead. This is commonly produced by the CFE by
1438 // constructs like "void foo() { int A[] = {1,2,3,4,5,6,7,8,9...}; }" if 'A'
1439 // is only subsequently read.
Chris Lattner31d80102010-04-15 21:59:20 +00001440 if (MemTransferInst *TheCopy = isOnlyCopiedFromConstantGlobal(AI)) {
David Greene504c7d82010-01-05 01:27:09 +00001441 DEBUG(dbgs() << "Found alloca equal to global: " << *AI << '\n');
1442 DEBUG(dbgs() << " memcpy = " << *TheCopy << '\n');
Chris Lattner31d80102010-04-15 21:59:20 +00001443 Constant *TheSrc = cast<Constant>(TheCopy->getSource());
Owen Andersonbaf3c402009-07-29 18:55:55 +00001444 AI->replaceAllUsesWith(ConstantExpr::getBitCast(TheSrc, AI->getType()));
Chris Lattner79b3bd32007-04-25 06:40:51 +00001445 TheCopy->eraseFromParent(); // Don't mutate the global.
1446 AI->eraseFromParent();
1447 ++NumGlobals;
1448 Changed = true;
1449 continue;
1450 }
Bob Wilson69743022011-01-13 20:59:44 +00001451
Chris Lattner7809ecd2009-02-03 01:30:09 +00001452 // Check to see if we can perform the core SROA transformation. We cannot
1453 // transform the allocation instruction if it is an array allocation
1454 // (allocations OF arrays are ok though), and an allocation of a scalar
1455 // value cannot be decomposed at all.
Duncan Sands777d2302009-05-09 07:06:46 +00001456 uint64_t AllocaSize = TD->getTypeAllocSize(AI->getAllocatedType());
Bill Wendling5a377cb2009-03-03 12:12:58 +00001457
Nick Lewyckyd3aa25e2009-08-17 05:37:31 +00001458 // Do not promote [0 x %struct].
1459 if (AllocaSize == 0) continue;
Bob Wilson69743022011-01-13 20:59:44 +00001460
Chris Lattner31d80102010-04-15 21:59:20 +00001461 // Do not promote any struct whose size is too big.
1462 if (AllocaSize > SRThreshold) continue;
Bob Wilson69743022011-01-13 20:59:44 +00001463
Bob Wilson3992feb2010-02-03 17:23:56 +00001464 // If the alloca looks like a good candidate for scalar replacement, and if
1465 // all its users can be transformed, then split up the aggregate into its
1466 // separate elements.
1467 if (ShouldAttemptScalarRepl(AI) && isSafeAllocaToScalarRepl(AI)) {
1468 DoScalarReplacement(AI, WorkList);
1469 Changed = true;
1470 continue;
1471 }
1472
Chris Lattner6e733d32009-01-28 20:16:43 +00001473 // If we can turn this aggregate value (potentially with casts) into a
1474 // simple scalar value that can be mem2reg'd into a register value.
Chris Lattner2e0d5f82009-01-31 02:28:54 +00001475 // IsNotTrivial tracks whether this is something that mem2reg could have
1476 // promoted itself. If so, we don't want to transform it needlessly. Note
1477 // that we can't just check based on the type: the alloca may be of an i32
1478 // but that has pointer arithmetic to set byte 3 of it or something.
Chris Lattner593375d2010-04-16 00:20:00 +00001479 if (AllocaInst *NewAI =
1480 ConvertToScalarInfo((unsigned)AllocaSize, *TD).TryConvert(AI)) {
Chris Lattner7809ecd2009-02-03 01:30:09 +00001481 NewAI->takeName(AI);
1482 AI->eraseFromParent();
1483 ++NumConverted;
1484 Changed = true;
1485 continue;
Bob Wilson69743022011-01-13 20:59:44 +00001486 }
1487
Chris Lattner7809ecd2009-02-03 01:30:09 +00001488 // Otherwise, couldn't process this alloca.
Chris Lattnered7b41e2003-05-27 15:45:27 +00001489 }
1490
1491 return Changed;
1492}
Chris Lattner5e062a12003-05-30 04:15:41 +00001493
Chris Lattnera10b29b2007-04-25 05:02:56 +00001494/// DoScalarReplacement - This alloca satisfied the isSafeAllocaToScalarRepl
1495/// predicate, do SROA now.
Bob Wilson69743022011-01-13 20:59:44 +00001496void SROA::DoScalarReplacement(AllocaInst *AI,
Victor Hernandez7b929da2009-10-23 21:09:37 +00001497 std::vector<AllocaInst*> &WorkList) {
David Greene504c7d82010-01-05 01:27:09 +00001498 DEBUG(dbgs() << "Found inst to SROA: " << *AI << '\n');
Chris Lattnera10b29b2007-04-25 05:02:56 +00001499 SmallVector<AllocaInst*, 32> ElementAllocas;
1500 if (const StructType *ST = dyn_cast<StructType>(AI->getAllocatedType())) {
1501 ElementAllocas.reserve(ST->getNumContainedTypes());
1502 for (unsigned i = 0, e = ST->getNumContainedTypes(); i != e; ++i) {
Bob Wilson69743022011-01-13 20:59:44 +00001503 AllocaInst *NA = new AllocaInst(ST->getContainedType(i), 0,
Chris Lattnera10b29b2007-04-25 05:02:56 +00001504 AI->getAlignment(),
Daniel Dunbarfe09b202009-07-30 17:37:43 +00001505 AI->getName() + "." + Twine(i), AI);
Chris Lattnera10b29b2007-04-25 05:02:56 +00001506 ElementAllocas.push_back(NA);
1507 WorkList.push_back(NA); // Add to worklist for recursive processing
1508 }
1509 } else {
1510 const ArrayType *AT = cast<ArrayType>(AI->getAllocatedType());
1511 ElementAllocas.reserve(AT->getNumElements());
1512 const Type *ElTy = AT->getElementType();
1513 for (unsigned i = 0, e = AT->getNumElements(); i != e; ++i) {
Owen Anderson50dead02009-07-15 23:53:25 +00001514 AllocaInst *NA = new AllocaInst(ElTy, 0, AI->getAlignment(),
Daniel Dunbarfe09b202009-07-30 17:37:43 +00001515 AI->getName() + "." + Twine(i), AI);
Chris Lattnera10b29b2007-04-25 05:02:56 +00001516 ElementAllocas.push_back(NA);
1517 WorkList.push_back(NA); // Add to worklist for recursive processing
1518 }
1519 }
1520
Bob Wilsonb742def2009-12-18 20:14:40 +00001521 // Now that we have created the new alloca instructions, rewrite all the
1522 // uses of the old alloca.
1523 RewriteForScalarRepl(AI, AI, 0, ElementAllocas);
Chris Lattnera59adc42009-12-14 05:11:02 +00001524
Bob Wilsonb742def2009-12-18 20:14:40 +00001525 // Now erase any instructions that were made dead while rewriting the alloca.
1526 DeleteDeadInstructions();
Bob Wilson39c88a62009-12-17 18:34:24 +00001527 AI->eraseFromParent();
Bob Wilsonb742def2009-12-18 20:14:40 +00001528
Dan Gohmanfe601042010-06-22 15:08:57 +00001529 ++NumReplaced;
Chris Lattnera10b29b2007-04-25 05:02:56 +00001530}
Chris Lattnera59adc42009-12-14 05:11:02 +00001531
Bob Wilsonb742def2009-12-18 20:14:40 +00001532/// DeleteDeadInstructions - Erase instructions on the DeadInstrs list,
1533/// recursively including all their operands that become trivially dead.
1534void SROA::DeleteDeadInstructions() {
1535 while (!DeadInsts.empty()) {
1536 Instruction *I = cast<Instruction>(DeadInsts.pop_back_val());
Chris Lattnera59adc42009-12-14 05:11:02 +00001537
Bob Wilsonb742def2009-12-18 20:14:40 +00001538 for (User::op_iterator OI = I->op_begin(), E = I->op_end(); OI != E; ++OI)
1539 if (Instruction *U = dyn_cast<Instruction>(*OI)) {
1540 // Zero out the operand and see if it becomes trivially dead.
1541 // (But, don't add allocas to the dead instruction list -- they are
1542 // already on the worklist and will be deleted separately.)
1543 *OI = 0;
1544 if (isInstructionTriviallyDead(U) && !isa<AllocaInst>(U))
1545 DeadInsts.push_back(U);
Chris Lattnera59adc42009-12-14 05:11:02 +00001546 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001547
1548 I->eraseFromParent();
Chris Lattnera59adc42009-12-14 05:11:02 +00001549 }
Chris Lattnera59adc42009-12-14 05:11:02 +00001550}
Bob Wilson69743022011-01-13 20:59:44 +00001551
Bob Wilsonb742def2009-12-18 20:14:40 +00001552/// isSafeForScalarRepl - Check if instruction I is a safe use with regard to
1553/// performing scalar replacement of alloca AI. The results are flagged in
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001554/// the Info parameter. Offset indicates the position within AI that is
1555/// referenced by this instruction.
Chris Lattner6c95d242011-01-23 07:29:29 +00001556void SROA::isSafeForScalarRepl(Instruction *I, uint64_t Offset,
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001557 AllocaInfo &Info) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001558 for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI!=E; ++UI) {
1559 Instruction *User = cast<Instruction>(*UI);
Chris Lattnerbe883a22003-11-25 21:09:18 +00001560
Bob Wilsonb742def2009-12-18 20:14:40 +00001561 if (BitCastInst *BC = dyn_cast<BitCastInst>(User)) {
Chris Lattner6c95d242011-01-23 07:29:29 +00001562 isSafeForScalarRepl(BC, Offset, Info);
Bob Wilsonb742def2009-12-18 20:14:40 +00001563 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001564 uint64_t GEPOffset = Offset;
Chris Lattner6c95d242011-01-23 07:29:29 +00001565 isSafeGEP(GEPI, GEPOffset, Info);
Bob Wilsonb742def2009-12-18 20:14:40 +00001566 if (!Info.isUnsafe)
Chris Lattner6c95d242011-01-23 07:29:29 +00001567 isSafeForScalarRepl(GEPI, GEPOffset, Info);
Gabor Greif19101c72010-06-28 11:20:42 +00001568 } else if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(User)) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001569 ConstantInt *Length = dyn_cast<ConstantInt>(MI->getLength());
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001570 if (Length == 0)
1571 return MarkUnsafe(Info, User);
Chris Lattner6c95d242011-01-23 07:29:29 +00001572 isSafeMemAccess(Offset, Length->getZExtValue(), 0,
Chris Lattner145c5322011-01-23 08:27:54 +00001573 UI.getOperandNo() == 0, Info, MI,
1574 true /*AllowWholeAccess*/);
Bob Wilsonb742def2009-12-18 20:14:40 +00001575 } else if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001576 if (LI->isVolatile())
1577 return MarkUnsafe(Info, User);
1578 const Type *LIType = LI->getType();
Chris Lattner6c95d242011-01-23 07:29:29 +00001579 isSafeMemAccess(Offset, TD->getTypeAllocSize(LIType),
Chris Lattner145c5322011-01-23 08:27:54 +00001580 LIType, false, Info, LI, true /*AllowWholeAccess*/);
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001581 Info.hasALoadOrStore = true;
1582
Bob Wilsonb742def2009-12-18 20:14:40 +00001583 } else if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
1584 // Store is ok if storing INTO the pointer, not storing the pointer
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001585 if (SI->isVolatile() || SI->getOperand(0) == I)
1586 return MarkUnsafe(Info, User);
1587
1588 const Type *SIType = SI->getOperand(0)->getType();
Chris Lattner6c95d242011-01-23 07:29:29 +00001589 isSafeMemAccess(Offset, TD->getTypeAllocSize(SIType),
Chris Lattner145c5322011-01-23 08:27:54 +00001590 SIType, true, Info, SI, true /*AllowWholeAccess*/);
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001591 Info.hasALoadOrStore = true;
Chris Lattner145c5322011-01-23 08:27:54 +00001592 } else if (isa<PHINode>(User) || isa<SelectInst>(User)) {
1593 isSafePHISelectUseForScalarRepl(User, Offset, Info);
1594 } else {
1595 return MarkUnsafe(Info, User);
1596 }
1597 if (Info.isUnsafe) return;
1598 }
1599}
1600
1601
1602/// isSafePHIUseForScalarRepl - If we see a PHI node or select using a pointer
1603/// derived from the alloca, we can often still split the alloca into elements.
1604/// This is useful if we have a large alloca where one element is phi'd
1605/// together somewhere: we can SRoA and promote all the other elements even if
1606/// we end up not being able to promote this one.
1607///
1608/// All we require is that the uses of the PHI do not index into other parts of
1609/// the alloca. The most important use case for this is single load and stores
1610/// that are PHI'd together, which can happen due to code sinking.
1611void SROA::isSafePHISelectUseForScalarRepl(Instruction *I, uint64_t Offset,
1612 AllocaInfo &Info) {
1613 // If we've already checked this PHI, don't do it again.
1614 if (PHINode *PN = dyn_cast<PHINode>(I))
1615 if (!Info.CheckedPHIs.insert(PN))
1616 return;
1617
1618 for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI!=E; ++UI) {
1619 Instruction *User = cast<Instruction>(*UI);
1620
1621 if (BitCastInst *BC = dyn_cast<BitCastInst>(User)) {
1622 isSafePHISelectUseForScalarRepl(BC, Offset, Info);
1623 } else if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
1624 // Only allow "bitcast" GEPs for simplicity. We could generalize this,
1625 // but would have to prove that we're staying inside of an element being
1626 // promoted.
1627 if (!GEPI->hasAllZeroIndices())
1628 return MarkUnsafe(Info, User);
1629 isSafePHISelectUseForScalarRepl(GEPI, Offset, Info);
1630 } else if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
1631 if (LI->isVolatile())
1632 return MarkUnsafe(Info, User);
1633 const Type *LIType = LI->getType();
1634 isSafeMemAccess(Offset, TD->getTypeAllocSize(LIType),
1635 LIType, false, Info, LI, false /*AllowWholeAccess*/);
1636 Info.hasALoadOrStore = true;
1637
1638 } else if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
1639 // Store is ok if storing INTO the pointer, not storing the pointer
1640 if (SI->isVolatile() || SI->getOperand(0) == I)
1641 return MarkUnsafe(Info, User);
1642
1643 const Type *SIType = SI->getOperand(0)->getType();
1644 isSafeMemAccess(Offset, TD->getTypeAllocSize(SIType),
1645 SIType, true, Info, SI, false /*AllowWholeAccess*/);
1646 Info.hasALoadOrStore = true;
1647 } else if (isa<PHINode>(User) || isa<SelectInst>(User)) {
1648 isSafePHISelectUseForScalarRepl(User, Offset, Info);
Bob Wilsonb742def2009-12-18 20:14:40 +00001649 } else {
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001650 return MarkUnsafe(Info, User);
Bob Wilsonb742def2009-12-18 20:14:40 +00001651 }
1652 if (Info.isUnsafe) return;
Bob Wilson39c88a62009-12-17 18:34:24 +00001653 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001654}
Bob Wilson39c88a62009-12-17 18:34:24 +00001655
Bob Wilsonb742def2009-12-18 20:14:40 +00001656/// isSafeGEP - Check if a GEP instruction can be handled for scalar
1657/// replacement. It is safe when all the indices are constant, in-bounds
1658/// references, and when the resulting offset corresponds to an element within
1659/// the alloca type. The results are flagged in the Info parameter. Upon
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001660/// return, Offset is adjusted as specified by the GEP indices.
Chris Lattner6c95d242011-01-23 07:29:29 +00001661void SROA::isSafeGEP(GetElementPtrInst *GEPI,
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001662 uint64_t &Offset, AllocaInfo &Info) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001663 gep_type_iterator GEPIt = gep_type_begin(GEPI), E = gep_type_end(GEPI);
1664 if (GEPIt == E)
1665 return;
Bob Wilson39c88a62009-12-17 18:34:24 +00001666
Chris Lattner88e6dc82008-08-23 05:21:06 +00001667 // Walk through the GEP type indices, checking the types that this indexes
1668 // into.
Bob Wilsonb742def2009-12-18 20:14:40 +00001669 for (; GEPIt != E; ++GEPIt) {
Chris Lattner88e6dc82008-08-23 05:21:06 +00001670 // Ignore struct elements, no extra checking needed for these.
Duncan Sands1df98592010-02-16 11:11:14 +00001671 if ((*GEPIt)->isStructTy())
Chris Lattner88e6dc82008-08-23 05:21:06 +00001672 continue;
Matthijs Kooijman5fac55f2008-10-06 16:23:31 +00001673
Bob Wilsonb742def2009-12-18 20:14:40 +00001674 ConstantInt *IdxVal = dyn_cast<ConstantInt>(GEPIt.getOperand());
1675 if (!IdxVal)
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001676 return MarkUnsafe(Info, GEPI);
Chris Lattner88e6dc82008-08-23 05:21:06 +00001677 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001678
Bob Wilsonf27a4cd2009-12-22 06:57:14 +00001679 // Compute the offset due to this GEP and check if the alloca has a
1680 // component element at that offset.
Bob Wilson3c3af5d2009-12-21 18:39:47 +00001681 SmallVector<Value*, 8> Indices(GEPI->op_begin() + 1, GEPI->op_end());
1682 Offset += TD->getIndexedOffset(GEPI->getPointerOperandType(),
1683 &Indices[0], Indices.size());
Chris Lattner6c95d242011-01-23 07:29:29 +00001684 if (!TypeHasComponent(Info.AI->getAllocatedType(), Offset, 0))
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001685 MarkUnsafe(Info, GEPI);
Chris Lattner5e062a12003-05-30 04:15:41 +00001686}
1687
Bob Wilson704d1342011-01-13 17:45:11 +00001688/// isHomogeneousAggregate - Check if type T is a struct or array containing
1689/// elements of the same type (which is always true for arrays). If so,
1690/// return true with NumElts and EltTy set to the number of elements and the
1691/// element type, respectively.
1692static bool isHomogeneousAggregate(const Type *T, unsigned &NumElts,
1693 const Type *&EltTy) {
1694 if (const ArrayType *AT = dyn_cast<ArrayType>(T)) {
1695 NumElts = AT->getNumElements();
Bob Wilsonf0908ae2011-01-13 18:26:59 +00001696 EltTy = (NumElts == 0 ? 0 : AT->getElementType());
Bob Wilson704d1342011-01-13 17:45:11 +00001697 return true;
1698 }
1699 if (const StructType *ST = dyn_cast<StructType>(T)) {
1700 NumElts = ST->getNumContainedTypes();
Bob Wilsonf0908ae2011-01-13 18:26:59 +00001701 EltTy = (NumElts == 0 ? 0 : ST->getContainedType(0));
Bob Wilson704d1342011-01-13 17:45:11 +00001702 for (unsigned n = 1; n < NumElts; ++n) {
1703 if (ST->getContainedType(n) != EltTy)
1704 return false;
1705 }
1706 return true;
1707 }
1708 return false;
1709}
1710
1711/// isCompatibleAggregate - Check if T1 and T2 are either the same type or are
1712/// "homogeneous" aggregates with the same element type and number of elements.
1713static bool isCompatibleAggregate(const Type *T1, const Type *T2) {
1714 if (T1 == T2)
1715 return true;
1716
1717 unsigned NumElts1, NumElts2;
1718 const Type *EltTy1, *EltTy2;
1719 if (isHomogeneousAggregate(T1, NumElts1, EltTy1) &&
1720 isHomogeneousAggregate(T2, NumElts2, EltTy2) &&
1721 NumElts1 == NumElts2 &&
1722 EltTy1 == EltTy2)
1723 return true;
1724
1725 return false;
1726}
1727
Bob Wilsonb742def2009-12-18 20:14:40 +00001728/// isSafeMemAccess - Check if a load/store/memcpy operates on the entire AI
1729/// alloca or has an offset and size that corresponds to a component element
1730/// within it. The offset checked here may have been formed from a GEP with a
1731/// pointer bitcasted to a different type.
Chris Lattner145c5322011-01-23 08:27:54 +00001732///
1733/// If AllowWholeAccess is true, then this allows uses of the entire alloca as a
1734/// unit. If false, it only allows accesses known to be in a single element.
Chris Lattner6c95d242011-01-23 07:29:29 +00001735void SROA::isSafeMemAccess(uint64_t Offset, uint64_t MemSize,
Bob Wilsonb742def2009-12-18 20:14:40 +00001736 const Type *MemOpType, bool isStore,
Chris Lattner145c5322011-01-23 08:27:54 +00001737 AllocaInfo &Info, Instruction *TheAccess,
1738 bool AllowWholeAccess) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001739 // Check if this is a load/store of the entire alloca.
Chris Lattner145c5322011-01-23 08:27:54 +00001740 if (Offset == 0 && AllowWholeAccess &&
Chris Lattner6c95d242011-01-23 07:29:29 +00001741 MemSize == TD->getTypeAllocSize(Info.AI->getAllocatedType())) {
Bob Wilson704d1342011-01-13 17:45:11 +00001742 // This can be safe for MemIntrinsics (where MemOpType is 0) and integer
1743 // loads/stores (which are essentially the same as the MemIntrinsics with
1744 // regard to copying padding between elements). But, if an alloca is
1745 // flagged as both a source and destination of such operations, we'll need
1746 // to check later for padding between elements.
1747 if (!MemOpType || MemOpType->isIntegerTy()) {
1748 if (isStore)
1749 Info.isMemCpyDst = true;
1750 else
1751 Info.isMemCpySrc = true;
Bob Wilsonb742def2009-12-18 20:14:40 +00001752 return;
1753 }
Bob Wilson704d1342011-01-13 17:45:11 +00001754 // This is also safe for references using a type that is compatible with
1755 // the type of the alloca, so that loads/stores can be rewritten using
1756 // insertvalue/extractvalue.
Chris Lattner6c95d242011-01-23 07:29:29 +00001757 if (isCompatibleAggregate(MemOpType, Info.AI->getAllocatedType())) {
Chris Lattner7e9b4272011-01-16 06:18:28 +00001758 Info.hasSubelementAccess = true;
Bob Wilson704d1342011-01-13 17:45:11 +00001759 return;
Chris Lattner7e9b4272011-01-16 06:18:28 +00001760 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001761 }
1762 // Check if the offset/size correspond to a component within the alloca type.
Chris Lattner6c95d242011-01-23 07:29:29 +00001763 const Type *T = Info.AI->getAllocatedType();
Chris Lattner7e9b4272011-01-16 06:18:28 +00001764 if (TypeHasComponent(T, Offset, MemSize)) {
1765 Info.hasSubelementAccess = true;
Bob Wilsonb742def2009-12-18 20:14:40 +00001766 return;
Chris Lattner7e9b4272011-01-16 06:18:28 +00001767 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001768
Chris Lattnerd01a0da2011-01-23 07:05:44 +00001769 return MarkUnsafe(Info, TheAccess);
Bob Wilsonb742def2009-12-18 20:14:40 +00001770}
1771
1772/// TypeHasComponent - Return true if T has a component type with the
1773/// specified offset and size. If Size is zero, do not check the size.
1774bool SROA::TypeHasComponent(const Type *T, uint64_t Offset, uint64_t Size) {
1775 const Type *EltTy;
1776 uint64_t EltSize;
1777 if (const StructType *ST = dyn_cast<StructType>(T)) {
1778 const StructLayout *Layout = TD->getStructLayout(ST);
1779 unsigned EltIdx = Layout->getElementContainingOffset(Offset);
1780 EltTy = ST->getContainedType(EltIdx);
1781 EltSize = TD->getTypeAllocSize(EltTy);
1782 Offset -= Layout->getElementOffset(EltIdx);
1783 } else if (const ArrayType *AT = dyn_cast<ArrayType>(T)) {
1784 EltTy = AT->getElementType();
1785 EltSize = TD->getTypeAllocSize(EltTy);
Bob Wilsonf27a4cd2009-12-22 06:57:14 +00001786 if (Offset >= AT->getNumElements() * EltSize)
1787 return false;
Bob Wilsonb742def2009-12-18 20:14:40 +00001788 Offset %= EltSize;
1789 } else {
1790 return false;
1791 }
1792 if (Offset == 0 && (Size == 0 || EltSize == Size))
1793 return true;
1794 // Check if the component spans multiple elements.
1795 if (Offset + Size > EltSize)
1796 return false;
1797 return TypeHasComponent(EltTy, Offset, Size);
1798}
1799
1800/// RewriteForScalarRepl - Alloca AI is being split into NewElts, so rewrite
1801/// the instruction I, which references it, to use the separate elements.
1802/// Offset indicates the position within AI that is referenced by this
1803/// instruction.
1804void SROA::RewriteForScalarRepl(Instruction *I, AllocaInst *AI, uint64_t Offset,
1805 SmallVector<AllocaInst*, 32> &NewElts) {
Chris Lattner145c5322011-01-23 08:27:54 +00001806 for (Value::use_iterator UI = I->use_begin(), E = I->use_end(); UI!=E;) {
1807 Use &TheUse = UI.getUse();
1808 Instruction *User = cast<Instruction>(*UI++);
Bob Wilsonb742def2009-12-18 20:14:40 +00001809
1810 if (BitCastInst *BC = dyn_cast<BitCastInst>(User)) {
1811 RewriteBitCast(BC, AI, Offset, NewElts);
Chris Lattner145c5322011-01-23 08:27:54 +00001812 continue;
1813 }
1814
1815 if (GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(User)) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001816 RewriteGEP(GEPI, AI, Offset, NewElts);
Chris Lattner145c5322011-01-23 08:27:54 +00001817 continue;
1818 }
1819
1820 if (MemIntrinsic *MI = dyn_cast<MemIntrinsic>(User)) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001821 ConstantInt *Length = dyn_cast<ConstantInt>(MI->getLength());
1822 uint64_t MemSize = Length->getZExtValue();
1823 if (Offset == 0 &&
1824 MemSize == TD->getTypeAllocSize(AI->getAllocatedType()))
1825 RewriteMemIntrinUserOfAlloca(MI, I, AI, NewElts);
Bob Wilsone88728d2009-12-19 06:53:17 +00001826 // Otherwise the intrinsic can only touch a single element and the
1827 // address operand will be updated, so nothing else needs to be done.
Chris Lattner145c5322011-01-23 08:27:54 +00001828 continue;
1829 }
1830
1831 if (LoadInst *LI = dyn_cast<LoadInst>(User)) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001832 const Type *LIType = LI->getType();
Chris Lattner192228e2011-01-16 05:28:59 +00001833
Bob Wilson704d1342011-01-13 17:45:11 +00001834 if (isCompatibleAggregate(LIType, AI->getAllocatedType())) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001835 // Replace:
1836 // %res = load { i32, i32 }* %alloc
1837 // with:
1838 // %load.0 = load i32* %alloc.0
1839 // %insert.0 insertvalue { i32, i32 } zeroinitializer, i32 %load.0, 0
1840 // %load.1 = load i32* %alloc.1
1841 // %insert = insertvalue { i32, i32 } %insert.0, i32 %load.1, 1
1842 // (Also works for arrays instead of structs)
1843 Value *Insert = UndefValue::get(LIType);
Devang Patelabb25122011-06-03 19:46:19 +00001844 IRBuilder<> Builder(LI);
Bob Wilsonb742def2009-12-18 20:14:40 +00001845 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
Devang Patelabb25122011-06-03 19:46:19 +00001846 Value *Load = Builder.CreateLoad(NewElts[i], "load");
1847 Insert = Builder.CreateInsertValue(Insert, Load, i, "insert");
Bob Wilsonb742def2009-12-18 20:14:40 +00001848 }
1849 LI->replaceAllUsesWith(Insert);
1850 DeadInsts.push_back(LI);
Duncan Sands1df98592010-02-16 11:11:14 +00001851 } else if (LIType->isIntegerTy() &&
Bob Wilsonb742def2009-12-18 20:14:40 +00001852 TD->getTypeAllocSize(LIType) ==
1853 TD->getTypeAllocSize(AI->getAllocatedType())) {
1854 // If this is a load of the entire alloca to an integer, rewrite it.
1855 RewriteLoadUserOfWholeAlloca(LI, AI, NewElts);
1856 }
Chris Lattner145c5322011-01-23 08:27:54 +00001857 continue;
1858 }
1859
1860 if (StoreInst *SI = dyn_cast<StoreInst>(User)) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001861 Value *Val = SI->getOperand(0);
1862 const Type *SIType = Val->getType();
Bob Wilson704d1342011-01-13 17:45:11 +00001863 if (isCompatibleAggregate(SIType, AI->getAllocatedType())) {
Bob Wilsonb742def2009-12-18 20:14:40 +00001864 // Replace:
1865 // store { i32, i32 } %val, { i32, i32 }* %alloc
1866 // with:
1867 // %val.0 = extractvalue { i32, i32 } %val, 0
1868 // store i32 %val.0, i32* %alloc.0
1869 // %val.1 = extractvalue { i32, i32 } %val, 1
1870 // store i32 %val.1, i32* %alloc.1
1871 // (Also works for arrays instead of structs)
Devang Patelabb25122011-06-03 19:46:19 +00001872 IRBuilder<> Builder(SI);
Bob Wilsonb742def2009-12-18 20:14:40 +00001873 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
Devang Patelabb25122011-06-03 19:46:19 +00001874 Value *Extract = Builder.CreateExtractValue(Val, i, Val->getName());
1875 Builder.CreateStore(Extract, NewElts[i]);
Bob Wilsonb742def2009-12-18 20:14:40 +00001876 }
1877 DeadInsts.push_back(SI);
Duncan Sands1df98592010-02-16 11:11:14 +00001878 } else if (SIType->isIntegerTy() &&
Bob Wilsonb742def2009-12-18 20:14:40 +00001879 TD->getTypeAllocSize(SIType) ==
1880 TD->getTypeAllocSize(AI->getAllocatedType())) {
1881 // If this is a store of the entire alloca from an integer, rewrite it.
1882 RewriteStoreUserOfWholeAlloca(SI, AI, NewElts);
1883 }
Chris Lattner145c5322011-01-23 08:27:54 +00001884 continue;
1885 }
1886
1887 if (isa<SelectInst>(User) || isa<PHINode>(User)) {
1888 // If we have a PHI user of the alloca itself (as opposed to a GEP or
1889 // bitcast) we have to rewrite it. GEP and bitcast uses will be RAUW'd to
1890 // the new pointer.
1891 if (!isa<AllocaInst>(I)) continue;
1892
1893 assert(Offset == 0 && NewElts[0] &&
1894 "Direct alloca use should have a zero offset");
1895
1896 // If we have a use of the alloca, we know the derived uses will be
1897 // utilizing just the first element of the scalarized result. Insert a
1898 // bitcast of the first alloca before the user as required.
1899 AllocaInst *NewAI = NewElts[0];
1900 BitCastInst *BCI = new BitCastInst(NewAI, AI->getType(), "", NewAI);
1901 NewAI->moveBefore(BCI);
1902 TheUse = BCI;
1903 continue;
Bob Wilsonb742def2009-12-18 20:14:40 +00001904 }
Bob Wilson39c88a62009-12-17 18:34:24 +00001905 }
1906}
1907
Bob Wilsonb742def2009-12-18 20:14:40 +00001908/// RewriteBitCast - Update a bitcast reference to the alloca being replaced
1909/// and recursively continue updating all of its uses.
1910void SROA::RewriteBitCast(BitCastInst *BC, AllocaInst *AI, uint64_t Offset,
1911 SmallVector<AllocaInst*, 32> &NewElts) {
1912 RewriteForScalarRepl(BC, AI, Offset, NewElts);
1913 if (BC->getOperand(0) != AI)
1914 return;
Bob Wilson39c88a62009-12-17 18:34:24 +00001915
Bob Wilsonb742def2009-12-18 20:14:40 +00001916 // The bitcast references the original alloca. Replace its uses with
1917 // references to the first new element alloca.
1918 Instruction *Val = NewElts[0];
1919 if (Val->getType() != BC->getDestTy()) {
1920 Val = new BitCastInst(Val, BC->getDestTy(), "", BC);
1921 Val->takeName(BC);
Daniel Dunbarfca55c82009-12-16 10:56:17 +00001922 }
Bob Wilsonb742def2009-12-18 20:14:40 +00001923 BC->replaceAllUsesWith(Val);
1924 DeadInsts.push_back(BC);
Daniel Dunbarfca55c82009-12-16 10:56:17 +00001925}
1926
Bob Wilsonb742def2009-12-18 20:14:40 +00001927/// FindElementAndOffset - Return the index of the element containing Offset
1928/// within the specified type, which must be either a struct or an array.
1929/// Sets T to the type of the element and Offset to the offset within that
Bob Wilsone88728d2009-12-19 06:53:17 +00001930/// element. IdxTy is set to the type of the index result to be used in a
1931/// GEP instruction.
1932uint64_t SROA::FindElementAndOffset(const Type *&T, uint64_t &Offset,
1933 const Type *&IdxTy) {
1934 uint64_t Idx = 0;
Bob Wilsonb742def2009-12-18 20:14:40 +00001935 if (const StructType *ST = dyn_cast<StructType>(T)) {
1936 const StructLayout *Layout = TD->getStructLayout(ST);
1937 Idx = Layout->getElementContainingOffset(Offset);
1938 T = ST->getContainedType(Idx);
1939 Offset -= Layout->getElementOffset(Idx);
Bob Wilsone88728d2009-12-19 06:53:17 +00001940 IdxTy = Type::getInt32Ty(T->getContext());
1941 return Idx;
Chris Lattnera59adc42009-12-14 05:11:02 +00001942 }
Bob Wilsone88728d2009-12-19 06:53:17 +00001943 const ArrayType *AT = cast<ArrayType>(T);
1944 T = AT->getElementType();
1945 uint64_t EltSize = TD->getTypeAllocSize(T);
1946 Idx = Offset / EltSize;
1947 Offset -= Idx * EltSize;
1948 IdxTy = Type::getInt64Ty(T->getContext());
Bob Wilsonb742def2009-12-18 20:14:40 +00001949 return Idx;
1950}
1951
1952/// RewriteGEP - Check if this GEP instruction moves the pointer across
1953/// elements of the alloca that are being split apart, and if so, rewrite
1954/// the GEP to be relative to the new element.
1955void SROA::RewriteGEP(GetElementPtrInst *GEPI, AllocaInst *AI, uint64_t Offset,
1956 SmallVector<AllocaInst*, 32> &NewElts) {
1957 uint64_t OldOffset = Offset;
1958 SmallVector<Value*, 8> Indices(GEPI->op_begin() + 1, GEPI->op_end());
1959 Offset += TD->getIndexedOffset(GEPI->getPointerOperandType(),
1960 &Indices[0], Indices.size());
1961
1962 RewriteForScalarRepl(GEPI, AI, Offset, NewElts);
1963
1964 const Type *T = AI->getAllocatedType();
Bob Wilsone88728d2009-12-19 06:53:17 +00001965 const Type *IdxTy;
1966 uint64_t OldIdx = FindElementAndOffset(T, OldOffset, IdxTy);
Bob Wilsonb742def2009-12-18 20:14:40 +00001967 if (GEPI->getOperand(0) == AI)
Bob Wilsone88728d2009-12-19 06:53:17 +00001968 OldIdx = ~0ULL; // Force the GEP to be rewritten.
Bob Wilsonb742def2009-12-18 20:14:40 +00001969
1970 T = AI->getAllocatedType();
1971 uint64_t EltOffset = Offset;
Bob Wilsone88728d2009-12-19 06:53:17 +00001972 uint64_t Idx = FindElementAndOffset(T, EltOffset, IdxTy);
Bob Wilsonb742def2009-12-18 20:14:40 +00001973
1974 // If this GEP does not move the pointer across elements of the alloca
1975 // being split, then it does not needs to be rewritten.
1976 if (Idx == OldIdx)
1977 return;
1978
1979 const Type *i32Ty = Type::getInt32Ty(AI->getContext());
1980 SmallVector<Value*, 8> NewArgs;
1981 NewArgs.push_back(Constant::getNullValue(i32Ty));
1982 while (EltOffset != 0) {
Bob Wilsone88728d2009-12-19 06:53:17 +00001983 uint64_t EltIdx = FindElementAndOffset(T, EltOffset, IdxTy);
1984 NewArgs.push_back(ConstantInt::get(IdxTy, EltIdx));
Bob Wilsonb742def2009-12-18 20:14:40 +00001985 }
1986 Instruction *Val = NewElts[Idx];
1987 if (NewArgs.size() > 1) {
1988 Val = GetElementPtrInst::CreateInBounds(Val, NewArgs.begin(),
1989 NewArgs.end(), "", GEPI);
1990 Val->takeName(GEPI);
1991 }
1992 if (Val->getType() != GEPI->getType())
Benjamin Kramer2d64ca02010-01-27 19:46:52 +00001993 Val = new BitCastInst(Val, GEPI->getType(), Val->getName(), GEPI);
Bob Wilsonb742def2009-12-18 20:14:40 +00001994 GEPI->replaceAllUsesWith(Val);
1995 DeadInsts.push_back(GEPI);
Chris Lattnerd93afec2009-01-07 07:18:45 +00001996}
1997
1998/// RewriteMemIntrinUserOfAlloca - MI is a memcpy/memset/memmove from or to AI.
1999/// Rewrite it to copy or set the elements of the scalarized memory.
Bob Wilsonb742def2009-12-18 20:14:40 +00002000void SROA::RewriteMemIntrinUserOfAlloca(MemIntrinsic *MI, Instruction *Inst,
Victor Hernandez7b929da2009-10-23 21:09:37 +00002001 AllocaInst *AI,
Chris Lattnerd93afec2009-01-07 07:18:45 +00002002 SmallVector<AllocaInst*, 32> &NewElts) {
Chris Lattnerd93afec2009-01-07 07:18:45 +00002003 // If this is a memcpy/memmove, construct the other pointer as the
Chris Lattner88fe1ad2009-03-04 19:23:25 +00002004 // appropriate type. The "Other" pointer is the pointer that goes to memory
2005 // that doesn't have anything to do with the alloca that we are promoting. For
2006 // memset, this Value* stays null.
Chris Lattnerd93afec2009-01-07 07:18:45 +00002007 Value *OtherPtr = 0;
Chris Lattnerdfe964c2009-03-08 03:59:00 +00002008 unsigned MemAlignment = MI->getAlignment();
Chris Lattner3ce5e882009-03-08 03:37:16 +00002009 if (MemTransferInst *MTI = dyn_cast<MemTransferInst>(MI)) { // memmove/memcopy
Bob Wilsonb742def2009-12-18 20:14:40 +00002010 if (Inst == MTI->getRawDest())
Chris Lattner3ce5e882009-03-08 03:37:16 +00002011 OtherPtr = MTI->getRawSource();
Chris Lattnerd93afec2009-01-07 07:18:45 +00002012 else {
Bob Wilsonb742def2009-12-18 20:14:40 +00002013 assert(Inst == MTI->getRawSource());
Chris Lattner3ce5e882009-03-08 03:37:16 +00002014 OtherPtr = MTI->getRawDest();
Chris Lattnerd93afec2009-01-07 07:18:45 +00002015 }
2016 }
Bob Wilson78c50b82009-12-08 18:22:03 +00002017
Chris Lattnerd93afec2009-01-07 07:18:45 +00002018 // If there is an other pointer, we want to convert it to the same pointer
2019 // type as AI has, so we can GEP through it safely.
2020 if (OtherPtr) {
Chris Lattner0238f8c2010-07-08 00:27:05 +00002021 unsigned AddrSpace =
2022 cast<PointerType>(OtherPtr->getType())->getAddressSpace();
Bob Wilsonb742def2009-12-18 20:14:40 +00002023
2024 // Remove bitcasts and all-zero GEPs from OtherPtr. This is an
2025 // optimization, but it's also required to detect the corner case where
2026 // both pointer operands are referencing the same memory, and where
2027 // OtherPtr may be a bitcast or GEP that currently being rewritten. (This
2028 // function is only called for mem intrinsics that access the whole
2029 // aggregate, so non-zero GEPs are not an issue here.)
Chris Lattner0238f8c2010-07-08 00:27:05 +00002030 OtherPtr = OtherPtr->stripPointerCasts();
Bob Wilson69743022011-01-13 20:59:44 +00002031
Bob Wilsona756b1d2010-01-19 04:32:48 +00002032 // Copying the alloca to itself is a no-op: just delete it.
2033 if (OtherPtr == AI || OtherPtr == NewElts[0]) {
2034 // This code will run twice for a no-op memcpy -- once for each operand.
2035 // Put only one reference to MI on the DeadInsts list.
2036 for (SmallVector<Value*, 32>::const_iterator I = DeadInsts.begin(),
2037 E = DeadInsts.end(); I != E; ++I)
2038 if (*I == MI) return;
2039 DeadInsts.push_back(MI);
Bob Wilsonb742def2009-12-18 20:14:40 +00002040 return;
Bob Wilsona756b1d2010-01-19 04:32:48 +00002041 }
Bob Wilson69743022011-01-13 20:59:44 +00002042
Chris Lattnerd93afec2009-01-07 07:18:45 +00002043 // If the pointer is not the right type, insert a bitcast to the right
2044 // type.
Chris Lattner0238f8c2010-07-08 00:27:05 +00002045 const Type *NewTy =
2046 PointerType::get(AI->getType()->getElementType(), AddrSpace);
Bob Wilson69743022011-01-13 20:59:44 +00002047
Chris Lattner0238f8c2010-07-08 00:27:05 +00002048 if (OtherPtr->getType() != NewTy)
2049 OtherPtr = new BitCastInst(OtherPtr, NewTy, OtherPtr->getName(), MI);
Chris Lattnerd93afec2009-01-07 07:18:45 +00002050 }
Bob Wilson69743022011-01-13 20:59:44 +00002051
Chris Lattnerd93afec2009-01-07 07:18:45 +00002052 // Process each element of the aggregate.
Bob Wilsonb742def2009-12-18 20:14:40 +00002053 bool SROADest = MI->getRawDest() == Inst;
Bob Wilson69743022011-01-13 20:59:44 +00002054
Owen Anderson1d0be152009-08-13 21:58:54 +00002055 Constant *Zero = Constant::getNullValue(Type::getInt32Ty(MI->getContext()));
Chris Lattnerd93afec2009-01-07 07:18:45 +00002056
2057 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
2058 // If this is a memcpy/memmove, emit a GEP of the other element address.
2059 Value *OtherElt = 0;
Chris Lattner1541e0f2009-03-04 19:20:50 +00002060 unsigned OtherEltAlign = MemAlignment;
Bob Wilson69743022011-01-13 20:59:44 +00002061
Bob Wilsona756b1d2010-01-19 04:32:48 +00002062 if (OtherPtr) {
Owen Anderson1d0be152009-08-13 21:58:54 +00002063 Value *Idx[2] = { Zero,
2064 ConstantInt::get(Type::getInt32Ty(MI->getContext()), i) };
Bob Wilsonb742def2009-12-18 20:14:40 +00002065 OtherElt = GetElementPtrInst::CreateInBounds(OtherPtr, Idx, Idx + 2,
Benjamin Kramer2d64ca02010-01-27 19:46:52 +00002066 OtherPtr->getName()+"."+Twine(i),
Bob Wilsonb742def2009-12-18 20:14:40 +00002067 MI);
Chris Lattner1541e0f2009-03-04 19:20:50 +00002068 uint64_t EltOffset;
2069 const PointerType *OtherPtrTy = cast<PointerType>(OtherPtr->getType());
Chris Lattnerd55c1c12010-04-16 01:05:38 +00002070 const Type *OtherTy = OtherPtrTy->getElementType();
2071 if (const StructType *ST = dyn_cast<StructType>(OtherTy)) {
Chris Lattner1541e0f2009-03-04 19:20:50 +00002072 EltOffset = TD->getStructLayout(ST)->getElementOffset(i);
2073 } else {
Chris Lattnerd55c1c12010-04-16 01:05:38 +00002074 const Type *EltTy = cast<SequentialType>(OtherTy)->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +00002075 EltOffset = TD->getTypeAllocSize(EltTy)*i;
Chris Lattner1541e0f2009-03-04 19:20:50 +00002076 }
Bob Wilson69743022011-01-13 20:59:44 +00002077
Chris Lattner1541e0f2009-03-04 19:20:50 +00002078 // The alignment of the other pointer is the guaranteed alignment of the
2079 // element, which is affected by both the known alignment of the whole
2080 // mem intrinsic and the alignment of the element. If the alignment of
2081 // the memcpy (f.e.) is 32 but the element is at a 4-byte offset, then the
2082 // known alignment is just 4 bytes.
2083 OtherEltAlign = (unsigned)MinAlign(OtherEltAlign, EltOffset);
Chris Lattnerc14d3ca2007-03-08 06:36:54 +00002084 }
Bob Wilson69743022011-01-13 20:59:44 +00002085
Chris Lattnerd93afec2009-01-07 07:18:45 +00002086 Value *EltPtr = NewElts[i];
Chris Lattner1541e0f2009-03-04 19:20:50 +00002087 const Type *EltTy = cast<PointerType>(EltPtr->getType())->getElementType();
Bob Wilson69743022011-01-13 20:59:44 +00002088
Chris Lattnerd93afec2009-01-07 07:18:45 +00002089 // If we got down to a scalar, insert a load or store as appropriate.
2090 if (EltTy->isSingleValueType()) {
Chris Lattner3ce5e882009-03-08 03:37:16 +00002091 if (isa<MemTransferInst>(MI)) {
Chris Lattner1541e0f2009-03-04 19:20:50 +00002092 if (SROADest) {
2093 // From Other to Alloca.
2094 Value *Elt = new LoadInst(OtherElt, "tmp", false, OtherEltAlign, MI);
2095 new StoreInst(Elt, EltPtr, MI);
2096 } else {
2097 // From Alloca to Other.
2098 Value *Elt = new LoadInst(EltPtr, "tmp", MI);
2099 new StoreInst(Elt, OtherElt, false, OtherEltAlign, MI);
2100 }
Chris Lattnerd93afec2009-01-07 07:18:45 +00002101 continue;
2102 }
2103 assert(isa<MemSetInst>(MI));
Bob Wilson69743022011-01-13 20:59:44 +00002104
Chris Lattnerd93afec2009-01-07 07:18:45 +00002105 // If the stored element is zero (common case), just store a null
2106 // constant.
2107 Constant *StoreVal;
Gabor Greif6f14c8c2010-06-30 09:16:16 +00002108 if (ConstantInt *CI = dyn_cast<ConstantInt>(MI->getArgOperand(1))) {
Chris Lattnerd93afec2009-01-07 07:18:45 +00002109 if (CI->isZero()) {
Owen Andersona7235ea2009-07-31 20:28:14 +00002110 StoreVal = Constant::getNullValue(EltTy); // 0.0, null, 0, <0,0>
Chris Lattnerd93afec2009-01-07 07:18:45 +00002111 } else {
2112 // If EltTy is a vector type, get the element type.
Dan Gohman44118f02009-06-16 00:20:26 +00002113 const Type *ValTy = EltTy->getScalarType();
2114
Chris Lattnerd93afec2009-01-07 07:18:45 +00002115 // Construct an integer with the right value.
2116 unsigned EltSize = TD->getTypeSizeInBits(ValTy);
2117 APInt OneVal(EltSize, CI->getZExtValue());
2118 APInt TotalVal(OneVal);
2119 // Set each byte.
2120 for (unsigned i = 0; 8*i < EltSize; ++i) {
2121 TotalVal = TotalVal.shl(8);
2122 TotalVal |= OneVal;
2123 }
Bob Wilson69743022011-01-13 20:59:44 +00002124
Chris Lattnerd93afec2009-01-07 07:18:45 +00002125 // Convert the integer value to the appropriate type.
Chris Lattnerd55c1c12010-04-16 01:05:38 +00002126 StoreVal = ConstantInt::get(CI->getContext(), TotalVal);
Duncan Sands1df98592010-02-16 11:11:14 +00002127 if (ValTy->isPointerTy())
Owen Andersonbaf3c402009-07-29 18:55:55 +00002128 StoreVal = ConstantExpr::getIntToPtr(StoreVal, ValTy);
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00002129 else if (ValTy->isFloatingPointTy())
Owen Andersonbaf3c402009-07-29 18:55:55 +00002130 StoreVal = ConstantExpr::getBitCast(StoreVal, ValTy);
Chris Lattnerd93afec2009-01-07 07:18:45 +00002131 assert(StoreVal->getType() == ValTy && "Type mismatch!");
Bob Wilson69743022011-01-13 20:59:44 +00002132
Chris Lattnerd93afec2009-01-07 07:18:45 +00002133 // If the requested value was a vector constant, create it.
2134 if (EltTy != ValTy) {
2135 unsigned NumElts = cast<VectorType>(ValTy)->getNumElements();
2136 SmallVector<Constant*, 16> Elts(NumElts, StoreVal);
Chris Lattner2ca5c862011-02-15 00:14:00 +00002137 StoreVal = ConstantVector::get(Elts);
Chris Lattnerd93afec2009-01-07 07:18:45 +00002138 }
2139 }
2140 new StoreInst(StoreVal, EltPtr, MI);
2141 continue;
2142 }
2143 // Otherwise, if we're storing a byte variable, use a memset call for
2144 // this element.
2145 }
Bob Wilson69743022011-01-13 20:59:44 +00002146
Duncan Sands777d2302009-05-09 07:06:46 +00002147 unsigned EltSize = TD->getTypeAllocSize(EltTy);
Bob Wilson69743022011-01-13 20:59:44 +00002148
Chris Lattner61db1f52010-12-26 22:57:41 +00002149 IRBuilder<> Builder(MI);
Bob Wilson69743022011-01-13 20:59:44 +00002150
Chris Lattnerd93afec2009-01-07 07:18:45 +00002151 // Finally, insert the meminst for this element.
Chris Lattner61db1f52010-12-26 22:57:41 +00002152 if (isa<MemSetInst>(MI)) {
2153 Builder.CreateMemSet(EltPtr, MI->getArgOperand(1), EltSize,
2154 MI->isVolatile());
Chris Lattnerd93afec2009-01-07 07:18:45 +00002155 } else {
Chris Lattner61db1f52010-12-26 22:57:41 +00002156 assert(isa<MemTransferInst>(MI));
2157 Value *Dst = SROADest ? EltPtr : OtherElt; // Dest ptr
2158 Value *Src = SROADest ? OtherElt : EltPtr; // Src ptr
Bob Wilson69743022011-01-13 20:59:44 +00002159
Chris Lattner61db1f52010-12-26 22:57:41 +00002160 if (isa<MemCpyInst>(MI))
2161 Builder.CreateMemCpy(Dst, Src, EltSize, OtherEltAlign,MI->isVolatile());
2162 else
2163 Builder.CreateMemMove(Dst, Src, EltSize,OtherEltAlign,MI->isVolatile());
Chris Lattnerd93afec2009-01-07 07:18:45 +00002164 }
Chris Lattner372dda82007-03-05 07:52:57 +00002165 }
Bob Wilsonb742def2009-12-18 20:14:40 +00002166 DeadInsts.push_back(MI);
Chris Lattner372dda82007-03-05 07:52:57 +00002167}
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002168
Bob Wilson39fdd692009-12-04 21:57:37 +00002169/// RewriteStoreUserOfWholeAlloca - We found a store of an integer that
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002170/// overwrites the entire allocation. Extract out the pieces of the stored
2171/// integer and store them individually.
Victor Hernandez7b929da2009-10-23 21:09:37 +00002172void SROA::RewriteStoreUserOfWholeAlloca(StoreInst *SI, AllocaInst *AI,
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002173 SmallVector<AllocaInst*, 32> &NewElts){
2174 // Extract each element out of the integer according to its structure offset
2175 // and store the element value to the individual alloca.
2176 Value *SrcVal = SI->getOperand(0);
Bob Wilsonb742def2009-12-18 20:14:40 +00002177 const Type *AllocaEltTy = AI->getAllocatedType();
Duncan Sands777d2302009-05-09 07:06:46 +00002178 uint64_t AllocaSizeBits = TD->getTypeAllocSizeInBits(AllocaEltTy);
Bob Wilson69743022011-01-13 20:59:44 +00002179
Chris Lattner70728532011-01-16 05:58:24 +00002180 IRBuilder<> Builder(SI);
2181
Eli Friedman41b33f42009-06-01 09:14:32 +00002182 // Handle tail padding by extending the operand
2183 if (TD->getTypeSizeInBits(SrcVal->getType()) != AllocaSizeBits)
Chris Lattner70728532011-01-16 05:58:24 +00002184 SrcVal = Builder.CreateZExt(SrcVal,
2185 IntegerType::get(SI->getContext(), AllocaSizeBits));
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002186
David Greene504c7d82010-01-05 01:27:09 +00002187 DEBUG(dbgs() << "PROMOTING STORE TO WHOLE ALLOCA: " << *AI << '\n' << *SI
Nick Lewycky59136252009-09-15 07:08:25 +00002188 << '\n');
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002189
2190 // There are two forms here: AI could be an array or struct. Both cases
2191 // have different ways to compute the element offset.
2192 if (const StructType *EltSTy = dyn_cast<StructType>(AllocaEltTy)) {
2193 const StructLayout *Layout = TD->getStructLayout(EltSTy);
Bob Wilson69743022011-01-13 20:59:44 +00002194
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002195 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
2196 // Get the number of bits to shift SrcVal to get the value.
2197 const Type *FieldTy = EltSTy->getElementType(i);
2198 uint64_t Shift = Layout->getElementOffsetInBits(i);
Bob Wilson69743022011-01-13 20:59:44 +00002199
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002200 if (TD->isBigEndian())
Duncan Sands777d2302009-05-09 07:06:46 +00002201 Shift = AllocaSizeBits-Shift-TD->getTypeAllocSizeInBits(FieldTy);
Bob Wilson69743022011-01-13 20:59:44 +00002202
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002203 Value *EltVal = SrcVal;
2204 if (Shift) {
Owen Andersoneed707b2009-07-24 23:12:02 +00002205 Value *ShiftVal = ConstantInt::get(EltVal->getType(), Shift);
Chris Lattner70728532011-01-16 05:58:24 +00002206 EltVal = Builder.CreateLShr(EltVal, ShiftVal, "sroa.store.elt");
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002207 }
Bob Wilson69743022011-01-13 20:59:44 +00002208
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002209 // Truncate down to an integer of the right size.
2210 uint64_t FieldSizeBits = TD->getTypeSizeInBits(FieldTy);
Bob Wilson69743022011-01-13 20:59:44 +00002211
Chris Lattner583dd602009-01-09 18:18:43 +00002212 // Ignore zero sized fields like {}, they obviously contain no data.
2213 if (FieldSizeBits == 0) continue;
Bob Wilson69743022011-01-13 20:59:44 +00002214
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002215 if (FieldSizeBits != AllocaSizeBits)
Chris Lattner70728532011-01-16 05:58:24 +00002216 EltVal = Builder.CreateTrunc(EltVal,
2217 IntegerType::get(SI->getContext(), FieldSizeBits));
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002218 Value *DestField = NewElts[i];
2219 if (EltVal->getType() == FieldTy) {
2220 // Storing to an integer field of this size, just do it.
Duncan Sands1df98592010-02-16 11:11:14 +00002221 } else if (FieldTy->isFloatingPointTy() || FieldTy->isVectorTy()) {
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002222 // Bitcast to the right element type (for fp/vector values).
Chris Lattner70728532011-01-16 05:58:24 +00002223 EltVal = Builder.CreateBitCast(EltVal, FieldTy);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002224 } else {
2225 // Otherwise, bitcast the dest pointer (for aggregates).
Chris Lattner70728532011-01-16 05:58:24 +00002226 DestField = Builder.CreateBitCast(DestField,
2227 PointerType::getUnqual(EltVal->getType()));
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002228 }
2229 new StoreInst(EltVal, DestField, SI);
2230 }
Bob Wilson69743022011-01-13 20:59:44 +00002231
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002232 } else {
2233 const ArrayType *ATy = cast<ArrayType>(AllocaEltTy);
2234 const Type *ArrayEltTy = ATy->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +00002235 uint64_t ElementOffset = TD->getTypeAllocSizeInBits(ArrayEltTy);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002236 uint64_t ElementSizeBits = TD->getTypeSizeInBits(ArrayEltTy);
2237
2238 uint64_t Shift;
Bob Wilson69743022011-01-13 20:59:44 +00002239
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002240 if (TD->isBigEndian())
2241 Shift = AllocaSizeBits-ElementOffset;
Bob Wilson69743022011-01-13 20:59:44 +00002242 else
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002243 Shift = 0;
Bob Wilson69743022011-01-13 20:59:44 +00002244
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002245 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
Chris Lattner583dd602009-01-09 18:18:43 +00002246 // Ignore zero sized fields like {}, they obviously contain no data.
2247 if (ElementSizeBits == 0) continue;
Bob Wilson69743022011-01-13 20:59:44 +00002248
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002249 Value *EltVal = SrcVal;
2250 if (Shift) {
Owen Andersoneed707b2009-07-24 23:12:02 +00002251 Value *ShiftVal = ConstantInt::get(EltVal->getType(), Shift);
Chris Lattner70728532011-01-16 05:58:24 +00002252 EltVal = Builder.CreateLShr(EltVal, ShiftVal, "sroa.store.elt");
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002253 }
Bob Wilson69743022011-01-13 20:59:44 +00002254
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002255 // Truncate down to an integer of the right size.
2256 if (ElementSizeBits != AllocaSizeBits)
Chris Lattner70728532011-01-16 05:58:24 +00002257 EltVal = Builder.CreateTrunc(EltVal,
2258 IntegerType::get(SI->getContext(),
2259 ElementSizeBits));
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002260 Value *DestField = NewElts[i];
2261 if (EltVal->getType() == ArrayEltTy) {
2262 // Storing to an integer field of this size, just do it.
Duncan Sandsb0bc6c32010-02-15 16:12:20 +00002263 } else if (ArrayEltTy->isFloatingPointTy() ||
Duncan Sands1df98592010-02-16 11:11:14 +00002264 ArrayEltTy->isVectorTy()) {
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002265 // Bitcast to the right element type (for fp/vector values).
Chris Lattner70728532011-01-16 05:58:24 +00002266 EltVal = Builder.CreateBitCast(EltVal, ArrayEltTy);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002267 } else {
2268 // Otherwise, bitcast the dest pointer (for aggregates).
Chris Lattner70728532011-01-16 05:58:24 +00002269 DestField = Builder.CreateBitCast(DestField,
2270 PointerType::getUnqual(EltVal->getType()));
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002271 }
2272 new StoreInst(EltVal, DestField, SI);
Bob Wilson69743022011-01-13 20:59:44 +00002273
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002274 if (TD->isBigEndian())
2275 Shift -= ElementOffset;
Bob Wilson69743022011-01-13 20:59:44 +00002276 else
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002277 Shift += ElementOffset;
2278 }
2279 }
Bob Wilson69743022011-01-13 20:59:44 +00002280
Bob Wilsonb742def2009-12-18 20:14:40 +00002281 DeadInsts.push_back(SI);
Chris Lattnerd2fa7812009-01-07 08:11:13 +00002282}
2283
Bob Wilson39fdd692009-12-04 21:57:37 +00002284/// RewriteLoadUserOfWholeAlloca - We found a load of the entire allocation to
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002285/// an integer. Load the individual pieces to form the aggregate value.
Victor Hernandez7b929da2009-10-23 21:09:37 +00002286void SROA::RewriteLoadUserOfWholeAlloca(LoadInst *LI, AllocaInst *AI,
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002287 SmallVector<AllocaInst*, 32> &NewElts) {
2288 // Extract each element out of the NewElts according to its structure offset
2289 // and form the result value.
Bob Wilsonb742def2009-12-18 20:14:40 +00002290 const Type *AllocaEltTy = AI->getAllocatedType();
Duncan Sands777d2302009-05-09 07:06:46 +00002291 uint64_t AllocaSizeBits = TD->getTypeAllocSizeInBits(AllocaEltTy);
Bob Wilson69743022011-01-13 20:59:44 +00002292
David Greene504c7d82010-01-05 01:27:09 +00002293 DEBUG(dbgs() << "PROMOTING LOAD OF WHOLE ALLOCA: " << *AI << '\n' << *LI
Nick Lewycky59136252009-09-15 07:08:25 +00002294 << '\n');
Bob Wilson69743022011-01-13 20:59:44 +00002295
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002296 // There are two forms here: AI could be an array or struct. Both cases
2297 // have different ways to compute the element offset.
2298 const StructLayout *Layout = 0;
2299 uint64_t ArrayEltBitOffset = 0;
2300 if (const StructType *EltSTy = dyn_cast<StructType>(AllocaEltTy)) {
2301 Layout = TD->getStructLayout(EltSTy);
2302 } else {
2303 const Type *ArrayEltTy = cast<ArrayType>(AllocaEltTy)->getElementType();
Duncan Sands777d2302009-05-09 07:06:46 +00002304 ArrayEltBitOffset = TD->getTypeAllocSizeInBits(ArrayEltTy);
Bob Wilson69743022011-01-13 20:59:44 +00002305 }
2306
2307 Value *ResultVal =
Owen Anderson1d0be152009-08-13 21:58:54 +00002308 Constant::getNullValue(IntegerType::get(LI->getContext(), AllocaSizeBits));
Bob Wilson69743022011-01-13 20:59:44 +00002309
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002310 for (unsigned i = 0, e = NewElts.size(); i != e; ++i) {
2311 // Load the value from the alloca. If the NewElt is an aggregate, cast
2312 // the pointer to an integer of the same size before doing the load.
2313 Value *SrcField = NewElts[i];
2314 const Type *FieldTy =
2315 cast<PointerType>(SrcField->getType())->getElementType();
Chris Lattner583dd602009-01-09 18:18:43 +00002316 uint64_t FieldSizeBits = TD->getTypeSizeInBits(FieldTy);
Bob Wilson69743022011-01-13 20:59:44 +00002317
Chris Lattner583dd602009-01-09 18:18:43 +00002318 // Ignore zero sized fields like {}, they obviously contain no data.
2319 if (FieldSizeBits == 0) continue;
Bob Wilson69743022011-01-13 20:59:44 +00002320
2321 const IntegerType *FieldIntTy = IntegerType::get(LI->getContext(),
Owen Anderson1d0be152009-08-13 21:58:54 +00002322 FieldSizeBits);
Duncan Sands1df98592010-02-16 11:11:14 +00002323 if (!FieldTy->isIntegerTy() && !FieldTy->isFloatingPointTy() &&
2324 !FieldTy->isVectorTy())
Owen Andersonfa5cbd62009-07-03 19:42:02 +00002325 SrcField = new BitCastInst(SrcField,
Owen Andersondebcb012009-07-29 22:17:13 +00002326 PointerType::getUnqual(FieldIntTy),
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002327 "", LI);
2328 SrcField = new LoadInst(SrcField, "sroa.load.elt", LI);
2329
2330 // If SrcField is a fp or vector of the right size but that isn't an
2331 // integer type, bitcast to an integer so we can shift it.
2332 if (SrcField->getType() != FieldIntTy)
2333 SrcField = new BitCastInst(SrcField, FieldIntTy, "", LI);
2334
2335 // Zero extend the field to be the same size as the final alloca so that
2336 // we can shift and insert it.
2337 if (SrcField->getType() != ResultVal->getType())
2338 SrcField = new ZExtInst(SrcField, ResultVal->getType(), "", LI);
Bob Wilson69743022011-01-13 20:59:44 +00002339
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002340 // Determine the number of bits to shift SrcField.
2341 uint64_t Shift;
2342 if (Layout) // Struct case.
2343 Shift = Layout->getElementOffsetInBits(i);
2344 else // Array case.
2345 Shift = i*ArrayEltBitOffset;
Bob Wilson69743022011-01-13 20:59:44 +00002346
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002347 if (TD->isBigEndian())
2348 Shift = AllocaSizeBits-Shift-FieldIntTy->getBitWidth();
Bob Wilson69743022011-01-13 20:59:44 +00002349
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002350 if (Shift) {
Owen Andersoneed707b2009-07-24 23:12:02 +00002351 Value *ShiftVal = ConstantInt::get(SrcField->getType(), Shift);
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002352 SrcField = BinaryOperator::CreateShl(SrcField, ShiftVal, "", LI);
2353 }
2354
Chris Lattner14952472010-06-27 07:58:26 +00002355 // Don't create an 'or x, 0' on the first iteration.
2356 if (!isa<Constant>(ResultVal) ||
2357 !cast<Constant>(ResultVal)->isNullValue())
2358 ResultVal = BinaryOperator::CreateOr(SrcField, ResultVal, "", LI);
2359 else
2360 ResultVal = SrcField;
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002361 }
Eli Friedman41b33f42009-06-01 09:14:32 +00002362
2363 // Handle tail padding by truncating the result
2364 if (TD->getTypeSizeInBits(LI->getType()) != AllocaSizeBits)
2365 ResultVal = new TruncInst(ResultVal, LI->getType(), "", LI);
2366
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002367 LI->replaceAllUsesWith(ResultVal);
Bob Wilsonb742def2009-12-18 20:14:40 +00002368 DeadInsts.push_back(LI);
Chris Lattner5ffe6ac2009-01-08 05:42:05 +00002369}
2370
Duncan Sands3cb36502007-11-04 14:43:57 +00002371/// HasPadding - Return true if the specified type has any structure or
Bob Wilson694a10e2011-01-13 17:45:08 +00002372/// alignment padding in between the elements that would be split apart
2373/// by SROA; return false otherwise.
Duncan Sandsa0fcc082008-06-04 08:21:45 +00002374static bool HasPadding(const Type *Ty, const TargetData &TD) {
Bob Wilson694a10e2011-01-13 17:45:08 +00002375 if (const ArrayType *ATy = dyn_cast<ArrayType>(Ty)) {
2376 Ty = ATy->getElementType();
2377 return TD.getTypeSizeInBits(Ty) != TD.getTypeAllocSizeInBits(Ty);
Chris Lattner39a1c042007-05-30 06:11:23 +00002378 }
Bob Wilson694a10e2011-01-13 17:45:08 +00002379
2380 // SROA currently handles only Arrays and Structs.
2381 const StructType *STy = cast<StructType>(Ty);
2382 const StructLayout *SL = TD.getStructLayout(STy);
2383 unsigned PrevFieldBitOffset = 0;
2384 for (unsigned i = 0, e = STy->getNumElements(); i != e; ++i) {
2385 unsigned FieldBitOffset = SL->getElementOffsetInBits(i);
2386
2387 // Check to see if there is any padding between this element and the
2388 // previous one.
2389 if (i) {
2390 unsigned PrevFieldEnd =
2391 PrevFieldBitOffset+TD.getTypeSizeInBits(STy->getElementType(i-1));
2392 if (PrevFieldEnd < FieldBitOffset)
2393 return true;
2394 }
2395 PrevFieldBitOffset = FieldBitOffset;
2396 }
2397 // Check for tail padding.
2398 if (unsigned EltCount = STy->getNumElements()) {
2399 unsigned PrevFieldEnd = PrevFieldBitOffset +
2400 TD.getTypeSizeInBits(STy->getElementType(EltCount-1));
2401 if (PrevFieldEnd < SL->getSizeInBits())
2402 return true;
2403 }
2404 return false;
Chris Lattner39a1c042007-05-30 06:11:23 +00002405}
Chris Lattner372dda82007-03-05 07:52:57 +00002406
Chris Lattnerf5990ed2004-11-14 04:24:28 +00002407/// isSafeStructAllocaToScalarRepl - Check to see if the specified allocation of
2408/// an aggregate can be broken down into elements. Return 0 if not, 3 if safe,
2409/// or 1 if safe after canonicalization has been performed.
Victor Hernandez6c146ee2010-01-21 23:05:53 +00002410bool SROA::isSafeAllocaToScalarRepl(AllocaInst *AI) {
Chris Lattner5e062a12003-05-30 04:15:41 +00002411 // Loop over the use list of the alloca. We can only transform it if all of
2412 // the users are safe to transform.
Chris Lattner6c95d242011-01-23 07:29:29 +00002413 AllocaInfo Info(AI);
Bob Wilson69743022011-01-13 20:59:44 +00002414
Chris Lattner6c95d242011-01-23 07:29:29 +00002415 isSafeForScalarRepl(AI, 0, Info);
Bob Wilsonb742def2009-12-18 20:14:40 +00002416 if (Info.isUnsafe) {
David Greene504c7d82010-01-05 01:27:09 +00002417 DEBUG(dbgs() << "Cannot transform: " << *AI << '\n');
Victor Hernandez6c146ee2010-01-21 23:05:53 +00002418 return false;
Chris Lattnerf5990ed2004-11-14 04:24:28 +00002419 }
Bob Wilson69743022011-01-13 20:59:44 +00002420
Chris Lattner39a1c042007-05-30 06:11:23 +00002421 // Okay, we know all the users are promotable. If the aggregate is a memcpy
2422 // source and destination, we have to be careful. In particular, the memcpy
2423 // could be moving around elements that live in structure padding of the LLVM
2424 // types, but may actually be used. In these cases, we refuse to promote the
2425 // struct.
2426 if (Info.isMemCpySrc && Info.isMemCpyDst &&
Bob Wilsonb742def2009-12-18 20:14:40 +00002427 HasPadding(AI->getAllocatedType(), *TD))
Victor Hernandez6c146ee2010-01-21 23:05:53 +00002428 return false;
Duncan Sands3cb36502007-11-04 14:43:57 +00002429
Chris Lattner396a0562011-01-16 17:46:19 +00002430 // If the alloca never has an access to just *part* of it, but is accessed
2431 // via loads and stores, then we should use ConvertToScalarInfo to promote
Chris Lattner7e9b4272011-01-16 06:18:28 +00002432 // the alloca instead of promoting each piece at a time and inserting fission
2433 // and fusion code.
2434 if (!Info.hasSubelementAccess && Info.hasALoadOrStore) {
2435 // If the struct/array just has one element, use basic SRoA.
2436 if (const StructType *ST = dyn_cast<StructType>(AI->getAllocatedType())) {
2437 if (ST->getNumElements() > 1) return false;
2438 } else {
2439 if (cast<ArrayType>(AI->getAllocatedType())->getNumElements() > 1)
2440 return false;
2441 }
2442 }
Chris Lattner145c5322011-01-23 08:27:54 +00002443
Victor Hernandez6c146ee2010-01-21 23:05:53 +00002444 return true;
Chris Lattner5e062a12003-05-30 04:15:41 +00002445}
Chris Lattnera1888942005-12-12 07:19:13 +00002446
Chris Lattner800de312008-02-29 07:03:13 +00002447
Chris Lattner79b3bd32007-04-25 06:40:51 +00002448
2449/// PointsToConstantGlobal - Return true if V (possibly indirectly) points to
2450/// some part of a constant global variable. This intentionally only accepts
2451/// constant expressions because we don't can't rewrite arbitrary instructions.
2452static bool PointsToConstantGlobal(Value *V) {
2453 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V))
2454 return GV->isConstant();
2455 if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
Bob Wilson69743022011-01-13 20:59:44 +00002456 if (CE->getOpcode() == Instruction::BitCast ||
Chris Lattner79b3bd32007-04-25 06:40:51 +00002457 CE->getOpcode() == Instruction::GetElementPtr)
2458 return PointsToConstantGlobal(CE->getOperand(0));
2459 return false;
2460}
2461
2462/// isOnlyCopiedFromConstantGlobal - Recursively walk the uses of a (derived)
2463/// pointer to an alloca. Ignore any reads of the pointer, return false if we
2464/// see any stores or other unknown uses. If we see pointer arithmetic, keep
2465/// track of whether it moves the pointer (with isOffset) but otherwise traverse
2466/// the uses. If we see a memcpy/memmove that targets an unoffseted pointer to
Nick Lewycky081f8002010-11-24 22:04:20 +00002467/// the alloca, and if the source pointer is a pointer to a constant global, we
Chris Lattner79b3bd32007-04-25 06:40:51 +00002468/// can optimize this.
Chris Lattner31d80102010-04-15 21:59:20 +00002469static bool isOnlyCopiedFromConstantGlobal(Value *V, MemTransferInst *&TheCopy,
Chris Lattner79b3bd32007-04-25 06:40:51 +00002470 bool isOffset) {
2471 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI!=E; ++UI) {
Gabor Greif8a8a4352010-04-06 19:32:30 +00002472 User *U = cast<Instruction>(*UI);
2473
Chris Lattner2e618492010-11-18 06:20:47 +00002474 if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Chris Lattner6e733d32009-01-28 20:16:43 +00002475 // Ignore non-volatile loads, they are always ok.
Chris Lattner2e618492010-11-18 06:20:47 +00002476 if (LI->isVolatile()) return false;
2477 continue;
2478 }
Bob Wilson69743022011-01-13 20:59:44 +00002479
Gabor Greif8a8a4352010-04-06 19:32:30 +00002480 if (BitCastInst *BCI = dyn_cast<BitCastInst>(U)) {
Chris Lattner79b3bd32007-04-25 06:40:51 +00002481 // If uses of the bitcast are ok, we are ok.
2482 if (!isOnlyCopiedFromConstantGlobal(BCI, TheCopy, isOffset))
2483 return false;
2484 continue;
2485 }
Gabor Greif8a8a4352010-04-06 19:32:30 +00002486 if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(U)) {
Chris Lattner79b3bd32007-04-25 06:40:51 +00002487 // If the GEP has all zero indices, it doesn't offset the pointer. If it
2488 // doesn't, it does.
2489 if (!isOnlyCopiedFromConstantGlobal(GEP, TheCopy,
2490 isOffset || !GEP->hasAllZeroIndices()))
2491 return false;
2492 continue;
2493 }
Bob Wilson69743022011-01-13 20:59:44 +00002494
Chris Lattner62480652010-11-18 06:41:51 +00002495 if (CallSite CS = U) {
Nick Lewycky081f8002010-11-24 22:04:20 +00002496 // If this is the function being called then we treat it like a load and
2497 // ignore it.
2498 if (CS.isCallee(UI))
2499 continue;
Bob Wilson69743022011-01-13 20:59:44 +00002500
Duncan Sands53892102011-05-06 10:30:37 +00002501 // If this is a readonly/readnone call site, then we know it is just a
2502 // load (but one that potentially returns the value itself), so we can
2503 // ignore it if we know that the value isn't captured.
2504 unsigned ArgNo = CS.getArgumentNo(UI);
2505 if (CS.onlyReadsMemory() &&
2506 (CS.getInstruction()->use_empty() ||
2507 CS.paramHasAttr(ArgNo+1, Attribute::NoCapture)))
2508 continue;
2509
Chris Lattner62480652010-11-18 06:41:51 +00002510 // If this is being passed as a byval argument, the caller is making a
2511 // copy, so it is only a read of the alloca.
Chris Lattner62480652010-11-18 06:41:51 +00002512 if (CS.paramHasAttr(ArgNo+1, Attribute::ByVal))
2513 continue;
2514 }
Bob Wilson69743022011-01-13 20:59:44 +00002515
Chris Lattner79b3bd32007-04-25 06:40:51 +00002516 // If this is isn't our memcpy/memmove, reject it as something we can't
2517 // handle.
Chris Lattner31d80102010-04-15 21:59:20 +00002518 MemTransferInst *MI = dyn_cast<MemTransferInst>(U);
2519 if (MI == 0)
Chris Lattner79b3bd32007-04-25 06:40:51 +00002520 return false;
Bob Wilson69743022011-01-13 20:59:44 +00002521
Chris Lattner2e618492010-11-18 06:20:47 +00002522 // If the transfer is using the alloca as a source of the transfer, then
Chris Lattner2e29ebd2010-11-18 07:32:33 +00002523 // ignore it since it is a load (unless the transfer is volatile).
Chris Lattner2e618492010-11-18 06:20:47 +00002524 if (UI.getOperandNo() == 1) {
2525 if (MI->isVolatile()) return false;
2526 continue;
2527 }
Chris Lattner79b3bd32007-04-25 06:40:51 +00002528
2529 // If we already have seen a copy, reject the second one.
2530 if (TheCopy) return false;
Bob Wilson69743022011-01-13 20:59:44 +00002531
Chris Lattner79b3bd32007-04-25 06:40:51 +00002532 // If the pointer has been offset from the start of the alloca, we can't
2533 // safely handle this.
2534 if (isOffset) return false;
2535
2536 // If the memintrinsic isn't using the alloca as the dest, reject it.
Gabor Greifa6aac4c2010-07-16 09:38:02 +00002537 if (UI.getOperandNo() != 0) return false;
Bob Wilson69743022011-01-13 20:59:44 +00002538
Chris Lattner79b3bd32007-04-25 06:40:51 +00002539 // If the source of the memcpy/move is not a constant global, reject it.
Chris Lattner31d80102010-04-15 21:59:20 +00002540 if (!PointsToConstantGlobal(MI->getSource()))
Chris Lattner79b3bd32007-04-25 06:40:51 +00002541 return false;
Bob Wilson69743022011-01-13 20:59:44 +00002542
Chris Lattner79b3bd32007-04-25 06:40:51 +00002543 // Otherwise, the transform is safe. Remember the copy instruction.
2544 TheCopy = MI;
2545 }
2546 return true;
2547}
2548
2549/// isOnlyCopiedFromConstantGlobal - Return true if the specified alloca is only
2550/// modified by a copy from a constant global. If we can prove this, we can
2551/// replace any uses of the alloca with uses of the global directly.
Chris Lattner31d80102010-04-15 21:59:20 +00002552MemTransferInst *SROA::isOnlyCopiedFromConstantGlobal(AllocaInst *AI) {
2553 MemTransferInst *TheCopy = 0;
Chris Lattner79b3bd32007-04-25 06:40:51 +00002554 if (::isOnlyCopiedFromConstantGlobal(AI, TheCopy, false))
2555 return TheCopy;
2556 return 0;
2557}