lib/Analysis/InlineCost.cpp

   1 //===- InlineCost.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 #include "llvm/Analysis/InlineCost.h"
  15 #include "llvm/Support/CallSite.h"
  16 #include "llvm/CallingConv.h"
  17 #include "llvm/IntrinsicInst.h"
  18 #include "llvm/ADT/SmallPtrSet.h"
  19 using namespace llvm;
  20
  21 // CountCodeReductionForConstant - Figure out an approximation for how many
  22 // instructions will be constant folded if the specified value is constant.
  23 //
  24 unsigned InlineCostAnalyzer::FunctionInfo::
  25          CountCodeReductionForConstant(Value *V) {
  26   unsigned Reduction = 0;
  27   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E; ++UI)
  28     if (isa<BranchInst>(*UI) || isa<SwitchInst>(*UI)) {
  29       // We will be able to eliminate all but one of the successors.
  30       const TerminatorInst &TI = cast<TerminatorInst>(**UI);
  31       const unsigned NumSucc = TI.getNumSuccessors();
  32       unsigned Instrs = 0;
  33       for (unsigned I = 0; I != NumSucc; ++I)
  34         Instrs += TI.getSuccessor(I)->size();
  35       // We don't know which blocks will be eliminated, so use the average size.
  36       Reduction += InlineConstants::InstrCost*Instrs*(NumSucc-1)/NumSucc;
  37     } else if (CallInst *CI = dyn_cast<CallInst>(*UI)) {
  38       // Turning an indirect call into a direct call is a BIG win
  39       if (CI->getCalledValue() == V)
  40         Reduction += InlineConstants::IndirectCallBonus;
  41     } else if (InvokeInst *II = dyn_cast<InvokeInst>(*UI)) {
  42       // Turning an indirect call into a direct call is a BIG win
  43       if (II->getCalledValue() == V)
  44         Reduction += InlineConstants::IndirectCallBonus;
  45     } else {
  46       // Figure out if this instruction will be removed due to simple constant
  47       // propagation.
  48       Instruction &Inst = cast<Instruction>(**UI);
  49
  50       // We can't constant propagate instructions which have effects or
  51       // read memory.
  52       //
  53       // FIXME: It would be nice to capture the fact that a load from a
  54       // pointer-to-constant-global is actually a *really* good thing to zap.
  55       // Unfortunately, we don't know the pointer that may get propagated here,
  56       // so we can't make this decision.
  57       if (Inst.mayReadFromMemory() || Inst.mayHaveSideEffects() ||
  58           isa<AllocaInst>(Inst))
  59         continue;
  60
  61       bool AllOperandsConstant = true;
  62       for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i)
  63         if (!isa<Constant>(Inst.getOperand(i)) && Inst.getOperand(i) != V) {
  64           AllOperandsConstant = false;
  65           break;
  66         }
  67
  68       if (AllOperandsConstant) {
  69         // We will get to remove this instruction...
  70         Reduction += InlineConstants::InstrCost;
  71
  72         // And any other instructions that use it which become constants
  73         // themselves.
  74         Reduction += CountCodeReductionForConstant(&Inst);
  75       }
  76     }
  77
  78   return Reduction;
  79 }
  80
  81 // CountCodeReductionForAlloca - Figure out an approximation of how much smaller
  82 // the function will be if it is inlined into a context where an argument
  83 // becomes an alloca.
  84 //
  85 unsigned InlineCostAnalyzer::FunctionInfo::
  86          CountCodeReductionForAlloca(Value *V) {
  87   if (!isa<PointerType>(V->getType())) return 0;  // Not a pointer
  88   unsigned Reduction = 0;
  89   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
  90     Instruction *I = cast<Instruction>(*UI);
  91     if (isa<LoadInst>(I) || isa<StoreInst>(I))
  92       Reduction += InlineConstants::InstrCost;
  93     else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(I)) {
  94       // If the GEP has variable indices, we won't be able to do much with it.
  95       if (GEP->hasAllConstantIndices())
  96         Reduction += CountCodeReductionForAlloca(GEP);
  97     } else if (BitCastInst *BCI = dyn_cast<BitCastInst>(I)) {
  98       // Track pointer through bitcasts.
  99       Reduction += CountCodeReductionForAlloca(BCI);
 100     } else {
 101       // If there is some other strange instruction, we're not going to be able
 102       // to do much if we inline this.
 103       return 0;
 104     }
 105   }
 106
 107   return Reduction;
 108 }
 109
 110 // callIsSmall - If a call is likely to lower to a single target instruction, or
 111 // is otherwise deemed small return true.
 112 // TODO: Perhaps calls like memcpy, strcpy, etc?
 113 static bool callIsSmall(const Function *F) {
 114   if (!F) return false;
 115
 116   if (F->hasLocalLinkage()) return false;
 117
 118   if (!F->hasName()) return false;
 119
 120   StringRef Name = F->getName();
 121
 122   // These will all likely lower to a single selection DAG node.
 123   if (Name == "copysign" || Name == "copysignf" ||
 124       Name == "fabs" || Name == "fabsf" || Name == "fabsl" ||
 125       Name == "sin" || Name == "sinf" || Name == "sinl" ||
 126       Name == "cos" || Name == "cosf" || Name == "cosl" ||
 127       Name == "sqrt" || Name == "sqrtf" || Name == "sqrtl" )
 128     return true;
 129
 130   // These are all likely to be optimized into something smaller.
 131   if (Name == "pow" || Name == "powf" || Name == "powl" ||
 132       Name == "exp2" || Name == "exp2l" || Name == "exp2f" ||
 133       Name == "floor" || Name == "floorf" || Name == "ceil" ||
 134       Name == "round" || Name == "ffs" || Name == "ffsl" ||
 135       Name == "abs" || Name == "labs" || Name == "llabs")
 136     return true;
 137
 138   return false;
 139 }
 140
 141 /// analyzeBasicBlock - Fill in the current structure with information gleaned
 142 /// from the specified block.
 143 void CodeMetrics::analyzeBasicBlock(const BasicBlock *BB) {
 144   ++NumBlocks;
 145
 146   for (BasicBlock::const_iterator II = BB->begin(), E = BB->end();
 147        II != E; ++II) {
 148     if (isa<PHINode>(II)) continue;           // PHI nodes don't count.
 149
 150     // Special handling for calls.
 151     if (isa<CallInst>(II) || isa<InvokeInst>(II)) {
 152       if (isa<DbgInfoIntrinsic>(II))
 153         continue;  // Debug intrinsics don't count as size.
 154
 155       CallSite CS = CallSite::get(const_cast<Instruction*>(&*II));
 156
 157       // If this function contains a call to setjmp or _setjmp, never inline
 158       // it.  This is a hack because we depend on the user marking their local
 159       // variables as volatile if they are live across a setjmp call, and they
 160       // probably won't do this in callers.
 161       if (Function *F = CS.getCalledFunction())
 162         if (F->isDeclaration() &&
 163             (F->getName() == "setjmp" || F->getName() == "_setjmp"))
 164           NeverInline = true;
 165
 166       // Each argument to a call takes on average one instruction to set up.
 167       // Add an extra penalty because calls can take a long time to execute.
 168       if (!isa<IntrinsicInst>(II) && !callIsSmall(CS.getCalledFunction()))
 169         NumInsts += InlineConstants::CallPenalty + CS.arg_size();
 170     }
 171
 172     if (const AllocaInst *AI = dyn_cast<AllocaInst>(II)) {
 173       if (!AI->isStaticAlloca())
 174         this->usesDynamicAlloca = true;
 175     }
 176
 177     if (isa<ExtractElementInst>(II) || isa<VectorType>(II->getType()))
 178       ++NumVectorInsts;
 179
 180     if (const CastInst *CI = dyn_cast<CastInst>(II)) {
 181       // Noop casts, including ptr <-> int,  don't count.
 182       if (CI->isLosslessCast() || isa<IntToPtrInst>(CI) ||
 183           isa<PtrToIntInst>(CI))
 184         continue;
 185       // Result of a cmp instruction is often extended (to be used by other
 186       // cmp instructions, logical or return instructions). These are usually
 187       // nop on most sane targets.
 188       if (isa<CmpInst>(CI->getOperand(0)))
 189         continue;
 190     } else if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(II)){
 191       // If a GEP has all constant indices, it will probably be folded with
 192       // a load/store.
 193       if (GEPI->hasAllConstantIndices())
 194         continue;
 195     }
 196
 197     ++NumInsts;
 198   }
 199
 200   if (isa<ReturnInst>(BB->getTerminator()))
 201     ++NumRets;
 202
 203   // We never want to inline functions that contain an indirectbr.  This is
 204   // incorrect because all the blockaddress's (in static global initializers
 205   // for example) would be referring to the original function, and this indirect
 206   // jump would jump from the inlined copy of the function into the original
 207   // function which is extremely undefined behavior.
 208   if (isa<IndirectBrInst>(BB->getTerminator()))
 209     NeverInline = true;
 210 }
 211
 212 /// analyzeFunction - Fill in the current structure with information gleaned
 213 /// from the specified function.
 214 void CodeMetrics::analyzeFunction(Function *F) {
 215   // Look at the size of the callee.
 216   for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
 217     analyzeBasicBlock(&*BB);
 218 }
 219
 220 /// analyzeFunction - Fill in the current structure with information gleaned
 221 /// from the specified function.
 222 void InlineCostAnalyzer::FunctionInfo::analyzeFunction(Function *F) {
 223   Metrics.analyzeFunction(F);
 224
 225   // A function with exactly one return has it removed during the inlining
 226   // process (see InlineFunction), so don't count it.
 227   // FIXME: This knowledge should really be encoded outside of FunctionInfo.
 228   if (Metrics.NumRets==1)
 229     --Metrics.NumInsts;
 230
 231   // Don't bother calculating argument weights if we are never going to inline
 232   // the function anyway.
 233   if (Metrics.NeverInline)
 234     return;
 235
 236   // Check out all of the arguments to the function, figuring out how much
 237   // code can be eliminated if one of the arguments is a constant.
 238   ArgumentWeights.reserve(F->arg_size());
 239   for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
 240     ArgumentWeights.push_back(ArgInfo(CountCodeReductionForConstant(I),
 241                                       CountCodeReductionForAlloca(I)));
 242 }
 243
 244 // getInlineCost - The heuristic used to determine if we should inline the
 245 // function call or not.
 246 //
 247 InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
 248                                SmallPtrSet<const Function *, 16> &NeverInline) {
 249   Instruction *TheCall = CS.getInstruction();
 250   Function *Callee = CS.getCalledFunction();
 251   Function *Caller = TheCall->getParent()->getParent();
 252
 253   // Don't inline functions which can be redefined at link-time to mean
 254   // something else.  Don't inline functions marked noinline.
 255   if (Callee->mayBeOverridden() ||
 256       Callee->hasFnAttr(Attribute::NoInline) || NeverInline.count(Callee))
 257     return llvm::InlineCost::getNever();
 258
 259   // InlineCost - This value measures how good of an inline candidate this call
 260   // site is to inline.  A lower inline cost make is more likely for the call to
 261   // be inlined.  This value may go negative.
 262   //
 263   int InlineCost = 0;
 264
 265   // If there is only one call of the function, and it has internal linkage,
 266   // make it almost guaranteed to be inlined.
 267   //
 268   if (Callee->hasLocalLinkage() && Callee->hasOneUse())
 269     InlineCost += InlineConstants::LastCallToStaticBonus;
 270
 271   // If this function uses the coldcc calling convention, prefer not to inline
 272   // it.
 273   if (Callee->getCallingConv() == CallingConv::Cold)
 274     InlineCost += InlineConstants::ColdccPenalty;
 275
 276   // If the instruction after the call, or if the normal destination of the
 277   // invoke is an unreachable instruction, the function is noreturn.  As such,
 278   // there is little point in inlining this.
 279   if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall)) {
 280     if (isa<UnreachableInst>(II->getNormalDest()->begin()))
 281       InlineCost += InlineConstants::NoreturnPenalty;
 282   } else if (isa<UnreachableInst>(++BasicBlock::iterator(TheCall)))
 283     InlineCost += InlineConstants::NoreturnPenalty;
 284
 285   // Get information about the callee...
 286   FunctionInfo &CalleeFI = CachedFunctionInfo[Callee];
 287
 288   // If we haven't calculated this information yet, do so now.
 289   if (CalleeFI.Metrics.NumBlocks == 0)
 290     CalleeFI.analyzeFunction(Callee);
 291
 292   // If we should never inline this, return a huge cost.
 293   if (CalleeFI.Metrics.NeverInline)
 294     return InlineCost::getNever();
 295
 296   // FIXME: It would be nice to kill off CalleeFI.NeverInline. Then we
 297   // could move this up and avoid computing the FunctionInfo for
 298   // things we are going to just return always inline for. This
 299   // requires handling setjmp somewhere else, however.
 300   if (!Callee->isDeclaration() && Callee->hasFnAttr(Attribute::AlwaysInline))
 301     return InlineCost::getAlways();
 302
 303   if (CalleeFI.Metrics.usesDynamicAlloca) {
 304     // Get infomation about the caller...
 305     FunctionInfo &CallerFI = CachedFunctionInfo[Caller];
 306
 307     // If we haven't calculated this information yet, do so now.
 308     if (CallerFI.Metrics.NumBlocks == 0)
 309       CallerFI.analyzeFunction(Caller);
 310
 311     // Don't inline a callee with dynamic alloca into a caller without them.
 312     // Functions containing dynamic alloca's are inefficient in various ways;
 313     // don't create more inefficiency.
 314     if (!CallerFI.Metrics.usesDynamicAlloca)
 315       return InlineCost::getNever();
 316   }
 317
 318   // Add to the inline quality for properties that make the call valuable to
 319   // inline.  This includes factors that indicate that the result of inlining
 320   // the function will be optimizable.  Currently this just looks at arguments
 321   // passed into the function.
 322   //
 323   unsigned ArgNo = 0;
 324   for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
 325        I != E; ++I, ++ArgNo) {
 326     // Each argument passed in has a cost at both the caller and the callee
 327     // sides.  Measurements show that each argument costs about the same as an
 328     // instruction.
 329     InlineCost -= InlineConstants::InstrCost;
 330
 331     // If an alloca is passed in, inlining this function is likely to allow
 332     // significant future optimization possibilities (like scalar promotion, and
 333     // scalarization), so encourage the inlining of the function.
 334     //
 335     if (isa<AllocaInst>(I)) {
 336       if (ArgNo < CalleeFI.ArgumentWeights.size())
 337         InlineCost -= CalleeFI.ArgumentWeights[ArgNo].AllocaWeight;
 338
 339       // If this is a constant being passed into the function, use the argument
 340       // weights calculated for the callee to determine how much will be folded
 341       // away with this information.
 342     } else if (isa<Constant>(I)) {
 343       if (ArgNo < CalleeFI.ArgumentWeights.size())
 344         InlineCost -= CalleeFI.ArgumentWeights[ArgNo].ConstantWeight;
 345     }
 346   }
 347
 348   // Now that we have considered all of the factors that make the call site more
 349   // likely to be inlined, look at factors that make us not want to inline it.
 350
 351   // Don't inline into something too big, which would make it bigger.
 352   // "size" here is the number of basic blocks, not instructions.
 353   //
 354   InlineCost += Caller->size()/15;
 355
 356   // Look at the size of the callee. Each instruction counts as 5.
 357   InlineCost += CalleeFI.Metrics.NumInsts*InlineConstants::InstrCost;
 358
 359   return llvm::InlineCost::get(InlineCost);
 360 }
 361
 362 // getInlineFudgeFactor - Return a > 1.0 factor if the inliner should use a
 363 // higher threshold to determine if the function call should be inlined.
 364 float InlineCostAnalyzer::getInlineFudgeFactor(CallSite CS) {
 365   Function *Callee = CS.getCalledFunction();
 366
 367   // Get information about the callee...
 368   FunctionInfo &CalleeFI = CachedFunctionInfo[Callee];
 369
 370   // If we haven't calculated this information yet, do so now.
 371   if (CalleeFI.Metrics.NumBlocks == 0)
 372     CalleeFI.analyzeFunction(Callee);
 373
 374   float Factor = 1.0f;
 375   // Single BB functions are often written to be inlined.
 376   if (CalleeFI.Metrics.NumBlocks == 1)
 377     Factor += 0.5f;
 378
 379   // Be more aggressive if the function contains a good chunk (if it mades up
 380   // at least 10% of the instructions) of vector instructions.
 381   if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/2)
 382     Factor += 2.0f;
 383   else if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/10)
 384     Factor += 1.5f;
 385   return Factor;
 386 }