lib/Transforms/Utils/InlineCost.cpp

   1 //===- InlineCoast.cpp - Cost analysis for inliner ------------------------===//
   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 file implements inline cost analysis.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14
  15 #include "llvm/Transforms/Utils/InlineCost.h"
  16 #include "llvm/Support/CallSite.h"
  17 #include "llvm/CallingConv.h"
  18 #include "llvm/IntrinsicInst.h"
  19
  20 using namespace llvm;
  21
  22 // CountCodeReductionForConstant - Figure out an approximation for how many
  23 // instructions will be constant folded if the specified value is constant.
  24 //
  25 unsigned InlineCostAnalyzer::FunctionInfo::
  26          CountCodeReductionForConstant(Value *V) {
  27   unsigned Reduction = 0;
  28   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
  29     if (isa<BranchInst>(*UI))
  30       Reduction += 40;          // Eliminating a conditional branch is a big win
  31     else if (SwitchInst *SI = dyn_cast<SwitchInst>(*UI))
  32       // Eliminating a switch is a big win, proportional to the number of edges
  33       // deleted.
  34       Reduction += (SI->getNumSuccessors()-1) * 40;
  35     else if (CallInst *CI = dyn_cast<CallInst>(*UI)) {
  36       // Turning an indirect call into a direct call is a BIG win
  37       Reduction += CI->getCalledValue() == V ? 500 : 0;
  38     } else if (InvokeInst *II = dyn_cast<InvokeInst>(*UI)) {
  39       // Turning an indirect call into a direct call is a BIG win
  40       Reduction += II->getCalledValue() == V ? 500 : 0;
  41     } else {
  42       // Figure out if this instruction will be removed due to simple constant
  43       // propagation.
  44       Instruction &Inst = cast<Instruction>(**UI);
  45       bool AllOperandsConstant = true;
  46       for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i)
  47         if (!isa<Constant>(Inst.getOperand(i)) && Inst.getOperand(i) != V) {
  48           AllOperandsConstant = false;
  49           break;
  50         }
  51
  52       if (AllOperandsConstant) {
  53         // We will get to remove this instruction...
  54         Reduction += 7;
  55
  56         // And any other instructions that use it which become constants
  57         // themselves.
  58         Reduction += CountCodeReductionForConstant(&Inst);
  59       }
  60     }
  61
  62   return Reduction;
  63 }
  64
  65 // CountCodeReductionForAlloca - Figure out an approximation of how much smaller
  66 // the function will be if it is inlined into a context where an argument
  67 // becomes an alloca.
  68 //
  69 unsigned InlineCostAnalyzer::FunctionInfo::
  70          CountCodeReductionForAlloca(Value *V) {
  71   if (!isa<PointerType>(V->getType())) return 0;  // Not a pointer
  72   unsigned Reduction = 0;
  73   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
  74     Instruction *I = cast<Instruction>(*UI);
  75     if (isa<LoadInst>(I) || isa<StoreInst>(I))
  76       Reduction += 10;
  77     else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(I)) {
  78       // If the GEP has variable indices, we won't be able to do much with it.
  79       for (Instruction::op_iterator I = GEP->op_begin()+1, E = GEP->op_end();
  80            I != E; ++I)
  81         if (!isa<Constant>(*I)) return 0;
  82       Reduction += CountCodeReductionForAlloca(GEP)+15;
  83     } else {
  84       // If there is some other strange instruction, we're not going to be able
  85       // to do much if we inline this.
  86       return 0;
  87     }
  88   }
  89
  90   return Reduction;
  91 }
  92
  93 /// analyzeFunction - Fill in the current structure with information gleaned
  94 /// from the specified function.
  95 void InlineCostAnalyzer::FunctionInfo::analyzeFunction(Function *F) {
  96   unsigned NumInsts = 0, NumBlocks = 0, NumVectorInsts = 0;
  97
  98   // Look at the size of the callee.  Each basic block counts as 20 units, and
  99   // each instruction counts as 5.
 100   for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB) {
 101     for (BasicBlock::const_iterator II = BB->begin(), E = BB->end();
 102          II != E; ++II) {
 103       if (isa<PHINode>(II)) continue;           // PHI nodes don't count.
 104
 105       // Special handling for calls.
 106       if (isa<CallInst>(II) || isa<InvokeInst>(II)) {
 107         if (isa<DbgInfoIntrinsic>(II))
 108           continue;  // Debug intrinsics don't count as size.
 109
 110         CallSite CS = CallSite::get(const_cast<Instruction*>(&*II));
 111
 112         // If this function contains a call to setjmp or _setjmp, never inline
 113         // it.  This is a hack because we depend on the user marking their local
 114         // variables as volatile if they are live across a setjmp call, and they
 115         // probably won't do this in callers.
 116         if (Function *F = CS.getCalledFunction())
 117           if (F->isDeclaration() &&
 118               (F->isName("setjmp") || F->isName("_setjmp"))) {
 119             NeverInline = true;
 120             return;
 121           }
 122
 123         // Calls often compile into many machine instructions.  Bump up their
 124         // cost to reflect this.
 125         if (!isa<IntrinsicInst>(II))
 126           NumInsts += 5;
 127       }
 128
 129       if (isa<ExtractElementInst>(II) || isa<VectorType>(II->getType()))
 130         ++NumVectorInsts;
 131
 132       // Noop casts, including ptr <-> int,  don't count.
 133       if (const CastInst *CI = dyn_cast<CastInst>(II)) {
 134         if (CI->isLosslessCast() || isa<IntToPtrInst>(CI) ||
 135             isa<PtrToIntInst>(CI))
 136           continue;
 137       } else if (const GetElementPtrInst *GEPI =
 138                  dyn_cast<GetElementPtrInst>(II)) {
 139         // If a GEP has all constant indices, it will probably be folded with
 140         // a load/store.
 141         bool AllConstant = true;
 142         for (unsigned i = 1, e = GEPI->getNumOperands(); i != e; ++i)
 143           if (!isa<ConstantInt>(GEPI->getOperand(i))) {
 144             AllConstant = false;
 145             break;
 146           }
 147         if (AllConstant) continue;
 148       }
 149
 150       ++NumInsts;
 151     }
 152
 153     ++NumBlocks;
 154   }
 155
 156   this->NumBlocks      = NumBlocks;
 157   this->NumInsts       = NumInsts;
 158   this->NumVectorInsts = NumVectorInsts;
 159
 160   // Check out all of the arguments to the function, figuring out how much
 161   // code can be eliminated if one of the arguments is a constant.
 162   for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
 163     ArgumentWeights.push_back(ArgInfo(CountCodeReductionForConstant(I),
 164                                       CountCodeReductionForAlloca(I)));
 165 }
 166
 167
 168
 169 // getInlineCost - The heuristic used to determine if we should inline the
 170 // function call or not.
 171 //
 172 InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
 173                                SmallPtrSet<const Function *, 16> &NeverInline) {
 174   Instruction *TheCall = CS.getInstruction();
 175   Function *Callee = CS.getCalledFunction();
 176   const Function *Caller = TheCall->getParent()->getParent();
 177
 178   // Don't inline a directly recursive call.
 179   if (Caller == Callee ||
 180       // Don't inline functions which can be redefined at link-time to mean
 181       // something else.
 182       // FIXME: We allow link-once linkage since in practice all versions of
 183       // the function have the same body (C++ ODR) - but the LLVM definition
 184       // of LinkOnceLinkage doesn't require this.
 185       (Callee->mayBeOverridden() && !Callee->hasLinkOnceLinkage()
 186        ) ||
 187
 188       // Don't inline functions marked noinline.
 189       NeverInline.count(Callee))
 190     return llvm::InlineCost::getNever();
 191
 192   // InlineCost - This value measures how good of an inline candidate this call
 193   // site is to inline.  A lower inline cost make is more likely for the call to
 194   // be inlined.  This value may go negative.
 195   //
 196   int InlineCost = 0;
 197
 198   // If there is only one call of the function, and it has internal linkage,
 199   // make it almost guaranteed to be inlined.
 200   //
 201   if (Callee->hasInternalLinkage() && Callee->hasOneUse())
 202     InlineCost -= 15000;
 203
 204   // If this function uses the coldcc calling convention, prefer not to inline
 205   // it.
 206   if (Callee->getCallingConv() == CallingConv::Cold)
 207     InlineCost += 2000;
 208
 209   // If the instruction after the call, or if the normal destination of the
 210   // invoke is an unreachable instruction, the function is noreturn.  As such,
 211   // there is little point in inlining this.
 212   if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall)) {
 213     if (isa<UnreachableInst>(II->getNormalDest()->begin()))
 214       InlineCost += 10000;
 215   } else if (isa<UnreachableInst>(++BasicBlock::iterator(TheCall)))
 216     InlineCost += 10000;
 217
 218   // Get information about the callee...
 219   FunctionInfo &CalleeFI = CachedFunctionInfo[Callee];
 220
 221   // If we haven't calculated this information yet, do so now.
 222   if (CalleeFI.NumBlocks == 0)
 223     CalleeFI.analyzeFunction(Callee);
 224
 225   // If we should never inline this, return a huge cost.
 226   if (CalleeFI.NeverInline)
 227     return InlineCost::getNever();
 228
 229   // FIXME: It would be nice to kill off CalleeFI.NeverInline. Then we
 230   // could move this up and avoid computing the FunctionInfo for
 231   // things we are going to just return always inline for. This
 232   // requires handling setjmp somewhere else, however.
 233   if (!Callee->isDeclaration() && Callee->hasFnAttr(Attribute::AlwaysInline))
 234     return InlineCost::getAlways();
 235
 236   // Add to the inline quality for properties that make the call valuable to
 237   // inline.  This includes factors that indicate that the result of inlining
 238   // the function will be optimizable.  Currently this just looks at arguments
 239   // passed into the function.
 240   //
 241   unsigned ArgNo = 0;
 242   for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
 243        I != E; ++I, ++ArgNo) {
 244     // Each argument passed in has a cost at both the caller and the callee
 245     // sides.  This favors functions that take many arguments over functions
 246     // that take few arguments.
 247     InlineCost -= 20;
 248
 249     // If this is a function being passed in, it is very likely that we will be
 250     // able to turn an indirect function call into a direct function call.
 251     if (isa<Function>(I))
 252       InlineCost -= 100;
 253
 254     // If an alloca is passed in, inlining this function is likely to allow
 255     // significant future optimization possibilities (like scalar promotion, and
 256     // scalarization), so encourage the inlining of the function.
 257     //
 258     else if (isa<AllocaInst>(I)) {
 259       if (ArgNo < CalleeFI.ArgumentWeights.size())
 260         InlineCost -= CalleeFI.ArgumentWeights[ArgNo].AllocaWeight;
 261
 262       // If this is a constant being passed into the function, use the argument
 263       // weights calculated for the callee to determine how much will be folded
 264       // away with this information.
 265     } else if (isa<Constant>(I)) {
 266       if (ArgNo < CalleeFI.ArgumentWeights.size())
 267         InlineCost -= CalleeFI.ArgumentWeights[ArgNo].ConstantWeight;
 268     }
 269   }
 270
 271   // Now that we have considered all of the factors that make the call site more
 272   // likely to be inlined, look at factors that make us not want to inline it.
 273
 274   // Don't inline into something too big, which would make it bigger.
 275   //
 276   InlineCost += Caller->size()/15;
 277
 278   // Look at the size of the callee. Each instruction counts as 5.
 279   InlineCost += CalleeFI.NumInsts*5;
 280
 281   return llvm::InlineCost::get(InlineCost);
 282 }
 283
 284 // getInlineFudgeFactor - Return a > 1.0 factor if the inliner should use a
 285 // higher threshold to determine if the function call should be inlined.
 286 float InlineCostAnalyzer::getInlineFudgeFactor(CallSite CS) {
 287   Function *Callee = CS.getCalledFunction();
 288
 289   // Get information about the callee...
 290   FunctionInfo &CalleeFI = CachedFunctionInfo[Callee];
 291
 292   // If we haven't calculated this information yet, do so now.
 293   if (CalleeFI.NumBlocks == 0)
 294     CalleeFI.analyzeFunction(Callee);
 295
 296   float Factor = 1.0f;
 297   // Single BB functions are often written to be inlined.
 298   if (CalleeFI.NumBlocks == 1)
 299     Factor += 0.5f;
 300
 301   // Be more aggressive if the function contains a good chunk (if it mades up
 302   // at least 10% of the instructions) of vector instructions.
 303   if (CalleeFI.NumVectorInsts > CalleeFI.NumInsts/2)
 304     Factor += 2.0f;
 305   else if (CalleeFI.NumVectorInsts > CalleeFI.NumInsts/10)
 306     Factor += 1.5f;
 307   return Factor;
 308 }