1 //===- InlineCost.cpp - Cost analysis for inliner -------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements inline cost analysis.
12 //===----------------------------------------------------------------------===//
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"
21 /// callIsSmall - If a call is likely to lower to a single target instruction,
22 /// or is otherwise deemed small return true.
23 /// TODO: Perhaps calls like memcpy, strcpy, etc?
24 bool llvm::callIsSmall(const Function *F) {
27 if (F->hasLocalLinkage()) return false;
29 if (!F->hasName()) return false;
31 StringRef Name = F->getName();
33 // These will all likely lower to a single selection DAG node.
34 if (Name == "copysign" || Name == "copysignf" || Name == "copysignl" ||
35 Name == "fabs" || Name == "fabsf" || Name == "fabsl" ||
36 Name == "sin" || Name == "sinf" || Name == "sinl" ||
37 Name == "cos" || Name == "cosf" || Name == "cosl" ||
38 Name == "sqrt" || Name == "sqrtf" || Name == "sqrtl" )
41 // These are all likely to be optimized into something smaller.
42 if (Name == "pow" || Name == "powf" || Name == "powl" ||
43 Name == "exp2" || Name == "exp2l" || Name == "exp2f" ||
44 Name == "floor" || Name == "floorf" || Name == "ceil" ||
45 Name == "round" || Name == "ffs" || Name == "ffsl" ||
46 Name == "abs" || Name == "labs" || Name == "llabs")
52 /// analyzeBasicBlock - Fill in the current structure with information gleaned
53 /// from the specified block.
54 void CodeMetrics::analyzeBasicBlock(const BasicBlock *BB) {
56 unsigned NumInstsBeforeThisBB = NumInsts;
57 for (BasicBlock::const_iterator II = BB->begin(), E = BB->end();
59 if (isa<PHINode>(II)) continue; // PHI nodes don't count.
61 // Special handling for calls.
62 if (isa<CallInst>(II) || isa<InvokeInst>(II)) {
63 if (isa<DbgInfoIntrinsic>(II))
64 continue; // Debug intrinsics don't count as size.
66 ImmutableCallSite CS(cast<Instruction>(II));
68 // If this function contains a call to setjmp or _setjmp, never inline
69 // it. This is a hack because we depend on the user marking their local
70 // variables as volatile if they are live across a setjmp call, and they
71 // probably won't do this in callers.
72 if (const Function *F = CS.getCalledFunction()) {
73 // If a function is both internal and has a single use, then it is
74 // extremely likely to get inlined in the future (it was probably
75 // exposed by an interleaved devirtualization pass).
76 if (F->hasInternalLinkage() && F->hasOneUse())
77 ++NumInlineCandidates;
79 if (F->isDeclaration() &&
80 (F->getName() == "setjmp" || F->getName() == "_setjmp"))
83 // If this call is to function itself, then the function is recursive.
84 // Inlining it into other functions is a bad idea, because this is
85 // basically just a form of loop peeling, and our metrics aren't useful
87 if (F == BB->getParent())
91 if (!isa<IntrinsicInst>(II) && !callIsSmall(CS.getCalledFunction())) {
92 // Each argument to a call takes on average one instruction to set up.
93 NumInsts += CS.arg_size();
95 // We don't want inline asm to count as a call - that would prevent loop
96 // unrolling. The argument setup cost is still real, though.
97 if (!isa<InlineAsm>(CS.getCalledValue()))
102 if (const AllocaInst *AI = dyn_cast<AllocaInst>(II)) {
103 if (!AI->isStaticAlloca())
104 this->usesDynamicAlloca = true;
107 if (isa<ExtractElementInst>(II) || II->getType()->isVectorTy())
110 if (const CastInst *CI = dyn_cast<CastInst>(II)) {
111 // Noop casts, including ptr <-> int, don't count.
112 if (CI->isLosslessCast() || isa<IntToPtrInst>(CI) ||
113 isa<PtrToIntInst>(CI))
115 // Result of a cmp instruction is often extended (to be used by other
116 // cmp instructions, logical or return instructions). These are usually
117 // nop on most sane targets.
118 if (isa<CmpInst>(CI->getOperand(0)))
120 } else if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(II)){
121 // If a GEP has all constant indices, it will probably be folded with
123 if (GEPI->hasAllConstantIndices())
130 if (isa<ReturnInst>(BB->getTerminator()))
133 // We never want to inline functions that contain an indirectbr. This is
134 // incorrect because all the blockaddress's (in static global initializers
135 // for example) would be referring to the original function, and this indirect
136 // jump would jump from the inlined copy of the function into the original
137 // function which is extremely undefined behavior.
138 if (isa<IndirectBrInst>(BB->getTerminator()))
139 containsIndirectBr = true;
141 // Remember NumInsts for this BB.
142 NumBBInsts[BB] = NumInsts - NumInstsBeforeThisBB;
145 // CountBonusForConstant - Figure out an approximation for how much per-call
146 // performance boost we can expect if the specified value is constant.
147 unsigned CodeMetrics::CountBonusForConstant(Value *V) {
149 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
151 if (CallInst *CI = dyn_cast<CallInst>(U)) {
152 // Turning an indirect call into a direct call is a BIG win
153 if (CI->getCalledValue() == V)
154 Bonus += InlineConstants::IndirectCallBonus;
156 else if (InvokeInst *II = dyn_cast<InvokeInst>(U)) {
157 // Turning an indirect call into a direct call is a BIG win
158 if (II->getCalledValue() == V)
159 Bonus += InlineConstants::IndirectCallBonus;
161 // FIXME: Eliminating conditional branches and switches should
162 // also yield a per-call performance boost.
164 // Figure out the bonuses that wll accrue due to simple constant
166 Instruction &Inst = cast<Instruction>(*U);
168 // We can't constant propagate instructions which have effects or
171 // FIXME: It would be nice to capture the fact that a load from a
172 // pointer-to-constant-global is actually a *really* good thing to zap.
173 // Unfortunately, we don't know the pointer that may get propagated here,
174 // so we can't make this decision.
175 if (Inst.mayReadFromMemory() || Inst.mayHaveSideEffects() ||
176 isa<AllocaInst>(Inst))
179 bool AllOperandsConstant = true;
180 for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i)
181 if (!isa<Constant>(Inst.getOperand(i)) && Inst.getOperand(i) != V) {
182 AllOperandsConstant = false;
186 if (AllOperandsConstant)
187 Bonus += CountBonusForConstant(&Inst);
194 // CountCodeReductionForConstant - Figure out an approximation for how many
195 // instructions will be constant folded if the specified value is constant.
197 unsigned CodeMetrics::CountCodeReductionForConstant(Value *V) {
198 unsigned Reduction = 0;
199 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
201 if (isa<BranchInst>(U) || isa<SwitchInst>(U)) {
202 // We will be able to eliminate all but one of the successors.
203 const TerminatorInst &TI = cast<TerminatorInst>(*U);
204 const unsigned NumSucc = TI.getNumSuccessors();
206 for (unsigned I = 0; I != NumSucc; ++I)
207 Instrs += NumBBInsts[TI.getSuccessor(I)];
208 // We don't know which blocks will be eliminated, so use the average size.
209 Reduction += InlineConstants::InstrCost*Instrs*(NumSucc-1)/NumSucc;
211 // Figure out if this instruction will be removed due to simple constant
213 Instruction &Inst = cast<Instruction>(*U);
215 // We can't constant propagate instructions which have effects or
218 // FIXME: It would be nice to capture the fact that a load from a
219 // pointer-to-constant-global is actually a *really* good thing to zap.
220 // Unfortunately, we don't know the pointer that may get propagated here,
221 // so we can't make this decision.
222 if (Inst.mayReadFromMemory() || Inst.mayHaveSideEffects() ||
223 isa<AllocaInst>(Inst))
226 bool AllOperandsConstant = true;
227 for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i)
228 if (!isa<Constant>(Inst.getOperand(i)) && Inst.getOperand(i) != V) {
229 AllOperandsConstant = false;
233 if (AllOperandsConstant) {
234 // We will get to remove this instruction...
235 Reduction += InlineConstants::InstrCost;
237 // And any other instructions that use it which become constants
239 Reduction += CountCodeReductionForConstant(&Inst);
246 // CountCodeReductionForAlloca - Figure out an approximation of how much smaller
247 // the function will be if it is inlined into a context where an argument
248 // becomes an alloca.
250 unsigned CodeMetrics::CountCodeReductionForAlloca(Value *V) {
251 if (!V->getType()->isPointerTy()) return 0; // Not a pointer
252 unsigned Reduction = 0;
253 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
254 Instruction *I = cast<Instruction>(*UI);
255 if (isa<LoadInst>(I) || isa<StoreInst>(I))
256 Reduction += InlineConstants::InstrCost;
257 else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(I)) {
258 // If the GEP has variable indices, we won't be able to do much with it.
259 if (GEP->hasAllConstantIndices())
260 Reduction += CountCodeReductionForAlloca(GEP);
261 } else if (BitCastInst *BCI = dyn_cast<BitCastInst>(I)) {
262 // Track pointer through bitcasts.
263 Reduction += CountCodeReductionForAlloca(BCI);
265 // If there is some other strange instruction, we're not going to be able
266 // to do much if we inline this.
274 /// analyzeFunction - Fill in the current structure with information gleaned
275 /// from the specified function.
276 void CodeMetrics::analyzeFunction(Function *F) {
277 // Look at the size of the callee.
278 for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
279 analyzeBasicBlock(&*BB);
282 /// analyzeFunction - Fill in the current structure with information gleaned
283 /// from the specified function.
284 void InlineCostAnalyzer::FunctionInfo::analyzeFunction(Function *F) {
285 Metrics.analyzeFunction(F);
287 // A function with exactly one return has it removed during the inlining
288 // process (see InlineFunction), so don't count it.
289 // FIXME: This knowledge should really be encoded outside of FunctionInfo.
290 if (Metrics.NumRets==1)
293 // Don't bother calculating argument weights if we are never going to inline
294 // the function anyway.
298 // Check out all of the arguments to the function, figuring out how much
299 // code can be eliminated if one of the arguments is a constant.
300 ArgumentWeights.reserve(F->arg_size());
301 for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
302 ArgumentWeights.push_back(ArgInfo(Metrics.CountCodeReductionForConstant(I),
303 Metrics.CountCodeReductionForAlloca(I),
304 Metrics.CountBonusForConstant(I)));
307 /// NeverInline - returns true if the function should never be inlined into
309 bool InlineCostAnalyzer::FunctionInfo::NeverInline()
311 return (Metrics.callsSetJmp || Metrics.isRecursive ||
312 Metrics.containsIndirectBr);
315 // getInlineCost - The heuristic used to determine if we should inline the
316 // function call or not.
318 InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
319 SmallPtrSet<const Function*, 16> &NeverInline) {
320 return getInlineCost(CS, CS.getCalledFunction(), NeverInline);
323 InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
325 SmallPtrSet<const Function*, 16> &NeverInline) {
326 Instruction *TheCall = CS.getInstruction();
327 Function *Caller = TheCall->getParent()->getParent();
328 bool isDirectCall = CS.getCalledFunction() == Callee;
330 // Don't inline functions which can be redefined at link-time to mean
331 // something else. Don't inline functions marked noinline or call sites
333 if (Callee->mayBeOverridden() ||
334 Callee->hasFnAttr(Attribute::NoInline) || NeverInline.count(Callee) ||
336 return llvm::InlineCost::getNever();
338 // InlineCost - This value measures how good of an inline candidate this call
339 // site is to inline. A lower inline cost make is more likely for the call to
340 // be inlined. This value may go negative.
344 // If there is only one call of the function, and it has internal linkage,
345 // make it almost guaranteed to be inlined.
347 if (Callee->hasLocalLinkage() && Callee->hasOneUse() && isDirectCall)
348 InlineCost += InlineConstants::LastCallToStaticBonus;
350 // If this function uses the coldcc calling convention, prefer not to inline
352 if (Callee->getCallingConv() == CallingConv::Cold)
353 InlineCost += InlineConstants::ColdccPenalty;
355 // If the instruction after the call, or if the normal destination of the
356 // invoke is an unreachable instruction, the function is noreturn. As such,
357 // there is little point in inlining this.
358 if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall)) {
359 if (isa<UnreachableInst>(II->getNormalDest()->begin()))
360 InlineCost += InlineConstants::NoreturnPenalty;
361 } else if (isa<UnreachableInst>(++BasicBlock::iterator(TheCall)))
362 InlineCost += InlineConstants::NoreturnPenalty;
364 // Get information about the callee.
365 FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
367 // If we haven't calculated this information yet, do so now.
368 if (CalleeFI->Metrics.NumBlocks == 0)
369 CalleeFI->analyzeFunction(Callee);
371 // If we should never inline this, return a huge cost.
372 if (CalleeFI->NeverInline())
373 return InlineCost::getNever();
375 // FIXME: It would be nice to kill off CalleeFI->NeverInline. Then we
376 // could move this up and avoid computing the FunctionInfo for
377 // things we are going to just return always inline for. This
378 // requires handling setjmp somewhere else, however.
379 if (!Callee->isDeclaration() && Callee->hasFnAttr(Attribute::AlwaysInline))
380 return InlineCost::getAlways();
382 if (CalleeFI->Metrics.usesDynamicAlloca) {
383 // Get infomation about the caller.
384 FunctionInfo &CallerFI = CachedFunctionInfo[Caller];
386 // If we haven't calculated this information yet, do so now.
387 if (CallerFI.Metrics.NumBlocks == 0) {
388 CallerFI.analyzeFunction(Caller);
390 // Recompute the CalleeFI pointer, getting Caller could have invalidated
392 CalleeFI = &CachedFunctionInfo[Callee];
395 // Don't inline a callee with dynamic alloca into a caller without them.
396 // Functions containing dynamic alloca's are inefficient in various ways;
397 // don't create more inefficiency.
398 if (!CallerFI.Metrics.usesDynamicAlloca)
399 return InlineCost::getNever();
402 // Add to the inline quality for properties that make the call valuable to
403 // inline. This includes factors that indicate that the result of inlining
404 // the function will be optimizable. Currently this just looks at arguments
405 // passed into the function.
408 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
409 I != E; ++I, ++ArgNo) {
410 // Each argument passed in has a cost at both the caller and the callee
411 // sides. Measurements show that each argument costs about the same as an
413 InlineCost -= InlineConstants::InstrCost;
415 // If an alloca is passed in, inlining this function is likely to allow
416 // significant future optimization possibilities (like scalar promotion, and
417 // scalarization), so encourage the inlining of the function.
419 if (isa<AllocaInst>(I)) {
420 if (ArgNo < CalleeFI->ArgumentWeights.size())
421 InlineCost -= CalleeFI->ArgumentWeights[ArgNo].AllocaWeight;
423 // If this is a constant being passed into the function, use the argument
424 // weights calculated for the callee to determine how much will be folded
425 // away with this information.
426 } else if (isa<Constant>(I)) {
427 if (ArgNo < CalleeFI->ArgumentWeights.size())
428 InlineCost -= (CalleeFI->ArgumentWeights[ArgNo].ConstantWeight +
429 CalleeFI->ArgumentWeights[ArgNo].ConstantBonus);
433 // Now that we have considered all of the factors that make the call site more
434 // likely to be inlined, look at factors that make us not want to inline it.
436 // Calls usually take a long time, so they make the inlining gain smaller.
437 InlineCost += CalleeFI->Metrics.NumCalls * InlineConstants::CallPenalty;
439 // Look at the size of the callee. Each instruction counts as 5.
440 InlineCost += CalleeFI->Metrics.NumInsts*InlineConstants::InstrCost;
442 return llvm::InlineCost::get(InlineCost);
445 // getInlineFudgeFactor - Return a > 1.0 factor if the inliner should use a
446 // higher threshold to determine if the function call should be inlined.
447 float InlineCostAnalyzer::getInlineFudgeFactor(CallSite CS) {
448 Function *Callee = CS.getCalledFunction();
450 // Get information about the callee.
451 FunctionInfo &CalleeFI = CachedFunctionInfo[Callee];
453 // If we haven't calculated this information yet, do so now.
454 if (CalleeFI.Metrics.NumBlocks == 0)
455 CalleeFI.analyzeFunction(Callee);
458 // Single BB functions are often written to be inlined.
459 if (CalleeFI.Metrics.NumBlocks == 1)
462 // Be more aggressive if the function contains a good chunk (if it mades up
463 // at least 10% of the instructions) of vector instructions.
464 if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/2)
466 else if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/10)
471 /// growCachedCostInfo - update the cached cost info for Caller after Callee has
474 InlineCostAnalyzer::growCachedCostInfo(Function *Caller, Function *Callee) {
475 CodeMetrics &CallerMetrics = CachedFunctionInfo[Caller].Metrics;
477 // For small functions we prefer to recalculate the cost for better accuracy.
478 if (CallerMetrics.NumBlocks < 10 || CallerMetrics.NumInsts < 1000) {
479 resetCachedCostInfo(Caller);
483 // For large functions, we can save a lot of computation time by skipping
485 if (CallerMetrics.NumCalls > 0)
486 --CallerMetrics.NumCalls;
488 if (Callee == 0) return;
490 CodeMetrics &CalleeMetrics = CachedFunctionInfo[Callee].Metrics;
492 // If we don't have metrics for the callee, don't recalculate them just to
493 // update an approximation in the caller. Instead, just recalculate the
494 // caller info from scratch.
495 if (CalleeMetrics.NumBlocks == 0) {
496 resetCachedCostInfo(Caller);
500 // Since CalleeMetrics were already calculated, we know that the CallerMetrics
501 // reference isn't invalidated: both were in the DenseMap.
502 CallerMetrics.usesDynamicAlloca |= CalleeMetrics.usesDynamicAlloca;
504 // FIXME: If any of these three are true for the callee, the callee was
505 // not inlined into the caller, so I think they're redundant here.
506 CallerMetrics.callsSetJmp |= CalleeMetrics.callsSetJmp;
507 CallerMetrics.isRecursive |= CalleeMetrics.isRecursive;
508 CallerMetrics.containsIndirectBr |= CalleeMetrics.containsIndirectBr;
510 CallerMetrics.NumInsts += CalleeMetrics.NumInsts;
511 CallerMetrics.NumBlocks += CalleeMetrics.NumBlocks;
512 CallerMetrics.NumCalls += CalleeMetrics.NumCalls;
513 CallerMetrics.NumVectorInsts += CalleeMetrics.NumVectorInsts;
514 CallerMetrics.NumRets += CalleeMetrics.NumRets;
516 // analyzeBasicBlock counts each function argument as an inst.
517 if (CallerMetrics.NumInsts >= Callee->arg_size())
518 CallerMetrics.NumInsts -= Callee->arg_size();
520 CallerMetrics.NumInsts = 0;
522 // We are not updating the argument weights. We have already determined that
523 // Caller is a fairly large function, so we accept the loss of precision.
526 /// clear - empty the cache of inline costs
527 void InlineCostAnalyzer::clear() {
528 CachedFunctionInfo.clear();