blob: 98a158ab2690eb7c7433a93928ead47da78e0f8f [file] [log] [blame]
Dan Gohmane4aeec02009-10-13 18:30:07 +00001//===- InlineCost.cpp - Cost analysis for inliner -------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements inline cost analysis.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/Analysis/InlineCost.h"
15#include "llvm/Support/CallSite.h"
16#include "llvm/CallingConv.h"
17#include "llvm/IntrinsicInst.h"
18#include "llvm/ADT/SmallPtrSet.h"
Eric Christopher4e8af6d2011-02-05 00:49:15 +000019
Dan Gohmane4aeec02009-10-13 18:30:07 +000020using namespace llvm;
21
Dan Gohman52d55bd2010-04-16 15:14:50 +000022/// callIsSmall - If a call is likely to lower to a single target instruction,
23/// or is otherwise deemed small return true.
24/// TODO: Perhaps calls like memcpy, strcpy, etc?
25bool llvm::callIsSmall(const Function *F) {
Eric Christopher745d8c92010-01-14 21:48:00 +000026 if (!F) return false;
27
28 if (F->hasLocalLinkage()) return false;
29
Eric Christopher83c20d32010-01-14 23:00:10 +000030 if (!F->hasName()) return false;
31
32 StringRef Name = F->getName();
33
34 // These will all likely lower to a single selection DAG node.
Duncan Sands87cd7ed2010-03-15 14:01:44 +000035 if (Name == "copysign" || Name == "copysignf" || Name == "copysignl" ||
Eric Christopher83c20d32010-01-14 23:00:10 +000036 Name == "fabs" || Name == "fabsf" || Name == "fabsl" ||
37 Name == "sin" || Name == "sinf" || Name == "sinl" ||
38 Name == "cos" || Name == "cosf" || Name == "cosl" ||
39 Name == "sqrt" || Name == "sqrtf" || Name == "sqrtl" )
40 return true;
41
42 // These are all likely to be optimized into something smaller.
43 if (Name == "pow" || Name == "powf" || Name == "powl" ||
44 Name == "exp2" || Name == "exp2l" || Name == "exp2f" ||
45 Name == "floor" || Name == "floorf" || Name == "ceil" ||
46 Name == "round" || Name == "ffs" || Name == "ffsl" ||
47 Name == "abs" || Name == "labs" || Name == "llabs")
48 return true;
49
Eric Christopher2d59ae62010-01-14 20:12:34 +000050 return false;
51}
52
Dan Gohmane4aeec02009-10-13 18:30:07 +000053/// analyzeBasicBlock - Fill in the current structure with information gleaned
54/// from the specified block.
Dan Gohmane7f0ed52009-10-13 19:58:07 +000055void CodeMetrics::analyzeBasicBlock(const BasicBlock *BB) {
Dan Gohmane4aeec02009-10-13 18:30:07 +000056 ++NumBlocks;
Devang Patelafc33fa2010-03-13 01:05:02 +000057 unsigned NumInstsBeforeThisBB = NumInsts;
Dan Gohmane4aeec02009-10-13 18:30:07 +000058 for (BasicBlock::const_iterator II = BB->begin(), E = BB->end();
59 II != E; ++II) {
60 if (isa<PHINode>(II)) continue; // PHI nodes don't count.
61
62 // Special handling for calls.
63 if (isa<CallInst>(II) || isa<InvokeInst>(II)) {
64 if (isa<DbgInfoIntrinsic>(II))
65 continue; // Debug intrinsics don't count as size.
Gabor Greif0de11e02010-07-27 14:15:29 +000066
67 ImmutableCallSite CS(cast<Instruction>(II));
68
Dan Gohmane4aeec02009-10-13 18:30:07 +000069 // If this function contains a call to setjmp or _setjmp, never inline
70 // it. This is a hack because we depend on the user marking their local
71 // variables as volatile if they are live across a setjmp call, and they
72 // probably won't do this in callers.
Gabor Greif0de11e02010-07-27 14:15:29 +000073 if (const Function *F = CS.getCalledFunction()) {
Owen Andersonf9a26b82010-09-09 20:32:23 +000074 // If a function is both internal and has a single use, then it is
75 // extremely likely to get inlined in the future (it was probably
76 // exposed by an interleaved devirtualization pass).
77 if (F->hasInternalLinkage() && F->hasOneUse())
78 ++NumInlineCandidates;
79
Dan Gohmane4aeec02009-10-13 18:30:07 +000080 if (F->isDeclaration() &&
Dan Gohman497f6192009-10-13 20:10:10 +000081 (F->getName() == "setjmp" || F->getName() == "_setjmp"))
Kenneth Uildriks42c7d232010-06-09 15:11:37 +000082 callsSetJmp = true;
Chris Lattner4b7b42c2010-04-30 22:37:22 +000083
84 // If this call is to function itself, then the function is recursive.
85 // Inlining it into other functions is a bad idea, because this is
86 // basically just a form of loop peeling, and our metrics aren't useful
87 // for that case.
88 if (F == BB->getParent())
Kenneth Uildriks42c7d232010-06-09 15:11:37 +000089 isRecursive = true;
Chris Lattner4b7b42c2010-04-30 22:37:22 +000090 }
Dan Gohmane4aeec02009-10-13 18:30:07 +000091
Jakob Stoklund Olesenaa034fa2010-02-05 23:21:18 +000092 if (!isa<IntrinsicInst>(II) && !callIsSmall(CS.getCalledFunction())) {
93 // Each argument to a call takes on average one instruction to set up.
94 NumInsts += CS.arg_size();
Jakob Stoklund Olesen8b3ca842010-05-26 22:40:28 +000095
96 // We don't want inline asm to count as a call - that would prevent loop
97 // unrolling. The argument setup cost is still real, though.
98 if (!isa<InlineAsm>(CS.getCalledValue()))
99 ++NumCalls;
Jakob Stoklund Olesenaa034fa2010-02-05 23:21:18 +0000100 }
Dan Gohmane4aeec02009-10-13 18:30:07 +0000101 }
102
Dan Gohmane4aeec02009-10-13 18:30:07 +0000103 if (const AllocaInst *AI = dyn_cast<AllocaInst>(II)) {
104 if (!AI->isStaticAlloca())
105 this->usesDynamicAlloca = true;
106 }
107
Duncan Sands1df98592010-02-16 11:11:14 +0000108 if (isa<ExtractElementInst>(II) || II->getType()->isVectorTy())
Dan Gohmane4aeec02009-10-13 18:30:07 +0000109 ++NumVectorInsts;
110
Dan Gohmane4aeec02009-10-13 18:30:07 +0000111 if (const CastInst *CI = dyn_cast<CastInst>(II)) {
Evan Cheng1a67dd22010-01-14 21:04:31 +0000112 // Noop casts, including ptr <-> int, don't count.
Dan Gohmane4aeec02009-10-13 18:30:07 +0000113 if (CI->isLosslessCast() || isa<IntToPtrInst>(CI) ||
114 isa<PtrToIntInst>(CI))
115 continue;
Evan Cheng1a67dd22010-01-14 21:04:31 +0000116 // Result of a cmp instruction is often extended (to be used by other
117 // cmp instructions, logical or return instructions). These are usually
118 // nop on most sane targets.
119 if (isa<CmpInst>(CI->getOperand(0)))
120 continue;
Chris Lattnerb93a23a2009-11-01 03:07:53 +0000121 } else if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(II)){
Dan Gohmane4aeec02009-10-13 18:30:07 +0000122 // If a GEP has all constant indices, it will probably be folded with
123 // a load/store.
124 if (GEPI->hasAllConstantIndices())
125 continue;
126 }
127
Dan Gohmane4aeec02009-10-13 18:30:07 +0000128 ++NumInsts;
129 }
Chris Lattnerb93a23a2009-11-01 03:07:53 +0000130
131 if (isa<ReturnInst>(BB->getTerminator()))
132 ++NumRets;
133
Chris Lattner66588702009-11-01 18:16:30 +0000134 // We never want to inline functions that contain an indirectbr. This is
Duncan Sandsb0469642009-11-01 19:12:43 +0000135 // incorrect because all the blockaddress's (in static global initializers
136 // for example) would be referring to the original function, and this indirect
Chris Lattner66588702009-11-01 18:16:30 +0000137 // jump would jump from the inlined copy of the function into the original
138 // function which is extremely undefined behavior.
Chris Lattnerb93a23a2009-11-01 03:07:53 +0000139 if (isa<IndirectBrInst>(BB->getTerminator()))
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000140 containsIndirectBr = true;
Devang Patelcbd05602010-03-13 00:10:20 +0000141
142 // Remember NumInsts for this BB.
Devang Patelafc33fa2010-03-13 01:05:02 +0000143 NumBBInsts[BB] = NumInsts - NumInstsBeforeThisBB;
Dan Gohmane4aeec02009-10-13 18:30:07 +0000144}
145
Owen Anderson082bf2a2010-09-09 16:56:42 +0000146// CountCodeReductionForConstant - Figure out an approximation for how many
147// instructions will be constant folded if the specified value is constant.
148//
149unsigned CodeMetrics::CountCodeReductionForConstant(Value *V) {
150 unsigned Reduction = 0;
151 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
152 User *U = *UI;
153 if (isa<BranchInst>(U) || isa<SwitchInst>(U)) {
154 // We will be able to eliminate all but one of the successors.
155 const TerminatorInst &TI = cast<TerminatorInst>(*U);
156 const unsigned NumSucc = TI.getNumSuccessors();
157 unsigned Instrs = 0;
158 for (unsigned I = 0; I != NumSucc; ++I)
159 Instrs += NumBBInsts[TI.getSuccessor(I)];
160 // We don't know which blocks will be eliminated, so use the average size.
161 Reduction += InlineConstants::InstrCost*Instrs*(NumSucc-1)/NumSucc;
Owen Anderson082bf2a2010-09-09 16:56:42 +0000162 } else {
163 // Figure out if this instruction will be removed due to simple constant
164 // propagation.
165 Instruction &Inst = cast<Instruction>(*U);
166
167 // We can't constant propagate instructions which have effects or
168 // read memory.
169 //
170 // FIXME: It would be nice to capture the fact that a load from a
171 // pointer-to-constant-global is actually a *really* good thing to zap.
172 // Unfortunately, we don't know the pointer that may get propagated here,
173 // so we can't make this decision.
174 if (Inst.mayReadFromMemory() || Inst.mayHaveSideEffects() ||
175 isa<AllocaInst>(Inst))
176 continue;
177
178 bool AllOperandsConstant = true;
179 for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i)
180 if (!isa<Constant>(Inst.getOperand(i)) && Inst.getOperand(i) != V) {
181 AllOperandsConstant = false;
182 break;
183 }
184
185 if (AllOperandsConstant) {
186 // We will get to remove this instruction...
187 Reduction += InlineConstants::InstrCost;
188
189 // And any other instructions that use it which become constants
190 // themselves.
191 Reduction += CountCodeReductionForConstant(&Inst);
192 }
193 }
194 }
195 return Reduction;
196}
197
198// CountCodeReductionForAlloca - Figure out an approximation of how much smaller
199// the function will be if it is inlined into a context where an argument
200// becomes an alloca.
201//
202unsigned CodeMetrics::CountCodeReductionForAlloca(Value *V) {
203 if (!V->getType()->isPointerTy()) return 0; // Not a pointer
204 unsigned Reduction = 0;
205 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
206 Instruction *I = cast<Instruction>(*UI);
207 if (isa<LoadInst>(I) || isa<StoreInst>(I))
208 Reduction += InlineConstants::InstrCost;
209 else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(I)) {
210 // If the GEP has variable indices, we won't be able to do much with it.
211 if (GEP->hasAllConstantIndices())
212 Reduction += CountCodeReductionForAlloca(GEP);
213 } else if (BitCastInst *BCI = dyn_cast<BitCastInst>(I)) {
214 // Track pointer through bitcasts.
215 Reduction += CountCodeReductionForAlloca(BCI);
216 } else {
217 // If there is some other strange instruction, we're not going to be able
218 // to do much if we inline this.
219 return 0;
220 }
221 }
222
223 return Reduction;
224}
225
Dan Gohmane4aeec02009-10-13 18:30:07 +0000226/// analyzeFunction - Fill in the current structure with information gleaned
227/// from the specified function.
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000228void CodeMetrics::analyzeFunction(Function *F) {
229 // Look at the size of the callee.
Dan Gohmane4aeec02009-10-13 18:30:07 +0000230 for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
231 analyzeBasicBlock(&*BB);
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000232}
233
234/// analyzeFunction - Fill in the current structure with information gleaned
235/// from the specified function.
236void InlineCostAnalyzer::FunctionInfo::analyzeFunction(Function *F) {
237 Metrics.analyzeFunction(F);
Dan Gohmane4aeec02009-10-13 18:30:07 +0000238
239 // A function with exactly one return has it removed during the inlining
240 // process (see InlineFunction), so don't count it.
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000241 // FIXME: This knowledge should really be encoded outside of FunctionInfo.
242 if (Metrics.NumRets==1)
243 --Metrics.NumInsts;
Dan Gohmane4aeec02009-10-13 18:30:07 +0000244
Jakob Stoklund Olesene3039b62010-01-26 21:31:24 +0000245 // Don't bother calculating argument weights if we are never going to inline
246 // the function anyway.
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000247 if (NeverInline())
Jakob Stoklund Olesene3039b62010-01-26 21:31:24 +0000248 return;
249
Dan Gohmane4aeec02009-10-13 18:30:07 +0000250 // Check out all of the arguments to the function, figuring out how much
251 // code can be eliminated if one of the arguments is a constant.
Jakob Stoklund Olesene3039b62010-01-26 21:31:24 +0000252 ArgumentWeights.reserve(F->arg_size());
Dan Gohmane4aeec02009-10-13 18:30:07 +0000253 for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
Owen Anderson082bf2a2010-09-09 16:56:42 +0000254 ArgumentWeights.push_back(ArgInfo(Metrics.CountCodeReductionForConstant(I),
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000255 Metrics.CountCodeReductionForAlloca(I)));
Dan Gohmane4aeec02009-10-13 18:30:07 +0000256}
257
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000258/// NeverInline - returns true if the function should never be inlined into
259/// any caller
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000260bool InlineCostAnalyzer::FunctionInfo::NeverInline() {
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000261 return (Metrics.callsSetJmp || Metrics.isRecursive ||
262 Metrics.containsIndirectBr);
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000263}
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000264// getSpecializationBonus - The heuristic used to determine the per-call
265// performance boost for using a specialization of Callee with argument
266// specializedArgNo replaced by a constant.
267int InlineCostAnalyzer::getSpecializationBonus(Function *Callee,
268 SmallVectorImpl<unsigned> &SpecializedArgNos)
269{
270 if (Callee->mayBeOverridden())
271 return 0;
272
273 int Bonus = 0;
274 // If this function uses the coldcc calling convention, prefer not to
275 // specialize it.
276 if (Callee->getCallingConv() == CallingConv::Cold)
277 Bonus -= InlineConstants::ColdccPenalty;
278
279 // Get information about the callee.
280 FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
281
282 // If we haven't calculated this information yet, do so now.
283 if (CalleeFI->Metrics.NumBlocks == 0)
284 CalleeFI->analyzeFunction(Callee);
285
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000286 unsigned ArgNo = 0;
287 unsigned i = 0;
288 for (Function::arg_iterator I = Callee->arg_begin(), E = Callee->arg_end();
289 I != E; ++I, ++ArgNo)
290 if (ArgNo == SpecializedArgNos[i]) {
291 ++i;
292 Bonus += CountBonusForConstant(I);
293 }
Eric Christopher7d3a16f2011-01-26 01:09:59 +0000294
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000295 // Calls usually take a long time, so they make the specialization gain
296 // smaller.
297 Bonus -= CalleeFI->Metrics.NumCalls * InlineConstants::CallPenalty;
298
299 return Bonus;
300}
301
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000302// ConstantFunctionBonus - Figure out how much of a bonus we can get for
303// possibly devirtualizing a function. We'll subtract the size of the function
304// we may wish to inline from the indirect call bonus providing a limit on
305// growth. Leave an upper limit of 0 for the bonus - we don't want to penalize
306// inlining because we decide we don't want to give a bonus for
307// devirtualizing.
308int InlineCostAnalyzer::ConstantFunctionBonus(CallSite CS, Constant *C) {
309
310 // This could just be NULL.
311 if (!C) return 0;
312
313 Function *F = dyn_cast<Function>(C);
314 if (!F) return 0;
315
316 int Bonus = InlineConstants::IndirectCallBonus + getInlineSize(CS, F);
317 return (Bonus > 0) ? 0 : Bonus;
318}
319
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000320// CountBonusForConstant - Figure out an approximation for how much per-call
321// performance boost we can expect if the specified value is constant.
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000322int InlineCostAnalyzer::CountBonusForConstant(Value *V, Constant *C) {
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000323 unsigned Bonus = 0;
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000324 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
325 User *U = *UI;
326 if (CallInst *CI = dyn_cast<CallInst>(U)) {
327 // Turning an indirect call into a direct call is a BIG win
328 if (CI->getCalledValue() == V)
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000329 Bonus += ConstantFunctionBonus(CallSite(CI), C);
330 } else if (InvokeInst *II = dyn_cast<InvokeInst>(U)) {
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000331 // Turning an indirect call into a direct call is a BIG win
332 if (II->getCalledValue() == V)
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000333 Bonus += ConstantFunctionBonus(CallSite(CI), C);
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000334 }
335 // FIXME: Eliminating conditional branches and switches should
336 // also yield a per-call performance boost.
337 else {
338 // Figure out the bonuses that wll accrue due to simple constant
339 // propagation.
340 Instruction &Inst = cast<Instruction>(*U);
341
342 // We can't constant propagate instructions which have effects or
343 // read memory.
344 //
345 // FIXME: It would be nice to capture the fact that a load from a
346 // pointer-to-constant-global is actually a *really* good thing to zap.
347 // Unfortunately, we don't know the pointer that may get propagated here,
348 // so we can't make this decision.
349 if (Inst.mayReadFromMemory() || Inst.mayHaveSideEffects() ||
350 isa<AllocaInst>(Inst))
351 continue;
352
353 bool AllOperandsConstant = true;
354 for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i)
355 if (!isa<Constant>(Inst.getOperand(i)) && Inst.getOperand(i) != V) {
356 AllOperandsConstant = false;
357 break;
358 }
359
360 if (AllOperandsConstant)
361 Bonus += CountBonusForConstant(&Inst);
362 }
363 }
364
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000365 return Bonus;
366}
367
368int InlineCostAnalyzer::getInlineSize(CallSite CS, Function *Callee) {
369 // Get information about the callee.
370 FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000371
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000372 // If we haven't calculated this information yet, do so now.
373 if (CalleeFI->Metrics.NumBlocks == 0)
374 CalleeFI->analyzeFunction(Callee);
375
376 // InlineCost - This value measures how good of an inline candidate this call
377 // site is to inline. A lower inline cost make is more likely for the call to
378 // be inlined. This value may go negative.
379 //
380 int InlineCost = 0;
381
382 // Compute any size reductions we can expect due to arguments being passed into
383 // the function.
384 //
385 unsigned ArgNo = 0;
386 CallSite::arg_iterator I = CS.arg_begin();
387 for (Function::arg_iterator FI = Callee->arg_begin(), FE = Callee->arg_end();
388 FI != FE; ++I, ++FI, ++ArgNo) {
389
390 // If an alloca is passed in, inlining this function is likely to allow
391 // significant future optimization possibilities (like scalar promotion, and
392 // scalarization), so encourage the inlining of the function.
393 //
394 if (isa<AllocaInst>(I))
395 InlineCost -= CalleeFI->ArgumentWeights[ArgNo].AllocaWeight;
396
397 // If this is a constant being passed into the function, use the argument
398 // weights calculated for the callee to determine how much will be folded
399 // away with this information.
400 else if (isa<Constant>(I))
401 InlineCost -= CalleeFI->ArgumentWeights[ArgNo].ConstantWeight;
402 }
403
404 // Each argument passed in has a cost at both the caller and the callee
405 // sides. Measurements show that each argument costs about the same as an
406 // instruction.
407 InlineCost -= (CS.arg_size() * InlineConstants::InstrCost);
408
409 // Now that we have considered all of the factors that make the call site more
410 // likely to be inlined, look at factors that make us not want to inline it.
411
412 // Calls usually take a long time, so they make the inlining gain smaller.
413 InlineCost += CalleeFI->Metrics.NumCalls * InlineConstants::CallPenalty;
414
415 // Look at the size of the callee. Each instruction counts as 5.
416 InlineCost += CalleeFI->Metrics.NumInsts*InlineConstants::InstrCost;
417
418 return InlineCost;
419}
420
421int InlineCostAnalyzer::getInlineBonuses(CallSite CS, Function *Callee) {
422 // Get information about the callee.
423 FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
424
425 // If we haven't calculated this information yet, do so now.
426 if (CalleeFI->Metrics.NumBlocks == 0)
427 CalleeFI->analyzeFunction(Callee);
428
429 bool isDirectCall = CS.getCalledFunction() == Callee;
430 Instruction *TheCall = CS.getInstruction();
431 int Bonus = 0;
432
433 // If there is only one call of the function, and it has internal linkage,
434 // make it almost guaranteed to be inlined.
435 //
436 if (Callee->hasLocalLinkage() && Callee->hasOneUse() && isDirectCall)
437 Bonus += InlineConstants::LastCallToStaticBonus;
438
439 // If the instruction after the call, or if the normal destination of the
440 // invoke is an unreachable instruction, the function is noreturn. As such,
441 // there is little point in inlining this.
442 if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall)) {
443 if (isa<UnreachableInst>(II->getNormalDest()->begin()))
444 Bonus += InlineConstants::NoreturnPenalty;
445 } else if (isa<UnreachableInst>(++BasicBlock::iterator(TheCall)))
446 Bonus += InlineConstants::NoreturnPenalty;
447
448 // If this function uses the coldcc calling convention, prefer not to inline
449 // it.
450 if (Callee->getCallingConv() == CallingConv::Cold)
451 Bonus += InlineConstants::ColdccPenalty;
452
453 // Add to the inline quality for properties that make the call valuable to
454 // inline. This includes factors that indicate that the result of inlining
455 // the function will be optimizable. Currently this just looks at arguments
456 // passed into the function.
457 //
458 CallSite::arg_iterator I = CS.arg_begin();
459 for (Function::arg_iterator FI = Callee->arg_begin(), FE = Callee->arg_end();
460 FI != FE; ++I, ++FI)
461 // Compute any constant bonus due to inlining we want to give here.
462 if (isa<Constant>(I))
463 Bonus += CountBonusForConstant(FI, cast<Constant>(I));
464
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000465 return Bonus;
466}
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000467
Dan Gohmane4aeec02009-10-13 18:30:07 +0000468// getInlineCost - The heuristic used to determine if we should inline the
469// function call or not.
470//
471InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
Chris Lattner44b04a52010-04-17 17:55:00 +0000472 SmallPtrSet<const Function*, 16> &NeverInline) {
David Chisnall752e2592010-05-01 15:47:41 +0000473 return getInlineCost(CS, CS.getCalledFunction(), NeverInline);
474}
475
476InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
477 Function *Callee,
478 SmallPtrSet<const Function*, 16> &NeverInline) {
Dan Gohmane4aeec02009-10-13 18:30:07 +0000479 Instruction *TheCall = CS.getInstruction();
Dan Gohmane4aeec02009-10-13 18:30:07 +0000480 Function *Caller = TheCall->getParent()->getParent();
481
482 // Don't inline functions which can be redefined at link-time to mean
Eric Christopherf27e6082010-03-25 04:49:10 +0000483 // something else. Don't inline functions marked noinline or call sites
484 // marked noinline.
Dan Gohmane4aeec02009-10-13 18:30:07 +0000485 if (Callee->mayBeOverridden() ||
Eric Christopherf27e6082010-03-25 04:49:10 +0000486 Callee->hasFnAttr(Attribute::NoInline) || NeverInline.count(Callee) ||
487 CS.isNoInline())
Dan Gohmane4aeec02009-10-13 18:30:07 +0000488 return llvm::InlineCost::getNever();
489
Chris Lattner44b04a52010-04-17 17:55:00 +0000490 // Get information about the callee.
491 FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
Dan Gohmane4aeec02009-10-13 18:30:07 +0000492
493 // If we haven't calculated this information yet, do so now.
Chris Lattner44b04a52010-04-17 17:55:00 +0000494 if (CalleeFI->Metrics.NumBlocks == 0)
495 CalleeFI->analyzeFunction(Callee);
Dan Gohmane4aeec02009-10-13 18:30:07 +0000496
497 // If we should never inline this, return a huge cost.
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000498 if (CalleeFI->NeverInline())
Dan Gohmane4aeec02009-10-13 18:30:07 +0000499 return InlineCost::getNever();
500
Chris Lattner44b04a52010-04-17 17:55:00 +0000501 // FIXME: It would be nice to kill off CalleeFI->NeverInline. Then we
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000502 // could move this up and avoid computing the FunctionInfo for
Dan Gohmane4aeec02009-10-13 18:30:07 +0000503 // things we are going to just return always inline for. This
504 // requires handling setjmp somewhere else, however.
505 if (!Callee->isDeclaration() && Callee->hasFnAttr(Attribute::AlwaysInline))
506 return InlineCost::getAlways();
507
Chris Lattner44b04a52010-04-17 17:55:00 +0000508 if (CalleeFI->Metrics.usesDynamicAlloca) {
509 // Get infomation about the caller.
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000510 FunctionInfo &CallerFI = CachedFunctionInfo[Caller];
Dan Gohmane4aeec02009-10-13 18:30:07 +0000511
512 // If we haven't calculated this information yet, do so now.
Chris Lattnerf84755b2010-04-17 17:57:56 +0000513 if (CallerFI.Metrics.NumBlocks == 0) {
Dan Gohmane4aeec02009-10-13 18:30:07 +0000514 CallerFI.analyzeFunction(Caller);
Chris Lattnerf84755b2010-04-17 17:57:56 +0000515
516 // Recompute the CalleeFI pointer, getting Caller could have invalidated
517 // it.
518 CalleeFI = &CachedFunctionInfo[Callee];
519 }
Dan Gohmane4aeec02009-10-13 18:30:07 +0000520
521 // Don't inline a callee with dynamic alloca into a caller without them.
522 // Functions containing dynamic alloca's are inefficient in various ways;
523 // don't create more inefficiency.
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000524 if (!CallerFI.Metrics.usesDynamicAlloca)
Dan Gohmane4aeec02009-10-13 18:30:07 +0000525 return InlineCost::getNever();
526 }
527
Eric Christopher1bcb4282011-01-25 01:34:31 +0000528 // InlineCost - This value measures how good of an inline candidate this call
529 // site is to inline. A lower inline cost make is more likely for the call to
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000530 // be inlined. This value may go negative due to the fact that bonuses
531 // are negative numbers.
Eric Christopher1bcb4282011-01-25 01:34:31 +0000532 //
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000533 int InlineCost = getInlineSize(CS, Callee) + getInlineBonuses(CS, Callee);
Dan Gohmane4aeec02009-10-13 18:30:07 +0000534 return llvm::InlineCost::get(InlineCost);
535}
536
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000537// getSpecializationCost - The heuristic used to determine the code-size
538// impact of creating a specialized version of Callee with argument
539// SpecializedArgNo replaced by a constant.
540InlineCost InlineCostAnalyzer::getSpecializationCost(Function *Callee,
541 SmallVectorImpl<unsigned> &SpecializedArgNos)
542{
543 // Don't specialize functions which can be redefined at link-time to mean
544 // something else.
545 if (Callee->mayBeOverridden())
546 return llvm::InlineCost::getNever();
547
548 // Get information about the callee.
549 FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
550
551 // If we haven't calculated this information yet, do so now.
552 if (CalleeFI->Metrics.NumBlocks == 0)
553 CalleeFI->analyzeFunction(Callee);
554
555 int Cost = 0;
556
557 // Look at the orginal size of the callee. Each instruction counts as 5.
558 Cost += CalleeFI->Metrics.NumInsts * InlineConstants::InstrCost;
559
560 // Offset that with the amount of code that can be constant-folded
561 // away with the given arguments replaced by constants.
562 for (SmallVectorImpl<unsigned>::iterator an = SpecializedArgNos.begin(),
563 ae = SpecializedArgNos.end(); an != ae; ++an)
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000564 Cost -= CalleeFI->ArgumentWeights[*an].ConstantWeight;
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000565
566 return llvm::InlineCost::get(Cost);
567}
568
Dan Gohmane4aeec02009-10-13 18:30:07 +0000569// getInlineFudgeFactor - Return a > 1.0 factor if the inliner should use a
570// higher threshold to determine if the function call should be inlined.
571float InlineCostAnalyzer::getInlineFudgeFactor(CallSite CS) {
572 Function *Callee = CS.getCalledFunction();
573
Chris Lattner44b04a52010-04-17 17:55:00 +0000574 // Get information about the callee.
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000575 FunctionInfo &CalleeFI = CachedFunctionInfo[Callee];
Dan Gohmane4aeec02009-10-13 18:30:07 +0000576
577 // If we haven't calculated this information yet, do so now.
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000578 if (CalleeFI.Metrics.NumBlocks == 0)
Dan Gohmane4aeec02009-10-13 18:30:07 +0000579 CalleeFI.analyzeFunction(Callee);
580
581 float Factor = 1.0f;
582 // Single BB functions are often written to be inlined.
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000583 if (CalleeFI.Metrics.NumBlocks == 1)
Dan Gohmane4aeec02009-10-13 18:30:07 +0000584 Factor += 0.5f;
585
586 // Be more aggressive if the function contains a good chunk (if it mades up
587 // at least 10% of the instructions) of vector instructions.
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000588 if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/2)
Dan Gohmane4aeec02009-10-13 18:30:07 +0000589 Factor += 2.0f;
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000590 else if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/10)
Dan Gohmane4aeec02009-10-13 18:30:07 +0000591 Factor += 1.5f;
592 return Factor;
593}
Jakob Stoklund Olesenf7477472010-03-09 23:02:17 +0000594
595/// growCachedCostInfo - update the cached cost info for Caller after Callee has
596/// been inlined.
597void
Chris Lattner44b04a52010-04-17 17:55:00 +0000598InlineCostAnalyzer::growCachedCostInfo(Function *Caller, Function *Callee) {
599 CodeMetrics &CallerMetrics = CachedFunctionInfo[Caller].Metrics;
Jakob Stoklund Olesenf7477472010-03-09 23:02:17 +0000600
601 // For small functions we prefer to recalculate the cost for better accuracy.
Chris Lattner44b04a52010-04-17 17:55:00 +0000602 if (CallerMetrics.NumBlocks < 10 || CallerMetrics.NumInsts < 1000) {
Jakob Stoklund Olesenf7477472010-03-09 23:02:17 +0000603 resetCachedCostInfo(Caller);
604 return;
605 }
606
607 // For large functions, we can save a lot of computation time by skipping
608 // recalculations.
Chris Lattner44b04a52010-04-17 17:55:00 +0000609 if (CallerMetrics.NumCalls > 0)
610 --CallerMetrics.NumCalls;
Jakob Stoklund Olesenf7477472010-03-09 23:02:17 +0000611
Chris Lattner44b04a52010-04-17 17:55:00 +0000612 if (Callee == 0) return;
613
614 CodeMetrics &CalleeMetrics = CachedFunctionInfo[Callee].Metrics;
Jakob Stoklund Olesenf7477472010-03-09 23:02:17 +0000615
Chris Lattner44b04a52010-04-17 17:55:00 +0000616 // If we don't have metrics for the callee, don't recalculate them just to
617 // update an approximation in the caller. Instead, just recalculate the
618 // caller info from scratch.
619 if (CalleeMetrics.NumBlocks == 0) {
620 resetCachedCostInfo(Caller);
621 return;
Jakob Stoklund Olesenf7477472010-03-09 23:02:17 +0000622 }
Chris Lattner44b04a52010-04-17 17:55:00 +0000623
Chris Lattnerf84755b2010-04-17 17:57:56 +0000624 // Since CalleeMetrics were already calculated, we know that the CallerMetrics
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000625 // reference isn't invalidated: both were in the DenseMap.
Chris Lattner44b04a52010-04-17 17:55:00 +0000626 CallerMetrics.usesDynamicAlloca |= CalleeMetrics.usesDynamicAlloca;
627
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000628 // FIXME: If any of these three are true for the callee, the callee was
629 // not inlined into the caller, so I think they're redundant here.
630 CallerMetrics.callsSetJmp |= CalleeMetrics.callsSetJmp;
631 CallerMetrics.isRecursive |= CalleeMetrics.isRecursive;
632 CallerMetrics.containsIndirectBr |= CalleeMetrics.containsIndirectBr;
633
Chris Lattner44b04a52010-04-17 17:55:00 +0000634 CallerMetrics.NumInsts += CalleeMetrics.NumInsts;
635 CallerMetrics.NumBlocks += CalleeMetrics.NumBlocks;
636 CallerMetrics.NumCalls += CalleeMetrics.NumCalls;
637 CallerMetrics.NumVectorInsts += CalleeMetrics.NumVectorInsts;
638 CallerMetrics.NumRets += CalleeMetrics.NumRets;
639
640 // analyzeBasicBlock counts each function argument as an inst.
641 if (CallerMetrics.NumInsts >= Callee->arg_size())
642 CallerMetrics.NumInsts -= Callee->arg_size();
643 else
644 CallerMetrics.NumInsts = 0;
645
Nick Lewycky9a1581b2010-05-12 21:48:15 +0000646 // We are not updating the argument weights. We have already determined that
Jakob Stoklund Olesenf7477472010-03-09 23:02:17 +0000647 // Caller is a fairly large function, so we accept the loss of precision.
648}
Nick Lewycky9a1581b2010-05-12 21:48:15 +0000649
650/// clear - empty the cache of inline costs
651void InlineCostAnalyzer::clear() {
652 CachedFunctionInfo.clear();
653}