a byval argument is guaranteed to be valid to load.
[oota-llvm.git] / lib / Transforms / IPO / ArgumentPromotion.cpp
index 7479c8ee67401725fa6193cc1fbca90d0069e717..1c739adcea3bc1b26e904cbdba5aa958113c0fc5 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
@@ -35,6 +35,7 @@
 #include "llvm/Module.h"
 #include "llvm/CallGraphSCCPass.h"
 #include "llvm/Instructions.h"
+#include "llvm/ParameterAttributes.h"
 #include "llvm/Analysis/AliasAnalysis.h"
 #include "llvm/Analysis/CallGraph.h"
 #include "llvm/Target/TargetData.h"
@@ -68,8 +69,9 @@ namespace {
 
   private:
     bool PromoteArguments(CallGraphNode *CGN);
-    bool isSafeToPromoteArgument(Argument *Arg) const;
-    Function *DoPromotion(Function *F, std::vector<Argument*> &ArgsToPromote);
+    bool isSafeToPromoteArgument(Argument *Arg, bool isByVal) const;
+    Function *DoPromotion(Function *F, 
+                          SmallPtrSet<Argument*, 8> &ArgsToPromote);
   };
 
   char ArgPromotion::ID = 0;
@@ -107,10 +109,12 @@ bool ArgPromotion::PromoteArguments(CallGraphNode *CGN) {
   if (!F || !F->hasInternalLinkage()) return false;
 
   // First check: see if there are any pointer arguments!  If not, quick exit.
-  std::vector<Argument*> PointerArgs;
-  for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
+  SmallVector<std::pair<Argument*, unsigned>, 16> PointerArgs;
+  unsigned ArgNo = 0;
+  for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end();
+       I != E; ++I, ++ArgNo)
     if (isa<PointerType>(I->getType()))
-      PointerArgs.push_back(I);
+      PointerArgs.push_back(std::pair<Argument*, unsigned>(I, ArgNo));
   if (PointerArgs.empty()) return false;
 
   // Second check: make sure that all callers are direct callers.  We can't
@@ -123,26 +127,25 @@ bool ArgPromotion::PromoteArguments(CallGraphNode *CGN) {
 
     // Ensure that this call site is CALLING the function, not passing it as
     // an argument.
-    for (CallSite::arg_iterator AI = CS.arg_begin(), E = CS.arg_end();
-         AI != E; ++AI)
-      if (*AI == F) return false;   // Passing the function address in!
+    if (UI.getOperandNo() != 0) 
+      return false;
   }
 
-  // Check to see which arguments are promotable.  If an argument is not
-  // promotable, remove it from the PointerArgs vector.
-  for (unsigned i = 0; i != PointerArgs.size(); ++i)
-    if (!isSafeToPromoteArgument(PointerArgs[i])) {
-      std::swap(PointerArgs[i--], PointerArgs.back());
-      PointerArgs.pop_back();
-    }
-
+  // Check to see which arguments are promotable.  If an argument is promotable,
+  // add it to ArgsToPromote.
+  SmallPtrSet<Argument*, 8> ArgsToPromote;
+  for (unsigned i = 0; i != PointerArgs.size(); ++i) {
+    bool isByVal = F->paramHasAttr(PointerArgs[i].second, ParamAttr::ByVal);
+    if (isSafeToPromoteArgument(PointerArgs[i].first, isByVal))
+      ArgsToPromote.insert(PointerArgs[i].first);
+  }
+  
   // No promotable pointer arguments.
-  if (PointerArgs.empty()) return false;
+  if (ArgsToPromote.empty()) return false;
 
-  // Okay, promote all of the arguments are rewrite the callees!
-  Function *NewF = DoPromotion(F, PointerArgs);
+  Function *NewF = DoPromotion(F, ArgsToPromote);
 
-  // Update the call graph to know that the old function is gone.
+  // Update the call graph to know that the function has been transformed.
   getAnalysis<CallGraph>().changeFunction(F, NewF);
   return true;
 }
