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