lib/Transforms/IPO/StructRetPromotion.cpp

   1 //===-- StructRetPromotion.cpp - Promote sret arguments ------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This 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).
  14 //
  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
  19 //
  20 //===----------------------------------------------------------------------===//
  21
  22 #define DEBUG_TYPE "sretpromotion"
  23 #include "llvm/Transforms/IPO.h"
  24 #include "llvm/Constants.h"
  25 #include "llvm/DerivedTypes.h"
  26 #include "llvm/LLVMContext.h"
  27 #include "llvm/Module.h"
  28 #include "llvm/CallGraphSCCPass.h"
  29 #include "llvm/Instructions.h"
  30 #include "llvm/Analysis/CallGraph.h"
  31 #include "llvm/Support/CallSite.h"
  32 #include "llvm/Support/CFG.h"
  33 #include "llvm/Support/Debug.h"
  34 #include "llvm/ADT/Statistic.h"
  35 #include "llvm/ADT/SmallVector.h"
  36 #include "llvm/ADT/Statistic.h"
  37 #include "llvm/Support/Compiler.h"
  38 #include "llvm/Support/raw_ostream.h"
  39 using namespace llvm;
  40
  41 STATISTIC(NumRejectedSRETUses , "Number of sret rejected due to unexpected uses");
  42 STATISTIC(NumSRET , "Number of sret promoted");
  43 namespace {
  44   /// SRETPromotion - This pass removes sret parameter and updates
  45   /// function to use multiple return value.
  46   ///
  47   struct VISIBILITY_HIDDEN SRETPromotion : public CallGraphSCCPass {
  48     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  49       CallGraphSCCPass::getAnalysisUsage(AU);
  50     }
  51
  52     virtual bool runOnSCC(const std::vector<CallGraphNode *> &SCC);
  53     static char ID; // Pass identification, replacement for typeid
  54     SRETPromotion() : CallGraphSCCPass(&ID) {}
  55
  56   private:
  57     bool PromoteReturn(CallGraphNode *CGN);
  58     bool isSafeToUpdateAllCallers(Function *F);
  59     Function *cloneFunctionBody(Function *F, const StructType *STy);
  60     void updateCallSites(Function *F, Function *NF);
  61     bool nestedStructType(const StructType *STy);
  62   };
  63 }
  64
  65 char SRETPromotion::ID = 0;
  66 static RegisterPass<SRETPromotion>
  67 X("sretpromotion", "Promote sret arguments to multiple ret values");
  68
  69 Pass *llvm::createStructRetPromotionPass() {
  70   return new SRETPromotion();
  71 }
  72
  73 bool SRETPromotion::runOnSCC(const std::vector<CallGraphNode *> &SCC) {
  74   bool Changed = false;
  75
  76   for (unsigned i = 0, e = SCC.size(); i != e; ++i)
  77     Changed |= PromoteReturn(SCC[i]);
  78
  79   return Changed;
  80 }
  81
  82 /// PromoteReturn - This method promotes function that uses StructRet paramater
  83 /// into a function that uses mulitple return value.
  84 bool SRETPromotion::PromoteReturn(CallGraphNode *CGN) {
  85   Function *F = CGN->getFunction();
  86
  87   if (!F || F->isDeclaration() || !F->hasLocalLinkage())
  88     return false;
  89
  90   // Make sure that function returns struct.
  91   if (F->arg_size() == 0 || !F->hasStructRetAttr() || F->doesNotReturn())
  92     return false;
  93
  94   DEBUG(errs() << "SretPromotion: Looking at sret function "
  95         << F->getName() << "\n");
  96
  97   assert (F->getReturnType() == Type::VoidTy && "Invalid function return type");
  98   Function::arg_iterator AI = F->arg_begin();
  99   const llvm::PointerType *FArgType = dyn_cast<PointerType>(AI->getType());
 100   assert (FArgType && "Invalid sret parameter type");
 101   const llvm::StructType *STy =
 102     dyn_cast<StructType>(FArgType->getElementType());
 103   assert (STy && "Invalid sret parameter element type");
 104
 105   // Check if it is ok to perform this promotion.
 106   if (isSafeToUpdateAllCallers(F) == false) {
 107     DOUT << "SretPromotion: Not all callers can be updated\n";
 108     NumRejectedSRETUses++;
 109     return false;
 110   }
 111
 112   DOUT << "SretPromotion: sret argument will be promoted\n";
 113   NumSRET++;
 114   // [1] Replace use of sret parameter
 115   AllocaInst *TheAlloca = new AllocaInst(STy, NULL, "mrv",
 116                                          F->getEntryBlock().begin());
 117   Value *NFirstArg = F->arg_begin();
 118   NFirstArg->replaceAllUsesWith(TheAlloca);
 119
 120   // [2] Find and replace ret instructions
 121   for (Function::iterator FI = F->begin(), FE = F->end();  FI != FE; ++FI)
 122     for(BasicBlock::iterator BI = FI->begin(), BE = FI->end(); BI != BE; ) {
 123       Instruction *I = BI;
 124       ++BI;
 125       if (isa<ReturnInst>(I)) {
 126         Value *NV = new LoadInst(TheAlloca, "mrv.ld", I);
 127         ReturnInst *NR = ReturnInst::Create(NV, I);
 128         I->replaceAllUsesWith(NR);
 129         I->eraseFromParent();
 130       }
 131     }
 132
 133   // [3] Create the new function body and insert it into the module.
 134   Function *NF = cloneFunctionBody(F, STy);
 135
 136   // [4] Update all call sites to use new function
 137   updateCallSites(F, NF);
 138
 139   F->eraseFromParent();
 140   getAnalysis<CallGraph>().changeFunction(F, NF);
 141   return true;
 142 }
 143
 144 // Check if it is ok to perform this promotion.
 145 bool SRETPromotion::isSafeToUpdateAllCallers(Function *F) {
 146
 147   if (F->use_empty())
 148     // No users. OK to modify signature.
 149     return true;
 150
 151   for (Value::use_iterator FnUseI = F->use_begin(), FnUseE = F->use_end();
 152        FnUseI != FnUseE; ++FnUseI) {
 153     // The function is passed in as an argument to (possibly) another function,
 154     // we can't change it!
 155     CallSite CS = CallSite::get(*FnUseI);
 156     Instruction *Call = CS.getInstruction();
 157     // The function is used by something else than a call or invoke instruction,
 158     // we can't change it!
 159     if (!Call || !CS.isCallee(FnUseI))
 160       return false;
 161     CallSite::arg_iterator AI = CS.arg_begin();
 162     Value *FirstArg = *AI;
 163
 164     if (!isa<AllocaInst>(FirstArg))
 165       return false;
 166
 167     // Check FirstArg's users.
 168     for (Value::use_iterator ArgI = FirstArg->use_begin(),
 169            ArgE = FirstArg->use_end(); ArgI != ArgE; ++ArgI) {
 170
 171       // If FirstArg user is a CallInst that does not correspond to current
 172       // call site then this function F is not suitable for sret promotion.
 173       if (CallInst *CI = dyn_cast<CallInst>(ArgI)) {
 174         if (CI != Call)
 175           return false;
 176       }
 177       // If FirstArg user is a GEP whose all users are not LoadInst then
 178       // this function F is not suitable for sret promotion.
 179       else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(ArgI)) {
 180         // TODO : Use dom info and insert PHINodes to collect get results
 181         // from multiple call sites for this GEP.
 182         if (GEP->getParent() != Call->getParent())
 183           return false;
 184         for (Value::use_iterator GEPI = GEP->use_begin(), GEPE = GEP->use_end();
 185              GEPI != GEPE; ++GEPI)
 186           if (!isa<LoadInst>(GEPI))
 187             return false;
 188       }
 189       // Any other FirstArg users make this function unsuitable for sret
 190       // promotion.
 191       else
 192         return false;
 193     }
 194   }
 195
 196   return true;
 197 }
 198
 199 /// cloneFunctionBody - Create a new function based on F and
 200 /// insert it into module. Remove first argument. Use STy as
 201 /// the return type for new function.
 202 Function *SRETPromotion::cloneFunctionBody(Function *F,
 203                                            const StructType *STy) {
 204
 205   const FunctionType *FTy = F->getFunctionType();
 206   std::vector<const Type*> Params;
 207
 208   // Attributes - Keep track of the parameter attributes for the arguments.
 209   SmallVector<AttributeWithIndex, 8> AttributesVec;
 210   const AttrListPtr &PAL = F->getAttributes();
 211
 212   // Add any return attributes.
 213   if (Attributes attrs = PAL.getRetAttributes())
 214     AttributesVec.push_back(AttributeWithIndex::get(0, attrs));
 215
 216   // Skip first argument.
 217   Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
 218   ++I;
 219   // 0th parameter attribute is reserved for return type.
 220   // 1th parameter attribute is for first 1st sret argument.
 221   unsigned ParamIndex = 2;
 222   while (I != E) {
 223     Params.push_back(I->getType());
 224     if (Attributes Attrs = PAL.getParamAttributes(ParamIndex))
 225       AttributesVec.push_back(AttributeWithIndex::get(ParamIndex - 1, Attrs));
 226     ++I;
 227     ++ParamIndex;
 228   }
 229
 230   // Add any fn attributes.
 231   if (Attributes attrs = PAL.getFnAttributes())
 232     AttributesVec.push_back(AttributeWithIndex::get(~0, attrs));
 233
 234
 235   FunctionType *NFTy =
 236     F->getContext().getFunctionType(STy, Params, FTy->isVarArg());
 237   Function *NF = Function::Create(NFTy, F->getLinkage());
 238   NF->takeName(F);
 239   NF->copyAttributesFrom(F);
 240   NF->setAttributes(AttrListPtr::get(AttributesVec.begin(), AttributesVec.end()));
 241   F->getParent()->getFunctionList().insert(F, NF);
 242   NF->getBasicBlockList().splice(NF->begin(), F->getBasicBlockList());
 243
 244   // Replace arguments
 245   I = F->arg_begin();
 246   E = F->arg_end();
 247   Function::arg_iterator NI = NF->arg_begin();
 248   ++I;
 249   while (I != E) {
 250       I->replaceAllUsesWith(NI);
 251       NI->takeName(I);
 252       ++I;
 253       ++NI;
 254   }
 255
 256   return NF;
 257 }
 258
 259 /// updateCallSites - Update all sites that call F to use NF.
 260 void SRETPromotion::updateCallSites(Function *F, Function *NF) {
 261   CallGraph &CG = getAnalysis<CallGraph>();
 262   SmallVector<Value*, 16> Args;
 263
 264   // Attributes - Keep track of the parameter attributes for the arguments.
 265   SmallVector<AttributeWithIndex, 8> ArgAttrsVec;
 266
 267   while (!F->use_empty()) {
 268     CallSite CS = CallSite::get(*F->use_begin());
 269     Instruction *Call = CS.getInstruction();
 270
 271     const AttrListPtr &PAL = F->getAttributes();
 272     // Add any return attributes.
 273     if (Attributes attrs = PAL.getRetAttributes())
 274       ArgAttrsVec.push_back(AttributeWithIndex::get(0, attrs));
 275
 276     // Copy arguments, however skip first one.
 277     CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
 278     Value *FirstCArg = *AI;
 279     ++AI;
 280     // 0th parameter attribute is reserved for return type.
 281     // 1th parameter attribute is for first 1st sret argument.
 282     unsigned ParamIndex = 2;
 283     while (AI != AE) {
 284       Args.push_back(*AI);
 285       if (Attributes Attrs = PAL.getParamAttributes(ParamIndex))
 286         ArgAttrsVec.push_back(AttributeWithIndex::get(ParamIndex - 1, Attrs));
 287       ++ParamIndex;
 288       ++AI;
 289     }
 290
 291     // Add any function attributes.
 292     if (Attributes attrs = PAL.getFnAttributes())
 293       ArgAttrsVec.push_back(AttributeWithIndex::get(~0, attrs));
 294
 295     AttrListPtr NewPAL = AttrListPtr::get(ArgAttrsVec.begin(), ArgAttrsVec.end());
 296
 297     // Build new call instruction.
 298     Instruction *New;
 299     if (InvokeInst *II = dyn_cast<InvokeInst>(Call)) {
 300       New = InvokeInst::Create(NF, II->getNormalDest(), II->getUnwindDest(),
 301                                Args.begin(), Args.end(), "", Call);
 302       cast<InvokeInst>(New)->setCallingConv(CS.getCallingConv());
 303       cast<InvokeInst>(New)->setAttributes(NewPAL);
 304     } else {
 305       New = CallInst::Create(NF, Args.begin(), Args.end(), "", Call);
 306       cast<CallInst>(New)->setCallingConv(CS.getCallingConv());
 307       cast<CallInst>(New)->setAttributes(NewPAL);
 308       if (cast<CallInst>(Call)->isTailCall())
 309         cast<CallInst>(New)->setTailCall();
 310     }
 311     Args.clear();
 312     ArgAttrsVec.clear();
 313     New->takeName(Call);
 314
 315     // Update the callgraph to know that the callsite has been transformed.
 316     CG[Call->getParent()->getParent()]->replaceCallSite(Call, New);
 317
 318     // Update all users of sret parameter to extract value using extractvalue.
 319     for (Value::use_iterator UI = FirstCArg->use_begin(),
 320            UE = FirstCArg->use_end(); UI != UE; ) {
 321       User *U2 = *UI++;
 322       CallInst *C2 = dyn_cast<CallInst>(U2);
 323       if (C2 && (C2 == Call))
 324         continue;
 325       else if (GetElementPtrInst *UGEP = dyn_cast<GetElementPtrInst>(U2)) {
 326         ConstantInt *Idx = dyn_cast<ConstantInt>(UGEP->getOperand(2));
 327         assert (Idx && "Unexpected getelementptr index!");
 328         Value *GR = ExtractValueInst::Create(New, Idx->getZExtValue(),
 329                                              "evi", UGEP);
 330         while(!UGEP->use_empty()) {
 331           // isSafeToUpdateAllCallers has checked that all GEP uses are
 332           // LoadInsts
 333           LoadInst *L = cast<LoadInst>(*UGEP->use_begin());
 334           L->replaceAllUsesWith(GR);
 335           L->eraseFromParent();
 336         }
 337         UGEP->eraseFromParent();
 338       }
 339       else assert( 0 && "Unexpected sret parameter use");
 340     }
 341     Call->eraseFromParent();
 342   }
 343 }
 344
 345 /// nestedStructType - Return true if STy includes any
 346 /// other aggregate types
 347 bool SRETPromotion::nestedStructType(const StructType *STy) {
 348   unsigned Num = STy->getNumElements();
 349   for (unsigned i = 0; i < Num; i++) {
 350     const Type *Ty = STy->getElementType(i);
 351     if (!Ty->isSingleValueType() && Ty != Type::VoidTy)
 352       return true;
 353   }
 354   return false;
 355 }