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/Target/TargetData.h"
  19 #include "llvm/ADT/SmallPtrSet.h"
  20
  21 using namespace llvm;
  22
  23 /// callIsSmall - If a call is likely to lower to a single target instruction,
  24 /// or is otherwise deemed small return true.
  25 /// TODO: Perhaps calls like memcpy, strcpy, etc?
  26 bool llvm::callIsSmall(const Function *F) {
  27   if (!F) return false;
  28
  29   if (F->hasLocalLinkage()) return false;
  30
  31   if (!F->hasName()) return false;
  32
  33   StringRef Name = F->getName();
  34
  35   // These will all likely lower to a single selection DAG node.
  36   if (Name == "copysign" || Name == "copysignf" || Name == "copysignl" ||
  37       Name == "fabs" || Name == "fabsf" || Name == "fabsl" ||
  38       Name == "sin" || Name == "sinf" || Name == "sinl" ||
  39       Name == "cos" || Name == "cosf" || Name == "cosl" ||
  40       Name == "sqrt" || Name == "sqrtf" || Name == "sqrtl" )
  41     return true;
  42
  43   // These are all likely to be optimized into something smaller.
  44   if (Name == "pow" || Name == "powf" || Name == "powl" ||
  45       Name == "exp2" || Name == "exp2l" || Name == "exp2f" ||
  46       Name == "floor" || Name == "floorf" || Name == "ceil" ||
  47       Name == "round" || Name == "ffs" || Name == "ffsl" ||
  48       Name == "abs" || Name == "labs" || Name == "llabs")
  49     return true;
  50
  51   return false;
  52 }
  53
  54 /// analyzeBasicBlock - Fill in the current structure with information gleaned
  55 /// from the specified block.
  56 void CodeMetrics::analyzeBasicBlock(const BasicBlock *BB,
  57                                     const TargetData *TD) {
  58   ++NumBlocks;
  59   unsigned NumInstsBeforeThisBB = NumInsts;
  60   for (BasicBlock::const_iterator II = BB->begin(), E = BB->end();
  61        II != E; ++II) {
  62     if (isa<PHINode>(II)) continue;           // PHI nodes don't count.
  63
  64     // Special handling for calls.
  65     if (isa<CallInst>(II) || isa<InvokeInst>(II)) {
  66       if (const IntrinsicInst *IntrinsicI = dyn_cast<IntrinsicInst>(II)) {
  67         switch (IntrinsicI->getIntrinsicID()) {
  68         default: break;
  69         case Intrinsic::dbg_declare:
  70         case Intrinsic::dbg_value:
  71         case Intrinsic::invariant_start:
  72         case Intrinsic::invariant_end:
  73         case Intrinsic::lifetime_start:
  74         case Intrinsic::lifetime_end:
  75         case Intrinsic::objectsize:
  76         case Intrinsic::ptr_annotation:
  77         case Intrinsic::var_annotation:
  78           // These intrinsics don't count as size.
  79           continue;
  80         }
  81       }
  82
  83       ImmutableCallSite CS(cast<Instruction>(II));
  84
  85       if (const Function *F = CS.getCalledFunction()) {
  86         // If a function is both internal and has a single use, then it is
  87         // extremely likely to get inlined in the future (it was probably
  88         // exposed by an interleaved devirtualization pass).
  89         if (!CS.isNoInline() && F->hasInternalLinkage() && F->hasOneUse())
  90           ++NumInlineCandidates;
  91
  92         // If this call is to function itself, then the function is recursive.
  93         // Inlining it into other functions is a bad idea, because this is
  94         // basically just a form of loop peeling, and our metrics aren't useful
  95         // for that case.
  96         if (F == BB->getParent())
  97           isRecursive = true;
  98       }
  99
 100       if (!isa<IntrinsicInst>(II) && !callIsSmall(CS.getCalledFunction())) {
 101         // Each argument to a call takes on average one instruction to set up.
 102         NumInsts += CS.arg_size();
 103
 104         // We don't want inline asm to count as a call - that would prevent loop
 105         // unrolling. The argument setup cost is still real, though.
 106         if (!isa<InlineAsm>(CS.getCalledValue()))
 107           ++NumCalls;
 108       }
 109     }
 110
 111     if (const AllocaInst *AI = dyn_cast<AllocaInst>(II)) {
 112       if (!AI->isStaticAlloca())
 113         this->usesDynamicAlloca = true;
 114     }
 115
 116     if (isa<ExtractElementInst>(II) || II->getType()->isVectorTy())
 117       ++NumVectorInsts;
 118
 119     if (const CastInst *CI = dyn_cast<CastInst>(II)) {
 120       // Noop casts, including ptr <-> int,  don't count.
 121       if (CI->isLosslessCast() || isa<IntToPtrInst>(CI) ||
 122           isa<PtrToIntInst>(CI))
 123         continue;
 124       // trunc to a native type is free (assuming the target has compare and
 125       // shift-right of the same width).
 126       if (isa<TruncInst>(CI) && TD &&
 127           TD->isLegalInteger(TD->getTypeSizeInBits(CI->getType())))
 128         continue;
 129       // Result of a cmp instruction is often extended (to be used by other
 130       // cmp instructions, logical or return instructions). These are usually
 131       // nop on most sane targets.
 132       if (isa<CmpInst>(CI->getOperand(0)))
 133         continue;
 134     } else if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(II)){
 135       // If a GEP has all constant indices, it will probably be folded with
 136       // a load/store.
 137       if (GEPI->hasAllConstantIndices())
 138         continue;
 139     }
 140
 141     ++NumInsts;
 142   }
 143
 144   if (isa<ReturnInst>(BB->getTerminator()))
 145     ++NumRets;
 146
 147   // We never want to inline functions that contain an indirectbr.  This is
 148   // incorrect because all the blockaddress's (in static global initializers
 149   // for example) would be referring to the original function, and this indirect
 150   // jump would jump from the inlined copy of the function into the original
 151   // function which is extremely undefined behavior.
 152   // FIXME: This logic isn't really right; we can safely inline functions
 153   // with indirectbr's as long as no other function or global references the
 154   // blockaddress of a block within the current function.  And as a QOI issue,
 155   // if someone is using a blockaddress without an indirectbr, and that
 156   // reference somehow ends up in another function or global, we probably
 157   // don't want to inline this function.
 158   if (isa<IndirectBrInst>(BB->getTerminator()))
 159     containsIndirectBr = true;
 160
 161   // Remember NumInsts for this BB.
 162   NumBBInsts[BB] = NumInsts - NumInstsBeforeThisBB;
 163 }
 164
 165 unsigned InlineCostAnalyzer::FunctionInfo::countCodeReductionForConstant(
 166     const CodeMetrics &Metrics, Value *V) {
 167   unsigned Reduction = 0;
 168   SmallVector<Value *, 4> Worklist;
 169   Worklist.push_back(V);
 170   do {
 171     Value *V = Worklist.pop_back_val();
 172     for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
 173       User *U = *UI;
 174       if (isa<BranchInst>(U) || isa<SwitchInst>(U)) {
 175         // We will be able to eliminate all but one of the successors.
 176         const TerminatorInst &TI = cast<TerminatorInst>(*U);
 177         const unsigned NumSucc = TI.getNumSuccessors();
 178         unsigned Instrs = 0;
 179         for (unsigned I = 0; I != NumSucc; ++I)
 180           Instrs += Metrics.NumBBInsts.lookup(TI.getSuccessor(I));
 181         // We don't know which blocks will be eliminated, so use the average size.
 182         Reduction += InlineConstants::InstrCost*Instrs*(NumSucc-1)/NumSucc;
 183         continue;
 184       }
 185
 186       // Figure out if this instruction will be removed due to simple constant
 187       // propagation.
 188       Instruction &Inst = cast<Instruction>(*U);
 189
 190       // We can't constant propagate instructions which have effects or
 191       // read memory.
 192       //
 193       // FIXME: It would be nice to capture the fact that a load from a
 194       // pointer-to-constant-global is actually a *really* good thing to zap.
 195       // Unfortunately, we don't know the pointer that may get propagated here,
 196       // so we can't make this decision.
 197       if (Inst.mayReadFromMemory() || Inst.mayHaveSideEffects() ||
 198           isa<AllocaInst>(Inst))
 199         continue;
 200
 201       bool AllOperandsConstant = true;
 202       for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i)
 203         if (!isa<Constant>(Inst.getOperand(i)) && Inst.getOperand(i) != V) {
 204           AllOperandsConstant = false;
 205           break;
 206         }
 207       if (!AllOperandsConstant)
 208         continue;
 209
 210       // We will get to remove this instruction...
 211       Reduction += InlineConstants::InstrCost;
 212
 213       // And any other instructions that use it which become constants
 214       // themselves.
 215       Worklist.push_back(&Inst);
 216     }
 217   } while (!Worklist.empty());
 218   return Reduction;
 219 }
 220
 221 static unsigned countCodeReductionForAllocaICmp(const CodeMetrics &Metrics,
 222                                                 ICmpInst *ICI) {
 223   unsigned Reduction = 0;
 224
 225   // Bail if this is comparing against a non-constant; there is nothing we can
 226   // do there.
 227   if (!isa<Constant>(ICI->getOperand(1)))
 228     return Reduction;
 229
 230   // An icmp pred (alloca, C) becomes true if the predicate is true when
 231   // equal and false otherwise.
 232   bool Result = ICI->isTrueWhenEqual();
 233
 234   SmallVector<Instruction *, 4> Worklist;
 235   Worklist.push_back(ICI);
 236   do {
 237     Instruction *U = Worklist.pop_back_val();
 238     Reduction += InlineConstants::InstrCost;
 239     for (Value::use_iterator UI = U->use_begin(), UE = U->use_end();
 240          UI != UE; ++UI) {
 241       Instruction *I = dyn_cast<Instruction>(*UI);
 242       if (!I || I->mayHaveSideEffects()) continue;
 243       if (I->getNumOperands() == 1)
 244         Worklist.push_back(I);
 245       if (BinaryOperator *BO = dyn_cast<BinaryOperator>(I)) {
 246         // If BO produces the same value as U, then the other operand is
 247         // irrelevant and we can put it into the Worklist to continue
 248         // deleting dead instructions. If BO produces the same value as the
 249         // other operand, we can delete BO but that's it.
 250         if (Result == true) {
 251           if (BO->getOpcode() == Instruction::Or)
 252             Worklist.push_back(I);
 253           if (BO->getOpcode() == Instruction::And)
 254             Reduction += InlineConstants::InstrCost;
 255         } else {
 256           if (BO->getOpcode() == Instruction::Or ||
 257               BO->getOpcode() == Instruction::Xor)
 258             Reduction += InlineConstants::InstrCost;
 259           if (BO->getOpcode() == Instruction::And)
 260             Worklist.push_back(I);
 261         }
 262       }
 263       if (BranchInst *BI = dyn_cast<BranchInst>(I)) {
 264         BasicBlock *BB = BI->getSuccessor(Result ? 0 : 1);
 265         if (BB->getSinglePredecessor())
 266           Reduction
 267             += InlineConstants::InstrCost * Metrics.NumBBInsts.lookup(BB);
 268       }
 269     }
 270   } while (!Worklist.empty());
 271
 272   return Reduction;
 273 }
 274
 275 /// \brief Compute the reduction possible for a given instruction if we are able
 276 /// to SROA an alloca.
 277 ///
 278 /// The reduction for this instruction is added to the SROAReduction output
 279 /// parameter. Returns false if this instruction is expected to defeat SROA in
 280 /// general.
 281 static bool countCodeReductionForSROAInst(Instruction *I,
 282                                           SmallVectorImpl<Value *> &Worklist,
 283                                           unsigned &SROAReduction) {
 284   if (LoadInst *LI = dyn_cast<LoadInst>(I)) {
 285     if (!LI->isSimple())
 286       return false;
 287     SROAReduction += InlineConstants::InstrCost;
 288     return true;
 289   }
 290
 291   if (StoreInst *SI = dyn_cast<StoreInst>(I)) {
 292     if (!SI->isSimple())
 293       return false;
 294     SROAReduction += InlineConstants::InstrCost;
 295     return true;
 296   }
 297
 298   if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(I)) {
 299     // If the GEP has variable indices, we won't be able to do much with it.
 300     if (!GEP->hasAllConstantIndices())
 301       return false;
 302     // A non-zero GEP will likely become a mask operation after SROA.
 303     if (GEP->hasAllZeroIndices())
 304       SROAReduction += InlineConstants::InstrCost;
 305     Worklist.push_back(GEP);
 306     return true;
 307   }
 308
 309   if (BitCastInst *BCI = dyn_cast<BitCastInst>(I)) {
 310     // Track pointer through bitcasts.
 311     Worklist.push_back(BCI);
 312     SROAReduction += InlineConstants::InstrCost;
 313     return true;
 314   }
 315
 316   // We just look for non-constant operands to ICmp instructions as those will
 317   // defeat SROA. The actual reduction for these happens even without SROA.
 318   if (ICmpInst *ICI = dyn_cast<ICmpInst>(I))
 319     return isa<Constant>(ICI->getOperand(1));
 320
 321   if (SelectInst *SI = dyn_cast<SelectInst>(I)) {
 322     // SROA can handle a select of alloca iff all uses of the alloca are
 323     // loads, and dereferenceable. We assume it's dereferenceable since
 324     // we're told the input is an alloca.
 325     for (Value::use_iterator UI = SI->use_begin(), UE = SI->use_end();
 326          UI != UE; ++UI) {
 327       LoadInst *LI = dyn_cast<LoadInst>(*UI);
 328       if (LI == 0 || !LI->isSimple())
 329         return false;
 330     }
 331     // We don't know whether we'll be deleting the rest of the chain of
 332     // instructions from the SelectInst on, because we don't know whether
 333     // the other side of the select is also an alloca or not.
 334     return true;
 335   }
 336
 337   if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(I)) {
 338     switch (II->getIntrinsicID()) {
 339     default:
 340       return false;
 341     case Intrinsic::memset:
 342     case Intrinsic::memcpy:
 343     case Intrinsic::memmove:
 344     case Intrinsic::lifetime_start:
 345     case Intrinsic::lifetime_end:
 346       // SROA can usually chew through these intrinsics.
 347       SROAReduction += InlineConstants::InstrCost;
 348       return true;
 349     }
 350   }
 351
 352   // If there is some other strange instruction, we're not going to be
 353   // able to do much if we inline this.
 354   return false;
 355 }
 356
 357 unsigned InlineCostAnalyzer::FunctionInfo::countCodeReductionForAlloca(
 358     const CodeMetrics &Metrics, Value *V) {
 359   if (!V->getType()->isPointerTy()) return 0;  // Not a pointer
 360   unsigned Reduction = 0;
 361   unsigned SROAReduction = 0;
 362   bool CanSROAAlloca = true;
 363
 364   SmallVector<Value *, 4> Worklist;
 365   Worklist.push_back(V);
 366   do {
 367     Value *V = Worklist.pop_back_val();
 368     for (Value::use_iterator UI = V->use_begin(), E = V->use_end();
 369          UI != E; ++UI){
 370       Instruction *I = cast<Instruction>(*UI);
 371
 372       if (ICmpInst *ICI = dyn_cast<ICmpInst>(I))
 373         Reduction += countCodeReductionForAllocaICmp(Metrics, ICI);
 374
 375       if (CanSROAAlloca)
 376         CanSROAAlloca = countCodeReductionForSROAInst(I, Worklist,
 377                                                       SROAReduction);
 378     }
 379   } while (!Worklist.empty());
 380
 381   return Reduction + (CanSROAAlloca ? SROAReduction : 0);
 382 }
 383
 384 /// analyzeFunction - Fill in the current structure with information gleaned
 385 /// from the specified function.
 386 void CodeMetrics::analyzeFunction(Function *F, const TargetData *TD) {
 387   // If this function contains a call that "returns twice" (e.g., setjmp or
 388   // _setjmp) and it isn't marked with "returns twice" itself, never inline it.
 389   // This is a hack because we depend on the user marking their local variables
 390   // as volatile if they are live across a setjmp call, and they probably
 391   // won't do this in callers.
 392   exposesReturnsTwice = F->callsFunctionThatReturnsTwice() &&
 393     !F->hasFnAttr(Attribute::ReturnsTwice);
 394
 395   // Look at the size of the callee.
 396   for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
 397     analyzeBasicBlock(&*BB, TD);
 398 }
 399
 400 /// analyzeFunction - Fill in the current structure with information gleaned
 401 /// from the specified function.
 402 void InlineCostAnalyzer::FunctionInfo::analyzeFunction(Function *F,
 403                                                        const TargetData *TD) {
 404   Metrics.analyzeFunction(F, TD);
 405
 406   // A function with exactly one return has it removed during the inlining
 407   // process (see InlineFunction), so don't count it.
 408   // FIXME: This knowledge should really be encoded outside of FunctionInfo.
 409   if (Metrics.NumRets==1)
 410     --Metrics.NumInsts;
 411
 412   // Check out all of the arguments to the function, figuring out how much
 413   // code can be eliminated if one of the arguments is a constant.
 414   ArgumentWeights.reserve(F->arg_size());
 415   for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
 416     ArgumentWeights.push_back(ArgInfo(countCodeReductionForConstant(Metrics, I),
 417                                       countCodeReductionForAlloca(Metrics, I)));
 418 }
 419
 420 /// NeverInline - returns true if the function should never be inlined into
 421 /// any caller
 422 bool InlineCostAnalyzer::FunctionInfo::NeverInline() {
 423   return (Metrics.exposesReturnsTwice || Metrics.isRecursive ||
 424           Metrics.containsIndirectBr);
 425 }
 426 // getSpecializationBonus - The heuristic used to determine the per-call
 427 // performance boost for using a specialization of Callee with argument
 428 // specializedArgNo replaced by a constant.
 429 int InlineCostAnalyzer::getSpecializationBonus(Function *Callee,
 430          SmallVectorImpl<unsigned> &SpecializedArgNos)
 431 {
 432   if (Callee->mayBeOverridden())
 433     return 0;
 434
 435   int Bonus = 0;
 436   // If this function uses the coldcc calling convention, prefer not to
 437   // specialize it.
 438   if (Callee->getCallingConv() == CallingConv::Cold)
 439     Bonus -= InlineConstants::ColdccPenalty;
 440
 441   // Get information about the callee.
 442   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
 443
 444   // If we haven't calculated this information yet, do so now.
 445   if (CalleeFI->Metrics.NumBlocks == 0)
 446     CalleeFI->analyzeFunction(Callee, TD);
 447
 448   unsigned ArgNo = 0;
 449   unsigned i = 0;
 450   for (Function::arg_iterator I = Callee->arg_begin(), E = Callee->arg_end();
 451        I != E; ++I, ++ArgNo)
 452     if (ArgNo == SpecializedArgNos[i]) {
 453       ++i;
 454       Bonus += CountBonusForConstant(I);
 455     }
 456
 457   // Calls usually take a long time, so they make the specialization gain
 458   // smaller.
 459   Bonus -= CalleeFI->Metrics.NumCalls * InlineConstants::CallPenalty;
 460
 461   return Bonus;
 462 }
 463
 464 // ConstantFunctionBonus - Figure out how much of a bonus we can get for
 465 // possibly devirtualizing a function. We'll subtract the size of the function
 466 // we may wish to inline from the indirect call bonus providing a limit on
 467 // growth. Leave an upper limit of 0 for the bonus - we don't want to penalize
 468 // inlining because we decide we don't want to give a bonus for
 469 // devirtualizing.
 470 int InlineCostAnalyzer::ConstantFunctionBonus(CallSite CS, Constant *C) {
 471
 472   // This could just be NULL.
 473   if (!C) return 0;
 474
 475   Function *F = dyn_cast<Function>(C);
 476   if (!F) return 0;
 477
 478   int Bonus = InlineConstants::IndirectCallBonus + getInlineSize(CS, F);
 479   return (Bonus > 0) ? 0 : Bonus;
 480 }
 481
 482 // CountBonusForConstant - Figure out an approximation for how much per-call
 483 // performance boost we can expect if the specified value is constant.
 484 int InlineCostAnalyzer::CountBonusForConstant(Value *V, Constant *C) {
 485   unsigned Bonus = 0;
 486   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
 487     User *U = *UI;
 488     if (CallInst *CI = dyn_cast<CallInst>(U)) {
 489       // Turning an indirect call into a direct call is a BIG win
 490       if (CI->getCalledValue() == V)
 491         Bonus += ConstantFunctionBonus(CallSite(CI), C);
 492     } else if (InvokeInst *II = dyn_cast<InvokeInst>(U)) {
 493       // Turning an indirect call into a direct call is a BIG win
 494       if (II->getCalledValue() == V)
 495         Bonus += ConstantFunctionBonus(CallSite(II), C);
 496     }
 497     // FIXME: Eliminating conditional branches and switches should
 498     // also yield a per-call performance boost.
 499     else {
 500       // Figure out the bonuses that wll accrue due to simple constant
 501       // propagation.
 502       Instruction &Inst = cast<Instruction>(*U);
 503
 504       // We can't constant propagate instructions which have effects or
 505       // read memory.
 506       //
 507       // FIXME: It would be nice to capture the fact that a load from a
 508       // pointer-to-constant-global is actually a *really* good thing to zap.
 509       // Unfortunately, we don't know the pointer that may get propagated here,
 510       // so we can't make this decision.
 511       if (Inst.mayReadFromMemory() || Inst.mayHaveSideEffects() ||
 512           isa<AllocaInst>(Inst))
 513         continue;
 514
 515       bool AllOperandsConstant = true;
 516       for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i)
 517         if (!isa<Constant>(Inst.getOperand(i)) && Inst.getOperand(i) != V) {
 518           AllOperandsConstant = false;
 519           break;
 520         }
 521
 522       if (AllOperandsConstant)
 523         Bonus += CountBonusForConstant(&Inst);
 524     }
 525   }
 526
 527   return Bonus;
 528 }
 529
 530 int InlineCostAnalyzer::getInlineSize(CallSite CS, Function *Callee) {
 531   // Get information about the callee.
 532   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
 533
 534   // If we haven't calculated this information yet, do so now.
 535   if (CalleeFI->Metrics.NumBlocks == 0)
 536     CalleeFI->analyzeFunction(Callee, TD);
 537
 538   // InlineCost - This value measures how good of an inline candidate this call
 539   // site is to inline.  A lower inline cost make is more likely for the call to
 540   // be inlined.  This value may go negative.
 541   //
 542   int InlineCost = 0;
 543
 544   // Compute any size reductions we can expect due to arguments being passed into
 545   // the function.
 546   //
 547   unsigned ArgNo = 0;
 548   CallSite::arg_iterator I = CS.arg_begin();
 549   for (Function::arg_iterator FI = Callee->arg_begin(), FE = Callee->arg_end();
 550        FI != FE; ++I, ++FI, ++ArgNo) {
 551
 552     // If an alloca is passed in, inlining this function is likely to allow
 553     // significant future optimization possibilities (like scalar promotion, and
 554     // scalarization), so encourage the inlining of the function.
 555     //
 556     if (isa<AllocaInst>(I))
 557       InlineCost -= CalleeFI->ArgumentWeights[ArgNo].AllocaWeight;
 558
 559     // If this is a constant being passed into the function, use the argument
 560     // weights calculated for the callee to determine how much will be folded
 561     // away with this information.
 562     else if (isa<Constant>(I))
 563       InlineCost -= CalleeFI->ArgumentWeights[ArgNo].ConstantWeight;
 564   }
 565
 566   // Each argument passed in has a cost at both the caller and the callee
 567   // sides.  Measurements show that each argument costs about the same as an
 568   // instruction.
 569   InlineCost -= (CS.arg_size() * InlineConstants::InstrCost);
 570
 571   // Now that we have considered all of the factors that make the call site more
 572   // likely to be inlined, look at factors that make us not want to inline it.
 573
 574   // Calls usually take a long time, so they make the inlining gain smaller.
 575   InlineCost += CalleeFI->Metrics.NumCalls * InlineConstants::CallPenalty;
 576
 577   // Look at the size of the callee. Each instruction counts as 5.
 578   InlineCost += CalleeFI->Metrics.NumInsts * InlineConstants::InstrCost;
 579
 580   return InlineCost;
 581 }
 582
 583 int InlineCostAnalyzer::getInlineBonuses(CallSite CS, Function *Callee) {
 584   // Get information about the callee.
 585   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
 586
 587   // If we haven't calculated this information yet, do so now.
 588   if (CalleeFI->Metrics.NumBlocks == 0)
 589     CalleeFI->analyzeFunction(Callee, TD);
 590
 591   bool isDirectCall = CS.getCalledFunction() == Callee;
 592   Instruction *TheCall = CS.getInstruction();
 593   int Bonus = 0;
 594
 595   // If there is only one call of the function, and it has internal linkage,
 596   // make it almost guaranteed to be inlined.
 597   //
 598   if (Callee->hasLocalLinkage() && Callee->hasOneUse() && isDirectCall)
 599     Bonus += InlineConstants::LastCallToStaticBonus;
 600
 601   // If the instruction after the call, or if the normal destination of the
 602   // invoke is an unreachable instruction, the function is noreturn.  As such,
 603   // there is little point in inlining this.
 604   if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall)) {
 605     if (isa<UnreachableInst>(II->getNormalDest()->begin()))
 606       Bonus += InlineConstants::NoreturnPenalty;
 607   } else if (isa<UnreachableInst>(++BasicBlock::iterator(TheCall)))
 608     Bonus += InlineConstants::NoreturnPenalty;
 609
 610   // If this function uses the coldcc calling convention, prefer not to inline
 611   // it.
 612   if (Callee->getCallingConv() == CallingConv::Cold)
 613     Bonus += InlineConstants::ColdccPenalty;
 614
 615   // Add to the inline quality for properties that make the call valuable to
 616   // inline.  This includes factors that indicate that the result of inlining
 617   // the function will be optimizable.  Currently this just looks at arguments
 618   // passed into the function.
 619   //
 620   CallSite::arg_iterator I = CS.arg_begin();
 621   for (Function::arg_iterator FI = Callee->arg_begin(), FE = Callee->arg_end();
 622        FI != FE; ++I, ++FI)
 623     // Compute any constant bonus due to inlining we want to give here.
 624     if (isa<Constant>(I))
 625       Bonus += CountBonusForConstant(FI, cast<Constant>(I));
 626
 627   return Bonus;
 628 }
 629
 630 // getInlineCost - The heuristic used to determine if we should inline the
 631 // function call or not.
 632 //
 633 InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
 634                                SmallPtrSet<const Function*, 16> &NeverInline) {
 635   return getInlineCost(CS, CS.getCalledFunction(), NeverInline);
 636 }
 637
 638 InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
 639                                Function *Callee,
 640                                SmallPtrSet<const Function*, 16> &NeverInline) {
 641   Instruction *TheCall = CS.getInstruction();
 642   Function *Caller = TheCall->getParent()->getParent();
 643
 644   // Don't inline functions which can be redefined at link-time to mean
 645   // something else.  Don't inline functions marked noinline or call sites
 646   // marked noinline.
 647   if (Callee->mayBeOverridden() ||
 648       Callee->hasFnAttr(Attribute::NoInline) || NeverInline.count(Callee) ||
 649       CS.isNoInline())
 650     return llvm::InlineCost::getNever();
 651
 652   // Get information about the callee.
 653   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
 654
 655   // If we haven't calculated this information yet, do so now.
 656   if (CalleeFI->Metrics.NumBlocks == 0)
 657     CalleeFI->analyzeFunction(Callee, TD);
 658
 659   // If we should never inline this, return a huge cost.
 660   if (CalleeFI->NeverInline())
 661     return InlineCost::getNever();
 662
 663   // FIXME: It would be nice to kill off CalleeFI->NeverInline. Then we
 664   // could move this up and avoid computing the FunctionInfo for
 665   // things we are going to just return always inline for. This
 666   // requires handling setjmp somewhere else, however.
 667   if (!Callee->isDeclaration() && Callee->hasFnAttr(Attribute::AlwaysInline))
 668     return InlineCost::getAlways();
 669
 670   if (CalleeFI->Metrics.usesDynamicAlloca) {
 671     // Get information about the caller.
 672     FunctionInfo &CallerFI = CachedFunctionInfo[Caller];
 673
 674     // If we haven't calculated this information yet, do so now.
 675     if (CallerFI.Metrics.NumBlocks == 0) {
 676       CallerFI.analyzeFunction(Caller, TD);
 677
 678       // Recompute the CalleeFI pointer, getting Caller could have invalidated
 679       // it.
 680       CalleeFI = &CachedFunctionInfo[Callee];
 681     }
 682
 683     // Don't inline a callee with dynamic alloca into a caller without them.
 684     // Functions containing dynamic alloca's are inefficient in various ways;
 685     // don't create more inefficiency.
 686     if (!CallerFI.Metrics.usesDynamicAlloca)
 687       return InlineCost::getNever();
 688   }
 689
 690   // InlineCost - This value measures how good of an inline candidate this call
 691   // site is to inline.  A lower inline cost make is more likely for the call to
 692   // be inlined.  This value may go negative due to the fact that bonuses
 693   // are negative numbers.
 694   //
 695   int InlineCost = getInlineSize(CS, Callee) + getInlineBonuses(CS, Callee);
 696   return llvm::InlineCost::get(InlineCost);
 697 }
 698
 699 // getSpecializationCost - The heuristic used to determine the code-size
 700 // impact of creating a specialized version of Callee with argument
 701 // SpecializedArgNo replaced by a constant.
 702 InlineCost InlineCostAnalyzer::getSpecializationCost(Function *Callee,
 703                                SmallVectorImpl<unsigned> &SpecializedArgNos)
 704 {
 705   // Don't specialize functions which can be redefined at link-time to mean
 706   // something else.
 707   if (Callee->mayBeOverridden())
 708     return llvm::InlineCost::getNever();
 709
 710   // Get information about the callee.
 711   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
 712
 713   // If we haven't calculated this information yet, do so now.
 714   if (CalleeFI->Metrics.NumBlocks == 0)
 715     CalleeFI->analyzeFunction(Callee, TD);
 716
 717   int Cost = 0;
 718
 719   // Look at the original size of the callee.  Each instruction counts as 5.
 720   Cost += CalleeFI->Metrics.NumInsts * InlineConstants::InstrCost;
 721
 722   // Offset that with the amount of code that can be constant-folded
 723   // away with the given arguments replaced by constants.
 724   for (SmallVectorImpl<unsigned>::iterator an = SpecializedArgNos.begin(),
 725        ae = SpecializedArgNos.end(); an != ae; ++an)
 726     Cost -= CalleeFI->ArgumentWeights[*an].ConstantWeight;
 727
 728   return llvm::InlineCost::get(Cost);
 729 }
 730
 731 // getInlineFudgeFactor - Return a > 1.0 factor if the inliner should use a
 732 // higher threshold to determine if the function call should be inlined.
 733 float InlineCostAnalyzer::getInlineFudgeFactor(CallSite CS) {
 734   Function *Callee = CS.getCalledFunction();
 735
 736   // Get information about the callee.
 737   FunctionInfo &CalleeFI = CachedFunctionInfo[Callee];
 738
 739   // If we haven't calculated this information yet, do so now.
 740   if (CalleeFI.Metrics.NumBlocks == 0)
 741     CalleeFI.analyzeFunction(Callee, TD);
 742
 743   float Factor = 1.0f;
 744   // Single BB functions are often written to be inlined.
 745   if (CalleeFI.Metrics.NumBlocks == 1)
 746     Factor += 0.5f;
 747
 748   // Be more aggressive if the function contains a good chunk (if it mades up
 749   // at least 10% of the instructions) of vector instructions.
 750   if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/2)
 751     Factor += 2.0f;
 752   else if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/10)
 753     Factor += 1.5f;
 754   return Factor;
 755 }
 756
 757 /// growCachedCostInfo - update the cached cost info for Caller after Callee has
 758 /// been inlined.
 759 void
 760 InlineCostAnalyzer::growCachedCostInfo(Function *Caller, Function *Callee) {
 761   CodeMetrics &CallerMetrics = CachedFunctionInfo[Caller].Metrics;
 762
 763   // For small functions we prefer to recalculate the cost for better accuracy.
 764   if (CallerMetrics.NumBlocks < 10 && CallerMetrics.NumInsts < 1000) {
 765     resetCachedCostInfo(Caller);
 766     return;
 767   }
 768
 769   // For large functions, we can save a lot of computation time by skipping
 770   // recalculations.
 771   if (CallerMetrics.NumCalls > 0)
 772     --CallerMetrics.NumCalls;
 773
 774   if (Callee == 0) return;
 775
 776   CodeMetrics &CalleeMetrics = CachedFunctionInfo[Callee].Metrics;
 777
 778   // If we don't have metrics for the callee, don't recalculate them just to
 779   // update an approximation in the caller.  Instead, just recalculate the
 780   // caller info from scratch.
 781   if (CalleeMetrics.NumBlocks == 0) {
 782     resetCachedCostInfo(Caller);
 783     return;
 784   }
 785
 786   // Since CalleeMetrics were already calculated, we know that the CallerMetrics
 787   // reference isn't invalidated: both were in the DenseMap.
 788   CallerMetrics.usesDynamicAlloca |= CalleeMetrics.usesDynamicAlloca;
 789
 790   // FIXME: If any of these three are true for the callee, the callee was
 791   // not inlined into the caller, so I think they're redundant here.
 792   CallerMetrics.exposesReturnsTwice |= CalleeMetrics.exposesReturnsTwice;
 793   CallerMetrics.isRecursive |= CalleeMetrics.isRecursive;
 794   CallerMetrics.containsIndirectBr |= CalleeMetrics.containsIndirectBr;
 795
 796   CallerMetrics.NumInsts += CalleeMetrics.NumInsts;
 797   CallerMetrics.NumBlocks += CalleeMetrics.NumBlocks;
 798   CallerMetrics.NumCalls += CalleeMetrics.NumCalls;
 799   CallerMetrics.NumVectorInsts += CalleeMetrics.NumVectorInsts;
 800   CallerMetrics.NumRets += CalleeMetrics.NumRets;
 801
 802   // analyzeBasicBlock counts each function argument as an inst.
 803   if (CallerMetrics.NumInsts >= Callee->arg_size())
 804     CallerMetrics.NumInsts -= Callee->arg_size();
 805   else
 806     CallerMetrics.NumInsts = 0;
 807
 808   // We are not updating the argument weights. We have already determined that
 809   // Caller is a fairly large function, so we accept the loss of precision.
 810 }
 811
 812 /// clear - empty the cache of inline costs
 813 void InlineCostAnalyzer::clear() {
 814   CachedFunctionInfo.clear();
 815 }