1 //===-- StructRetPromotion.cpp - Promote sret arguments ------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This pass finds functions that return a struct (using a pointer to the struct
11 // as the first argument of the function, marked with the 'sret' attribute) and
12 // replaces them with a new function that simply returns each of the elements of
13 // that struct (using multiple return values).
15 // This pass works under a number of conditions:
16 // 1. The returned struct must not contain other structs
17 // 2. The returned struct must only be used to load values from
18 // 3. The placeholder struct passed in is the result of an alloca
20 //===----------------------------------------------------------------------===//
22 #define DEBUG_TYPE "sretpromotion"
23 #include "llvm/Transforms/IPO.h"
24 #include "llvm/Constants.h"
25 #include "llvm/DerivedTypes.h"
26 #include "llvm/Module.h"
27 #include "llvm/CallGraphSCCPass.h"
28 #include "llvm/Instructions.h"
29 #include "llvm/Analysis/CallGraph.h"
30 #include "llvm/Support/CallSite.h"
31 #include "llvm/Support/CFG.h"
32 #include "llvm/Support/Debug.h"
33 #include "llvm/ADT/Statistic.h"
34 #include "llvm/ADT/SmallVector.h"
35 #include "llvm/ADT/Statistic.h"
36 #include "llvm/Support/Compiler.h"
39 STATISTIC(NumRejectedSRETUses , "Number of sret rejected due to unexpected uses");
40 STATISTIC(NumSRET , "Number of sret promoted");
42 /// SRETPromotion - This pass removes sret parameter and updates
43 /// function to use multiple return value.
45 struct VISIBILITY_HIDDEN SRETPromotion : public CallGraphSCCPass {
46 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
47 CallGraphSCCPass::getAnalysisUsage(AU);
50 virtual bool runOnSCC(const std::vector<CallGraphNode *> &SCC);
51 static char ID; // Pass identification, replacement for typeid
52 SRETPromotion() : CallGraphSCCPass((intptr_t)&ID) {}
55 bool PromoteReturn(CallGraphNode *CGN);
56 bool isSafeToUpdateAllCallers(Function *F);
57 Function *cloneFunctionBody(Function *F, const StructType *STy);
58 void updateCallSites(Function *F, Function *NF);
59 bool nestedStructType(const StructType *STy);
63 char SRETPromotion::ID = 0;
64 static RegisterPass<SRETPromotion>
65 X("sretpromotion", "Promote sret arguments to multiple ret values");
67 Pass *llvm::createStructRetPromotionPass() {
68 return new SRETPromotion();
71 bool SRETPromotion::runOnSCC(const std::vector<CallGraphNode *> &SCC) {
74 for (unsigned i = 0, e = SCC.size(); i != e; ++i)
75 Changed |= PromoteReturn(SCC[i]);
80 /// PromoteReturn - This method promotes function that uses StructRet paramater
81 /// into a function that uses mulitple return value.
82 bool SRETPromotion::PromoteReturn(CallGraphNode *CGN) {
83 Function *F = CGN->getFunction();
85 if (!F || F->isDeclaration() || !F->hasInternalLinkage())
88 // Make sure that function returns struct.
89 if (F->arg_size() == 0 || !F->hasStructRetAttr() || F->doesNotReturn())
92 assert (F->getReturnType() == Type::VoidTy && "Invalid function return type");
93 Function::arg_iterator AI = F->arg_begin();
94 const llvm::PointerType *FArgType = dyn_cast<PointerType>(AI->getType());
95 assert (FArgType && "Invalid sret parameter type");
96 const llvm::StructType *STy =
97 dyn_cast<StructType>(FArgType->getElementType());
98 assert (STy && "Invalid sret parameter element type");
100 if (nestedStructType(STy))
103 // Check if it is ok to perform this promotion.
104 if (isSafeToUpdateAllCallers(F) == false) {
105 NumRejectedSRETUses++;
110 // [1] Replace use of sret parameter
111 AllocaInst *TheAlloca = new AllocaInst (STy, NULL, "mrv",
112 F->getEntryBlock().begin());
113 Value *NFirstArg = F->arg_begin();
114 NFirstArg->replaceAllUsesWith(TheAlloca);
116 // [2] Find and replace ret instructions
117 SmallVector<Value *,4> RetVals;
118 for (Function::iterator FI = F->begin(), FE = F->end(); FI != FE; ++FI)
119 for(BasicBlock::iterator BI = FI->begin(), BE = FI->end(); BI != BE; ) {
122 if (isa<ReturnInst>(I)) {
124 for (unsigned idx = 0; idx < STy->getNumElements(); ++idx) {
125 SmallVector<Value*, 2> GEPIdx;
126 GEPIdx.push_back(ConstantInt::get(Type::Int32Ty, 0));
127 GEPIdx.push_back(ConstantInt::get(Type::Int32Ty, idx));
128 Value *NGEPI = GetElementPtrInst::Create(TheAlloca, GEPIdx.begin(),
131 Value *NV = new LoadInst(NGEPI, "mrv.ld", I);
132 RetVals.push_back(NV);
135 ReturnInst *NR = ReturnInst::Create(&RetVals[0], RetVals.size(), I);
136 I->replaceAllUsesWith(NR);
137 I->eraseFromParent();
141 // [3] Create the new function body and insert it into the module.
142 Function *NF = cloneFunctionBody(F, STy);
144 // [4] Update all call sites to use new function
145 updateCallSites(F, NF);
147 F->eraseFromParent();
148 getAnalysis<CallGraph>().changeFunction(F, NF);
152 // Check if it is ok to perform this promotion.
153 bool SRETPromotion::isSafeToUpdateAllCallers(Function *F) {
156 // No users. OK to modify signature.
159 for (Value::use_iterator FnUseI = F->use_begin(), FnUseE = F->use_end();
160 FnUseI != FnUseE; ++FnUseI) {
161 // The function is passed in as an argument to (possibly) another function,
162 // we can't change it!
163 if (FnUseI.getOperandNo() != 0)
166 CallSite CS = CallSite::get(*FnUseI);
167 Instruction *Call = CS.getInstruction();
168 CallSite::arg_iterator AI = CS.arg_begin();
169 Value *FirstArg = *AI;
171 if (!isa<AllocaInst>(FirstArg))
174 // Check FirstArg's users.
175 for (Value::use_iterator ArgI = FirstArg->use_begin(),
176 ArgE = FirstArg->use_end(); ArgI != ArgE; ++ArgI) {
178 // If FirstArg user is a CallInst that does not correspond to current
179 // call site then this function F is not suitable for sret promotion.
180 if (CallInst *CI = dyn_cast<CallInst>(ArgI)) {
184 // If FirstArg user is a GEP whose all users are not LoadInst then
185 // this function F is not suitable for sret promotion.
186 else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(ArgI)) {
187 // TODO : Use dom info and insert PHINodes to collect get results
188 // from multiple call sites for this GEP.
189 if (GEP->getParent() != Call->getParent())
191 for (Value::use_iterator GEPI = GEP->use_begin(), GEPE = GEP->use_end();
192 GEPI != GEPE; ++GEPI)
193 if (!isa<LoadInst>(GEPI))
196 // Any other FirstArg users make this function unsuitable for sret
206 /// cloneFunctionBody - Create a new function based on F and
207 /// insert it into module. Remove first argument. Use STy as
208 /// the return type for new function.
209 Function *SRETPromotion::cloneFunctionBody(Function *F,
210 const StructType *STy) {
212 const FunctionType *FTy = F->getFunctionType();
213 std::vector<const Type*> Params;
215 // ParamAttrs - Keep track of the parameter attributes for the arguments.
216 SmallVector<ParamAttrsWithIndex, 8> ParamAttrsVec;
217 const PAListPtr &PAL = F->getParamAttrs();
219 // Add any return attributes.
220 if (ParameterAttributes attrs = PAL.getParamAttrs(0))
221 ParamAttrsVec.push_back(ParamAttrsWithIndex::get(0, attrs));
223 // Skip first argument.
224 Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
226 // 0th parameter attribute is reserved for return type.
227 // 1th parameter attribute is for first 1st sret argument.
228 unsigned ParamIndex = 2;
230 Params.push_back(I->getType());
231 if (ParameterAttributes Attrs = PAL.getParamAttrs(ParamIndex))
232 ParamAttrsVec.push_back(ParamAttrsWithIndex::get(ParamIndex - 1, Attrs));
237 FunctionType *NFTy = FunctionType::get(STy, Params, FTy->isVarArg());
238 Function *NF = Function::Create(NFTy, F->getLinkage(), F->getName());
239 NF->copyAttributesFrom(F);
240 NF->setParamAttrs(PAListPtr::get(ParamAttrsVec.begin(), ParamAttrsVec.end()));
241 F->getParent()->getFunctionList().insert(F, NF);
242 NF->getBasicBlockList().splice(NF->begin(), F->getBasicBlockList());
247 Function::arg_iterator NI = NF->arg_begin();
250 I->replaceAllUsesWith(NI);
259 /// updateCallSites - Update all sites that call F to use NF.
260 void SRETPromotion::updateCallSites(Function *F, Function *NF) {
262 SmallVector<Value*, 16> Args;
264 // ParamAttrs - Keep track of the parameter attributes for the arguments.
265 SmallVector<ParamAttrsWithIndex, 8> ArgAttrsVec;
267 for (Value::use_iterator FUI = F->use_begin(), FUE = F->use_end();
269 CallSite CS = CallSite::get(*FUI);
271 Instruction *Call = CS.getInstruction();
273 const PAListPtr &PAL = F->getParamAttrs();
274 // Add any return attributes.
275 if (ParameterAttributes attrs = PAL.getParamAttrs(0))
276 ArgAttrsVec.push_back(ParamAttrsWithIndex::get(0, attrs));
278 // Copy arguments, however skip first one.
279 CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
280 Value *FirstCArg = *AI;
282 // 0th parameter attribute is reserved for return type.
283 // 1th parameter attribute is for first 1st sret argument.
284 unsigned ParamIndex = 2;
287 if (ParameterAttributes Attrs = PAL.getParamAttrs(ParamIndex))
288 ArgAttrsVec.push_back(ParamAttrsWithIndex::get(ParamIndex - 1, Attrs));
294 PAListPtr NewPAL = PAListPtr::get(ArgAttrsVec.begin(), ArgAttrsVec.end());
296 // Build new call instruction.
298 if (InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
299 New = InvokeInst::Create(NF, II->getNormalDest(), II->getUnwindDest(),
300 Args.begin(), Args.end(), "", Call);
301 cast<InvokeInst>(New)->setCallingConv(CS.getCallingConv());
302 cast<InvokeInst>(New)->setParamAttrs(NewPAL);
304 New = CallInst::Create(NF, Args.begin(), Args.end(), "", Call);
305 cast<CallInst>(New)->setCallingConv(CS.getCallingConv());
306 cast<CallInst>(New)->setParamAttrs(NewPAL);
307 if (cast<CallInst>(Call)->isTailCall())
308 cast<CallInst>(New)->setTailCall();
314 // Update all users of sret parameter to extract value using getresult.
315 for (Value::use_iterator UI = FirstCArg->use_begin(),
316 UE = FirstCArg->use_end(); UI != UE; ) {
318 CallInst *C2 = dyn_cast<CallInst>(U2);
319 if (C2 && (C2 == Call))
321 else if (GetElementPtrInst *UGEP = dyn_cast<GetElementPtrInst>(U2)) {
322 ConstantInt *Idx = dyn_cast<ConstantInt>(UGEP->getOperand(2));
323 assert (Idx && "Unexpected getelementptr index!");
324 Value *GR = new GetResultInst(New, Idx->getZExtValue(), "gr", UGEP);
325 for (Value::use_iterator GI = UGEP->use_begin(),
326 GE = UGEP->use_end(); GI != GE; ++GI) {
327 if (LoadInst *L = dyn_cast<LoadInst>(*GI)) {
328 L->replaceAllUsesWith(GR);
329 L->eraseFromParent();
332 UGEP->eraseFromParent();
334 else assert( 0 && "Unexpected sret parameter use");
336 Call->eraseFromParent();
340 /// nestedStructType - Return true if STy includes any
341 /// other aggregate types
342 bool SRETPromotion::nestedStructType(const StructType *STy) {
343 unsigned Num = STy->getNumElements();
344 for (unsigned i = 0; i < Num; i++) {
345 const Type *Ty = STy->getElementType(i);
346 if (!Ty->isSingleValueType() && Ty != Type::VoidTy)