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 void InlineCostAnalyzer::FunctionInfo::countCodeReductionForPointerPair(
 385     const CodeMetrics &Metrics, DenseMap<Value *, unsigned> &PointerArgs,
 386     Value *V, unsigned ArgIdx) {
 387   SmallVector<Value *, 4> Worklist;
 388   Worklist.push_back(V);
 389   do {
 390     Value *V = Worklist.pop_back_val();
 391     for (Value::use_iterator UI = V->use_begin(), E = V->use_end();
 392          UI != E; ++UI){
 393       Instruction *I = cast<Instruction>(*UI);
 394
 395       if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(I)) {
 396         // If the GEP has variable indices, we won't be able to do much with it.
 397         if (!GEP->hasAllConstantIndices())
 398           continue;
 399         // Unless the GEP is in-bounds, some comparisons will be non-constant.
 400         // Fortunately, the real-world cases where this occurs uses in-bounds
 401         // GEPs, and so we restrict the optimization to them here.
 402         if (!GEP->isInBounds())
 403           continue;
 404
 405         // Constant indices just change the constant offset. Add the resulting
 406         // value both to our worklist for this argument, and to the set of
 407         // viable paired values with future arguments.
 408         PointerArgs[GEP] = ArgIdx;
 409         Worklist.push_back(GEP);
 410         continue;
 411       }
 412
 413       // Track pointer through casts. Even when the result is not a pointer, it
 414       // remains a constant relative to constants derived from other constant
 415       // pointers.
 416       if (CastInst *CI = dyn_cast<CastInst>(I)) {
 417         PointerArgs[CI] = ArgIdx;
 418         Worklist.push_back(CI);
 419         continue;
 420       }
 421
 422       // There are two instructions which produce a strict constant value when
 423       // applied to two related pointer values. Ignore everything else.
 424       if (!isa<ICmpInst>(I) && I->getOpcode() != Instruction::Sub)
 425         continue;
 426       assert(I->getNumOperands() == 2);
 427
 428       // Ensure that the two operands are in our set of potentially paired
 429       // pointers (or are derived from them).
 430       Value *OtherArg = I->getOperand(0);
 431       if (OtherArg == V)
 432         OtherArg = I->getOperand(1);
 433       DenseMap<Value *, unsigned>::const_iterator ArgIt
 434         = PointerArgs.find(OtherArg);
 435       if (ArgIt == PointerArgs.end())
 436         continue;
 437       assert(ArgIt->second < ArgIdx);
 438
 439       PointerArgPairWeights[std::make_pair(ArgIt->second, ArgIdx)]
 440         += countCodeReductionForConstant(Metrics, I);
 441     }
 442   } while (!Worklist.empty());
 443 }
 444
 445 /// analyzeFunction - Fill in the current structure with information gleaned
 446 /// from the specified function.
 447 void CodeMetrics::analyzeFunction(Function *F, const TargetData *TD) {
 448   // If this function contains a call that "returns twice" (e.g., setjmp or
 449   // _setjmp) and it isn't marked with "returns twice" itself, never inline it.
 450   // This is a hack because we depend on the user marking their local variables
 451   // as volatile if they are live across a setjmp call, and they probably
 452   // won't do this in callers.
 453   exposesReturnsTwice = F->callsFunctionThatReturnsTwice() &&
 454     !F->hasFnAttr(Attribute::ReturnsTwice);
 455
 456   // Look at the size of the callee.
 457   for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
 458     analyzeBasicBlock(&*BB, TD);
 459 }
 460
 461 /// analyzeFunction - Fill in the current structure with information gleaned
 462 /// from the specified function.
 463 void InlineCostAnalyzer::FunctionInfo::analyzeFunction(Function *F,
 464                                                        const TargetData *TD) {
 465   Metrics.analyzeFunction(F, TD);
 466
 467   // A function with exactly one return has it removed during the inlining
 468   // process (see InlineFunction), so don't count it.
 469   // FIXME: This knowledge should really be encoded outside of FunctionInfo.
 470   if (Metrics.NumRets==1)
 471     --Metrics.NumInsts;
 472
 473   ArgumentWeights.reserve(F->arg_size());
 474   DenseMap<Value *, unsigned> PointerArgs;
 475   unsigned ArgIdx = 0;
 476   for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E;
 477        ++I, ++ArgIdx) {
 478     // Count how much code can be eliminated if one of the arguments is
 479     // a constant or an alloca.
 480     ArgumentWeights.push_back(ArgInfo(countCodeReductionForConstant(Metrics, I),
 481                                       countCodeReductionForAlloca(Metrics, I)));
 482
 483     // If the argument is a pointer, also check for pairs of pointers where
 484     // knowing a fixed offset between them allows simplification. This pattern
 485     // arises mostly due to STL algorithm patterns where pointers are used as
 486     // random access iterators.
 487     if (!I->getType()->isPointerTy())
 488       continue;
 489     PointerArgs[I] = ArgIdx;
 490     countCodeReductionForPointerPair(Metrics, PointerArgs, I, ArgIdx);
 491   }
 492 }
 493
 494 /// NeverInline - returns true if the function should never be inlined into
 495 /// any caller
 496 bool InlineCostAnalyzer::FunctionInfo::NeverInline() {
 497   return (Metrics.exposesReturnsTwice || Metrics.isRecursive ||
 498           Metrics.containsIndirectBr);
 499 }
 500 // getSpecializationBonus - The heuristic used to determine the per-call
 501 // performance boost for using a specialization of Callee with argument
 502 // specializedArgNo replaced by a constant.
 503 int InlineCostAnalyzer::getSpecializationBonus(Function *Callee,
 504          SmallVectorImpl<unsigned> &SpecializedArgNos)
 505 {
 506   if (Callee->mayBeOverridden())
 507     return 0;
 508
 509   int Bonus = 0;
 510   // If this function uses the coldcc calling convention, prefer not to
 511   // specialize it.
 512   if (Callee->getCallingConv() == CallingConv::Cold)
 513     Bonus -= InlineConstants::ColdccPenalty;
 514
 515   // Get information about the callee.
 516   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
 517
 518   // If we haven't calculated this information yet, do so now.
 519   if (CalleeFI->Metrics.NumBlocks == 0)
 520     CalleeFI->analyzeFunction(Callee, TD);
 521
 522   unsigned ArgNo = 0;
 523   unsigned i = 0;
 524   for (Function::arg_iterator I = Callee->arg_begin(), E = Callee->arg_end();
 525        I != E; ++I, ++ArgNo)
 526     if (ArgNo == SpecializedArgNos[i]) {
 527       ++i;
 528       Bonus += CountBonusForConstant(I);
 529     }
 530
 531   // Calls usually take a long time, so they make the specialization gain
 532   // smaller.
 533   Bonus -= CalleeFI->Metrics.NumCalls * InlineConstants::CallPenalty;
 534
 535   return Bonus;
 536 }
 537
 538 // ConstantFunctionBonus - Figure out how much of a bonus we can get for
 539 // possibly devirtualizing a function. We'll subtract the size of the function
 540 // we may wish to inline from the indirect call bonus providing a limit on
 541 // growth. Leave an upper limit of 0 for the bonus - we don't want to penalize
 542 // inlining because we decide we don't want to give a bonus for
 543 // devirtualizing.
 544 int InlineCostAnalyzer::ConstantFunctionBonus(CallSite CS, Constant *C) {
 545
 546   // This could just be NULL.
 547   if (!C) return 0;
 548
 549   Function *F = dyn_cast<Function>(C);
 550   if (!F) return 0;
 551
 552   int Bonus = InlineConstants::IndirectCallBonus + getInlineSize(CS, F);
 553   return (Bonus > 0) ? 0 : Bonus;
 554 }
 555
 556 // CountBonusForConstant - Figure out an approximation for how much per-call
 557 // performance boost we can expect if the specified value is constant.
 558 int InlineCostAnalyzer::CountBonusForConstant(Value *V, Constant *C) {
 559   unsigned Bonus = 0;
 560   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
 561     User *U = *UI;
 562     if (CallInst *CI = dyn_cast<CallInst>(U)) {
 563       // Turning an indirect call into a direct call is a BIG win
 564       if (CI->getCalledValue() == V)
 565         Bonus += ConstantFunctionBonus(CallSite(CI), C);
 566     } else if (InvokeInst *II = dyn_cast<InvokeInst>(U)) {
 567       // Turning an indirect call into a direct call is a BIG win
 568       if (II->getCalledValue() == V)
 569         Bonus += ConstantFunctionBonus(CallSite(II), C);
 570     }
 571     // FIXME: Eliminating conditional branches and switches should
 572     // also yield a per-call performance boost.
 573     else {
 574       // Figure out the bonuses that wll accrue due to simple constant
 575       // propagation.
 576       Instruction &Inst = cast<Instruction>(*U);
 577
 578       // We can't constant propagate instructions which have effects or
 579       // read memory.
 580       //
 581       // FIXME: It would be nice to capture the fact that a load from a
 582       // pointer-to-constant-global is actually a *really* good thing to zap.
 583       // Unfortunately, we don't know the pointer that may get propagated here,
 584       // so we can't make this decision.
 585       if (Inst.mayReadFromMemory() || Inst.mayHaveSideEffects() ||
 586           isa<AllocaInst>(Inst))
 587         continue;
 588
 589       bool AllOperandsConstant = true;
 590       for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i)
 591         if (!isa<Constant>(Inst.getOperand(i)) && Inst.getOperand(i) != V) {
 592           AllOperandsConstant = false;
 593           break;
 594         }
 595
 596       if (AllOperandsConstant)
 597         Bonus += CountBonusForConstant(&Inst);
 598     }
 599   }
 600
 601   return Bonus;
 602 }
 603
 604 int InlineCostAnalyzer::getInlineSize(CallSite CS, Function *Callee) {
 605   // Get information about the callee.
 606   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
 607
 608   // If we haven't calculated this information yet, do so now.
 609   if (CalleeFI->Metrics.NumBlocks == 0)
 610     CalleeFI->analyzeFunction(Callee, TD);
 611
 612   // InlineCost - This value measures how good of an inline candidate this call
 613   // site is to inline.  A lower inline cost make is more likely for the call to
 614   // be inlined.  This value may go negative.
 615   //
 616   int InlineCost = 0;
 617
 618   // Compute any size reductions we can expect due to arguments being passed into
 619   // the function.
 620   //
 621   unsigned ArgNo = 0;
 622   CallSite::arg_iterator I = CS.arg_begin();
 623   for (Function::arg_iterator FI = Callee->arg_begin(), FE = Callee->arg_end();
 624        FI != FE; ++I, ++FI, ++ArgNo) {
 625
 626     // If an alloca is passed in, inlining this function is likely to allow
 627     // significant future optimization possibilities (like scalar promotion, and
 628     // scalarization), so encourage the inlining of the function.
 629     //
 630     if (isa<AllocaInst>(I))
 631       InlineCost -= CalleeFI->ArgumentWeights[ArgNo].AllocaWeight;
 632
 633     // If this is a constant being passed into the function, use the argument
 634     // weights calculated for the callee to determine how much will be folded
 635     // away with this information.
 636     else if (isa<Constant>(I))
 637       InlineCost -= CalleeFI->ArgumentWeights[ArgNo].ConstantWeight;
 638   }
 639
 640   const DenseMap<std::pair<unsigned, unsigned>, unsigned> &ArgPairWeights
 641     = CalleeFI->PointerArgPairWeights;
 642   for (DenseMap<std::pair<unsigned, unsigned>, unsigned>::const_iterator I
 643          = ArgPairWeights.begin(), E = ArgPairWeights.end();
 644        I != E; ++I)
 645     if (CS.getArgument(I->first.first)->stripInBoundsConstantOffsets() ==
 646         CS.getArgument(I->first.second)->stripInBoundsConstantOffsets())
 647       InlineCost -= I->second;
 648
 649   // Each argument passed in has a cost at both the caller and the callee
 650   // sides.  Measurements show that each argument costs about the same as an
 651   // instruction.
 652   InlineCost -= (CS.arg_size() * InlineConstants::InstrCost);
 653
 654   // Now that we have considered all of the factors that make the call site more
 655   // likely to be inlined, look at factors that make us not want to inline it.
 656
 657   // Calls usually take a long time, so they make the inlining gain smaller.
 658   InlineCost += CalleeFI->Metrics.NumCalls * InlineConstants::CallPenalty;
 659
 660   // Look at the size of the callee. Each instruction counts as 5.
 661   InlineCost += CalleeFI->Metrics.NumInsts * InlineConstants::InstrCost;
 662
 663   return InlineCost;
 664 }
 665
 666 int InlineCostAnalyzer::getInlineBonuses(CallSite CS, Function *Callee) {
 667   // Get information about the callee.
 668   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
 669
 670   // If we haven't calculated this information yet, do so now.
 671   if (CalleeFI->Metrics.NumBlocks == 0)
 672     CalleeFI->analyzeFunction(Callee, TD);
 673
 674   bool isDirectCall = CS.getCalledFunction() == Callee;
 675   Instruction *TheCall = CS.getInstruction();
 676   int Bonus = 0;
 677
 678   // If there is only one call of the function, and it has internal linkage,
 679   // make it almost guaranteed to be inlined.
 680   //
 681   if (Callee->hasLocalLinkage() && Callee->hasOneUse() && isDirectCall)
 682     Bonus += InlineConstants::LastCallToStaticBonus;
 683
 684   // If the instruction after the call, or if the normal destination of the
 685   // invoke is an unreachable instruction, the function is noreturn.  As such,
 686   // there is little point in inlining this.
 687   if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall)) {
 688     if (isa<UnreachableInst>(II->getNormalDest()->begin()))
 689       Bonus += InlineConstants::NoreturnPenalty;
 690   } else if (isa<UnreachableInst>(++BasicBlock::iterator(TheCall)))
 691     Bonus += InlineConstants::NoreturnPenalty;
 692
 693   // If this function uses the coldcc calling convention, prefer not to inline
 694   // it.
 695   if (Callee->getCallingConv() == CallingConv::Cold)
 696     Bonus += InlineConstants::ColdccPenalty;
 697
 698   // Add to the inline quality for properties that make the call valuable to
 699   // inline.  This includes factors that indicate that the result of inlining
 700   // the function will be optimizable.  Currently this just looks at arguments
 701   // passed into the function.
 702   //
 703   CallSite::arg_iterator I = CS.arg_begin();
 704   for (Function::arg_iterator FI = Callee->arg_begin(), FE = Callee->arg_end();
 705        FI != FE; ++I, ++FI)
 706     // Compute any constant bonus due to inlining we want to give here.
 707     if (isa<Constant>(I))
 708       Bonus += CountBonusForConstant(FI, cast<Constant>(I));
 709
 710   return Bonus;
 711 }
 712
 713 // getInlineCost - The heuristic used to determine if we should inline the
 714 // function call or not.
 715 //
 716 InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
 717                                SmallPtrSet<const Function*, 16> &NeverInline) {
 718   return getInlineCost(CS, CS.getCalledFunction(), NeverInline);
 719 }
 720
 721 InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
 722                                Function *Callee,
 723                                SmallPtrSet<const Function*, 16> &NeverInline) {
 724   Instruction *TheCall = CS.getInstruction();
 725   Function *Caller = TheCall->getParent()->getParent();
 726
 727   // Don't inline functions which can be redefined at link-time to mean
 728   // something else.  Don't inline functions marked noinline or call sites
 729   // marked noinline.
 730   if (Callee->mayBeOverridden() ||
 731       Callee->hasFnAttr(Attribute::NoInline) || NeverInline.count(Callee) ||
 732       CS.isNoInline())
 733     return llvm::InlineCost::getNever();
 734
 735   // Get information about the callee.
 736   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
 737
 738   // If we haven't calculated this information yet, do so now.
 739   if (CalleeFI->Metrics.NumBlocks == 0)
 740     CalleeFI->analyzeFunction(Callee, TD);
 741
 742   // If we should never inline this, return a huge cost.
 743   if (CalleeFI->NeverInline())
 744     return InlineCost::getNever();
 745
 746   // FIXME: It would be nice to kill off CalleeFI->NeverInline. Then we
 747   // could move this up and avoid computing the FunctionInfo for
 748   // things we are going to just return always inline for. This
 749   // requires handling setjmp somewhere else, however.
 750   if (!Callee->isDeclaration() && Callee->hasFnAttr(Attribute::AlwaysInline))
 751     return InlineCost::getAlways();
 752
 753   if (CalleeFI->Metrics.usesDynamicAlloca) {
 754     // Get information about the caller.
 755     FunctionInfo &CallerFI = CachedFunctionInfo[Caller];
 756
 757     // If we haven't calculated this information yet, do so now.
 758     if (CallerFI.Metrics.NumBlocks == 0) {
 759       CallerFI.analyzeFunction(Caller, TD);
 760
 761       // Recompute the CalleeFI pointer, getting Caller could have invalidated
 762       // it.
 763       CalleeFI = &CachedFunctionInfo[Callee];
 764     }
 765
 766     // Don't inline a callee with dynamic alloca into a caller without them.
 767     // Functions containing dynamic alloca's are inefficient in various ways;
 768     // don't create more inefficiency.
 769     if (!CallerFI.Metrics.usesDynamicAlloca)
 770       return InlineCost::getNever();
 771   }
 772
 773   // InlineCost - This value measures how good of an inline candidate this call
 774   // site is to inline.  A lower inline cost make is more likely for the call to
 775   // be inlined.  This value may go negative due to the fact that bonuses
 776   // are negative numbers.
 777   //
 778   int InlineCost = getInlineSize(CS, Callee) + getInlineBonuses(CS, Callee);
 779   return llvm::InlineCost::get(InlineCost);
 780 }
 781
 782 // getSpecializationCost - The heuristic used to determine the code-size
 783 // impact of creating a specialized version of Callee with argument
 784 // SpecializedArgNo replaced by a constant.
 785 InlineCost InlineCostAnalyzer::getSpecializationCost(Function *Callee,
 786                                SmallVectorImpl<unsigned> &SpecializedArgNos)
 787 {
 788   // Don't specialize functions which can be redefined at link-time to mean
 789   // something else.
 790   if (Callee->mayBeOverridden())
 791     return llvm::InlineCost::getNever();
 792
 793   // Get information about the callee.
 794   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
 795
 796   // If we haven't calculated this information yet, do so now.
 797   if (CalleeFI->Metrics.NumBlocks == 0)
 798     CalleeFI->analyzeFunction(Callee, TD);
 799
 800   int Cost = 0;
 801
 802   // Look at the original size of the callee.  Each instruction counts as 5.
 803   Cost += CalleeFI->Metrics.NumInsts * InlineConstants::InstrCost;
 804
 805   // Offset that with the amount of code that can be constant-folded
 806   // away with the given arguments replaced by constants.
 807   for (SmallVectorImpl<unsigned>::iterator an = SpecializedArgNos.begin(),
 808        ae = SpecializedArgNos.end(); an != ae; ++an)
 809     Cost -= CalleeFI->ArgumentWeights[*an].ConstantWeight;
 810
 811   return llvm::InlineCost::get(Cost);
 812 }
 813
 814 // getInlineFudgeFactor - Return a > 1.0 factor if the inliner should use a
 815 // higher threshold to determine if the function call should be inlined.
 816 float InlineCostAnalyzer::getInlineFudgeFactor(CallSite CS) {
 817   Function *Callee = CS.getCalledFunction();
 818
 819   // Get information about the callee.
 820   FunctionInfo &CalleeFI = CachedFunctionInfo[Callee];
 821
 822   // If we haven't calculated this information yet, do so now.
 823   if (CalleeFI.Metrics.NumBlocks == 0)
 824     CalleeFI.analyzeFunction(Callee, TD);
 825
 826   float Factor = 1.0f;
 827   // Single BB functions are often written to be inlined.
 828   if (CalleeFI.Metrics.NumBlocks == 1)
 829     Factor += 0.5f;
 830
 831   // Be more aggressive if the function contains a good chunk (if it mades up
 832   // at least 10% of the instructions) of vector instructions.
 833   if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/2)
 834     Factor += 2.0f;
 835   else if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/10)
 836     Factor += 1.5f;
 837   return Factor;
 838 }
 839
 840 /// growCachedCostInfo - update the cached cost info for Caller after Callee has
 841 /// been inlined.
 842 void
 843 InlineCostAnalyzer::growCachedCostInfo(Function *Caller, Function *Callee) {
 844   CodeMetrics &CallerMetrics = CachedFunctionInfo[Caller].Metrics;
 845
 846   // For small functions we prefer to recalculate the cost for better accuracy.
 847   if (CallerMetrics.NumBlocks < 10 && CallerMetrics.NumInsts < 1000) {
 848     resetCachedCostInfo(Caller);
 849     return;
 850   }
 851
 852   // For large functions, we can save a lot of computation time by skipping
 853   // recalculations.
 854   if (CallerMetrics.NumCalls > 0)
 855     --CallerMetrics.NumCalls;
 856
 857   if (Callee == 0) return;
 858
 859   CodeMetrics &CalleeMetrics = CachedFunctionInfo[Callee].Metrics;
 860
 861   // If we don't have metrics for the callee, don't recalculate them just to
 862   // update an approximation in the caller.  Instead, just recalculate the
 863   // caller info from scratch.
 864   if (CalleeMetrics.NumBlocks == 0) {
 865     resetCachedCostInfo(Caller);
 866     return;
 867   }
 868
 869   // Since CalleeMetrics were already calculated, we know that the CallerMetrics
 870   // reference isn't invalidated: both were in the DenseMap.
 871   CallerMetrics.usesDynamicAlloca |= CalleeMetrics.usesDynamicAlloca;
 872
 873   // FIXME: If any of these three are true for the callee, the callee was
 874   // not inlined into the caller, so I think they're redundant here.
 875   CallerMetrics.exposesReturnsTwice |= CalleeMetrics.exposesReturnsTwice;
 876   CallerMetrics.isRecursive |= CalleeMetrics.isRecursive;
 877   CallerMetrics.containsIndirectBr |= CalleeMetrics.containsIndirectBr;
 878
 879   CallerMetrics.NumInsts += CalleeMetrics.NumInsts;
 880   CallerMetrics.NumBlocks += CalleeMetrics.NumBlocks;
 881   CallerMetrics.NumCalls += CalleeMetrics.NumCalls;
 882   CallerMetrics.NumVectorInsts += CalleeMetrics.NumVectorInsts;
 883   CallerMetrics.NumRets += CalleeMetrics.NumRets;
 884
 885   // analyzeBasicBlock counts each function argument as an inst.
 886   if (CallerMetrics.NumInsts >= Callee->arg_size())
 887     CallerMetrics.NumInsts -= Callee->arg_size();
 888   else
 889     CallerMetrics.NumInsts = 0;
 890
 891   // We are not updating the argument weights. We have already determined that
 892   // Caller is a fairly large function, so we accept the loss of precision.
 893 }
 894
 895 /// clear - empty the cache of inline costs
 896 void InlineCostAnalyzer::clear() {
 897   CachedFunctionInfo.clear();
 898 }