@@ -187,29 +190,40 @@ static bool AllCalleesPassInValidPointerForArgument(Argument *Arg) {
 /// This method limits promotion of aggregates to only promote up to three
 /// elements of the aggregate in order to avoid exploding the number of
 /// arguments passed in.
-bool ArgPromotion::isSafeToPromoteArgument(Argument *Arg) const {
+bool ArgPromotion::isSafeToPromoteArgument(Argument *Arg, bool isByVal) const {
   // We can only promote this argument if all of the uses are loads, or are GEP
   // instructions (with constant indices) that are subsequently loaded.
-  bool HasLoadInEntryBlock = false;
+
+  // We can also only promote the load if we can guarantee that it will happen.
+  // Promoting a load causes the load to be unconditionally executed in the
+  // caller, so we can't turn a conditional load into an unconditional load in
+  // general.
+  bool SafeToUnconditionallyLoad = false;
+  if (isByVal)   // ByVal arguments are always safe to load from.
+    SafeToUnconditionallyLoad = true;
+  
   BasicBlock *EntryBlock = Arg->getParent()->begin();
-  std::vector<LoadInst*> Loads;
-  std::vector<std::vector<ConstantInt*> > GEPIndices;
+  SmallVector<LoadInst*, 16> Loads;
+  std::vector<SmallVector<ConstantInt*, 8> > GEPIndices;
   for (Value::use_iterator UI = Arg->use_begin(), E = Arg->use_end();
        UI != E; ++UI)
     if (LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
       if (LI->isVolatile()) return false;  // Don't hack volatile loads
       Loads.push_back(LI);
-      HasLoadInEntryBlock |= LI->getParent() == EntryBlock;
+      
+      // If this load occurs in the entry block, then the pointer is 
+      // unconditionally loaded.
+      SafeToUnconditionallyLoad |= LI->getParent() == EntryBlock;
     } else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(*UI)) {
       if (GEP->use_empty()) {
         // Dead GEP's cause trouble later.  Just remove them if we run into
         // them.
         getAnalysis<AliasAnalysis>().deleteValue(GEP);
-        GEP->getParent()->getInstList().erase(GEP);
-        return isSafeToPromoteArgument(Arg);
+        GEP->eraseFromParent();
+        return isSafeToPromoteArgument(Arg, isByVal);
       }
       // Ensure that all of the indices are constants.
-      std::vector<ConstantInt*> Operands;
+      SmallVector<ConstantInt*, 8> Operands;
       for (unsigned i = 1, e = GEP->getNumOperands(); i != e; ++i)
         if (ConstantInt *C = dyn_cast<ConstantInt>(GEP->getOperand(i)))
           Operands.push_back(C);
@@ -222,7 +236,10 @@ bool ArgPromotion::isSafeToPromoteArgument(Argument *Arg) const {
         if (LoadInst *LI = dyn_cast<LoadInst>(*UI)) {
           if (LI->isVolatile()) return false;  // Don't hack volatile loads
           Loads.push_back(LI);
-          HasLoadInEntryBlock |= LI->getParent() == EntryBlock;
+          
+          // If this load occurs in the entry block, then the pointer is 
+          // unconditionally loaded.
+          SafeToUnconditionallyLoad |= LI->getParent() == EntryBlock;
         } else {
           return false;
         }
@@ -254,7 +271,8 @@ bool ArgPromotion::isSafeToPromoteArgument(Argument *Arg) const {
   // of the pointer in the entry block of the function) or if we can prove that
   // all pointers passed in are always to legal locations (for example, no null
   // pointers are passed in, no pointers to free'd memory, etc).
-  if (!HasLoadInEntryBlock && !AllCalleesPassInValidPointerForArgument(Arg))
+  if (!SafeToUnconditionallyLoad &&
+      !AllCalleesPassInValidPointerForArgument(Arg))
     return false;   // Cannot prove that this is safe!!
 
   // Okay, now we know that the argument is only used by load instructions and
@@ -325,8 +343,7 @@ namespace {
 /// arguments, and returns the new function.  At this point, we know that it's
 /// safe to do so.
 Function *ArgPromotion::DoPromotion(Function *F,
-                                    std::vector<Argument*> &Args2Prom) {
-  std::set<Argument*> ArgsToPromote(Args2Prom.begin(), Args2Prom.end());
+                                    SmallPtrSet<Argument*, 8> &ArgsToPromote) {
 
   // Start by computing a new prototype for the function, which is the same as
   // the old function, but has modified arguments.
@@ -349,9 +366,23 @@ Function *ArgPromotion::DoPromotion(Function *F,
   // what the new GEP/Load instructions we are inserting look like.
   std::map<std::vector<Value*>, LoadInst*> OriginalLoads;
 
-  for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
+  // ParamAttrs - Keep track of the parameter attributes for the arguments
+  // that we are *not* promoting. For the ones that we do promote, the parameter
+  // attributes are lost
+  ParamAttrsVector ParamAttrsVec;
+  const ParamAttrsList *PAL = F->getParamAttrs();
+
+  unsigned index = 1;
+  for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E;
+       ++I, ++index)
     if (!ArgsToPromote.count(I)) {
       Params.push_back(I->getType());
+      if (PAL) {
+        unsigned attrs = PAL->getParamAttrs(index);
+        if (attrs)
+          ParamAttrsVec.push_back(ParamAttrsWithIndex::get(Params.size(),
+                                  attrs));
+      }
     } else if (I->use_empty()) {
       ++NumArgumentsDead;
     } else {
@@ -387,6 +418,13 @@ Function *ArgPromotion::DoPromotion(Function *F,
 
   const Type *RetTy = FTy->getReturnType();
 
+  // Recompute the parameter attributes list based on the new arguments for
+  // the function.
+  if (ParamAttrsVec.empty())
+    PAL = 0;
+  else
+    PAL = ParamAttrsList::get(ParamAttrsVec);
+
   // Work around LLVM bug PR56: the CWriter cannot emit varargs functions which
   // have zero fixed arguments.
   bool ExtraArgHack = false;
@@ -394,11 +432,16 @@ Function *ArgPromotion::DoPromotion(Function *F,
     ExtraArgHack = true;
     Params.push_back(Type::Int32Ty);
   }
+
+  // Construct the new function type using the new arguments.
   FunctionType *NFTy = FunctionType::get(RetTy, Params, FTy->isVarArg());
 
-   // Create the new function body and insert it into the module...
+  // Create the new function body and insert it into the module...
   Function *NF = new Function(NFTy, F->getLinkage(), F->getName());
   NF->setCallingConv(F->getCallingConv());
+  NF->setParamAttrs(PAL);
+  if (F->hasCollector())
+    NF->setCollector(F->getCollector());
   F->getParent()->getFunctionList().insert(F, NF);
 
   // Get the alias analysis information that we need to update to reflect our
@@ -449,9 +492,11 @@ Function *ArgPromotion::DoPromotion(Function *F,
       New = new InvokeInst(NF, II->getNormalDest(), II->getUnwindDest(),
                            Args.begin(), Args.end(), "", Call);
       cast<InvokeInst>(New)->setCallingConv(CS.getCallingConv());
+      cast<InvokeInst>(New)->setParamAttrs(PAL);
     } else {
       New = new CallInst(NF, Args.begin(), Args.end(), "", Call);
       cast<CallInst>(New)->setCallingConv(CS.getCallingConv());
+      cast<CallInst>(New)->setParamAttrs(PAL);
       if (cast<CallInst>(Call)->isTailCall())
         cast<CallInst>(New)->setTailCall();
     }
@@ -468,7 +513,7 @@ Function *ArgPromotion::DoPromotion(Function *F,
 
     // Finally, remove the old call from the program, reducing the use-count of
     // F.
-    Call->getParent()->getInstList().erase(Call);
+    Call->eraseFromParent();
   }
 
   // Since we have now created the new function, splice the body of the old
@@ -503,7 +548,7 @@ Function *ArgPromotion::DoPromotion(Function *F,
           I2->setName(I->getName()+".val");
           LI->replaceAllUsesWith(I2);
           AA.replaceWithNewValue(LI, I2);
-          LI->getParent()->getInstList().erase(LI);
+          LI->eraseFromParent();
           DOUT << "*** Promoted load of argument '" << I->getName()
                << "' in function '" << F->getName() << "'\n";
         } else {
@@ -533,10 +578,10 @@ Function *ArgPromotion::DoPromotion(Function *F,
             LoadInst *L = cast<LoadInst>(GEP->use_back());
             L->replaceAllUsesWith(TheArg);
             AA.replaceWithNewValue(L, TheArg);
-            L->getParent()->getInstList().erase(L);
+            L->eraseFromParent();
           }
           AA.deleteValue(GEP);
-          GEP->getParent()->getInstList().erase(GEP);
+          GEP->eraseFromParent();
         }
       }
 
@@ -554,6 +599,6 @@ Function *ArgPromotion::DoPromotion(Function *F,
   AA.replaceWithNewValue(F, NF);
 
   // Now that the old function is dead, delete it.
-  F->getParent()->getFunctionList().erase(F);
+  F->eraseFromParent();
   return NF;
 }