blob: 7f0b0cc3bf1bb32e661c4b1646498e7b7abdb4e7 [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"
Andrew Trickb2ab2fa2011-10-01 01:39:05 +000018#include "llvm/Target/TargetData.h"
Dan Gohmane4aeec02009-10-13 18:30:07 +000019#include "llvm/ADT/SmallPtrSet.h"
Eric Christopher4e8af6d2011-02-05 00:49:15 +000020
Dan Gohmane4aeec02009-10-13 18:30:07 +000021using namespace llvm;
22
Dan Gohman52d55bd2010-04-16 15:14:50 +000023/// 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?
26bool llvm::callIsSmall(const Function *F) {
Eric Christopher745d8c92010-01-14 21:48:00 +000027 if (!F) return false;
Andrew Trick5c655412011-10-01 01:27:56 +000028
Eric Christopher745d8c92010-01-14 21:48:00 +000029 if (F->hasLocalLinkage()) return false;
Andrew Trick5c655412011-10-01 01:27:56 +000030
Eric Christopher83c20d32010-01-14 23:00:10 +000031 if (!F->hasName()) return false;
Andrew Trick5c655412011-10-01 01:27:56 +000032
Eric Christopher83c20d32010-01-14 23:00:10 +000033 StringRef Name = F->getName();
Andrew Trick5c655412011-10-01 01:27:56 +000034
Eric Christopher83c20d32010-01-14 23:00:10 +000035 // These will all likely lower to a single selection DAG node.
Duncan Sands87cd7ed2010-03-15 14:01:44 +000036 if (Name == "copysign" || Name == "copysignf" || Name == "copysignl" ||
Eric Christopher83c20d32010-01-14 23:00:10 +000037 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;
Andrew Trick5c655412011-10-01 01:27:56 +000042
Eric Christopher83c20d32010-01-14 23:00:10 +000043 // 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;
Andrew Trick5c655412011-10-01 01:27:56 +000050
Eric Christopher2d59ae62010-01-14 20:12:34 +000051 return false;
52}
53
Dan Gohmane4aeec02009-10-13 18:30:07 +000054/// analyzeBasicBlock - Fill in the current structure with information gleaned
55/// from the specified block.
Andrew Trickb2ab2fa2011-10-01 01:39:05 +000056void CodeMetrics::analyzeBasicBlock(const BasicBlock *BB,
57 const TargetData *TD) {
Dan Gohmane4aeec02009-10-13 18:30:07 +000058 ++NumBlocks;
Devang Patelafc33fa2010-03-13 01:05:02 +000059 unsigned NumInstsBeforeThisBB = NumInsts;
Dan Gohmane4aeec02009-10-13 18:30:07 +000060 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 (isa<DbgInfoIntrinsic>(II))
67 continue; // Debug intrinsics don't count as size.
Gabor Greif0de11e02010-07-27 14:15:29 +000068
69 ImmutableCallSite CS(cast<Instruction>(II));
70
Gabor Greif0de11e02010-07-27 14:15:29 +000071 if (const Function *F = CS.getCalledFunction()) {
Andrew Trick5c655412011-10-01 01:27:56 +000072 // If a function is both internal and has a single use, then it is
73 // extremely likely to get inlined in the future (it was probably
Owen Andersonf9a26b82010-09-09 20:32:23 +000074 // exposed by an interleaved devirtualization pass).
75 if (F->hasInternalLinkage() && F->hasOneUse())
76 ++NumInlineCandidates;
Rafael Espindolaac53b0a2011-05-16 15:48:45 +000077
Chris Lattner4b7b42c2010-04-30 22:37:22 +000078 // If this call is to function itself, then the function is recursive.
79 // Inlining it into other functions is a bad idea, because this is
80 // basically just a form of loop peeling, and our metrics aren't useful
81 // for that case.
82 if (F == BB->getParent())
Kenneth Uildriks42c7d232010-06-09 15:11:37 +000083 isRecursive = true;
Chris Lattner4b7b42c2010-04-30 22:37:22 +000084 }
Dan Gohmane4aeec02009-10-13 18:30:07 +000085
Jakob Stoklund Olesenaa034fa2010-02-05 23:21:18 +000086 if (!isa<IntrinsicInst>(II) && !callIsSmall(CS.getCalledFunction())) {
87 // Each argument to a call takes on average one instruction to set up.
88 NumInsts += CS.arg_size();
Jakob Stoklund Olesen8b3ca842010-05-26 22:40:28 +000089
90 // We don't want inline asm to count as a call - that would prevent loop
91 // unrolling. The argument setup cost is still real, though.
92 if (!isa<InlineAsm>(CS.getCalledValue()))
93 ++NumCalls;
Jakob Stoklund Olesenaa034fa2010-02-05 23:21:18 +000094 }
Dan Gohmane4aeec02009-10-13 18:30:07 +000095 }
Andrew Trick5c655412011-10-01 01:27:56 +000096
Dan Gohmane4aeec02009-10-13 18:30:07 +000097 if (const AllocaInst *AI = dyn_cast<AllocaInst>(II)) {
98 if (!AI->isStaticAlloca())
99 this->usesDynamicAlloca = true;
100 }
101
Duncan Sands1df98592010-02-16 11:11:14 +0000102 if (isa<ExtractElementInst>(II) || II->getType()->isVectorTy())
Andrew Trick5c655412011-10-01 01:27:56 +0000103 ++NumVectorInsts;
104
Dan Gohmane4aeec02009-10-13 18:30:07 +0000105 if (const CastInst *CI = dyn_cast<CastInst>(II)) {
Evan Cheng1a67dd22010-01-14 21:04:31 +0000106 // Noop casts, including ptr <-> int, don't count.
Andrew Trick5c655412011-10-01 01:27:56 +0000107 if (CI->isLosslessCast() || isa<IntToPtrInst>(CI) ||
Dan Gohmane4aeec02009-10-13 18:30:07 +0000108 isa<PtrToIntInst>(CI))
109 continue;
Andrew Trickb2ab2fa2011-10-01 01:39:05 +0000110 // trunc to a native type is free (assuming the target has compare and
111 // shift-right of the same width).
112 if (isa<TruncInst>(CI) && TD &&
113 TD->isLegalInteger(TD->getTypeSizeInBits(CI->getType())))
114 continue;
Evan Cheng1a67dd22010-01-14 21:04:31 +0000115 // 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)))
119 continue;
Chris Lattnerb93a23a2009-11-01 03:07:53 +0000120 } else if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(II)){
Dan Gohmane4aeec02009-10-13 18:30:07 +0000121 // If a GEP has all constant indices, it will probably be folded with
122 // a load/store.
123 if (GEPI->hasAllConstantIndices())
124 continue;
125 }
126
Dan Gohmane4aeec02009-10-13 18:30:07 +0000127 ++NumInsts;
128 }
Andrew Trick5c655412011-10-01 01:27:56 +0000129
Chris Lattnerb93a23a2009-11-01 03:07:53 +0000130 if (isa<ReturnInst>(BB->getTerminator()))
131 ++NumRets;
Andrew Trick5c655412011-10-01 01:27:56 +0000132
Chris Lattner66588702009-11-01 18:16:30 +0000133 // We never want to inline functions that contain an indirectbr. This is
Duncan Sandsb0469642009-11-01 19:12:43 +0000134 // incorrect because all the blockaddress's (in static global initializers
135 // for example) would be referring to the original function, and this indirect
Chris Lattner66588702009-11-01 18:16:30 +0000136 // jump would jump from the inlined copy of the function into the original
137 // function which is extremely undefined behavior.
Eli Friedman531afb12011-10-20 04:05:33 +0000138 // FIXME: This logic isn't really right; we can safely inline functions
139 // with indirectbr's as long as no other function or global references the
140 // blockaddress of a block within the current function. And as a QOI issue,
141 // if someone is using a blockaddress wihtout an indirectbr, and that
142 // reference somehow ends up in another function or global, we probably
143 // don't want to inline this function.
Chris Lattnerb93a23a2009-11-01 03:07:53 +0000144 if (isa<IndirectBrInst>(BB->getTerminator()))
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000145 containsIndirectBr = true;
Devang Patelcbd05602010-03-13 00:10:20 +0000146
147 // Remember NumInsts for this BB.
Devang Patelafc33fa2010-03-13 01:05:02 +0000148 NumBBInsts[BB] = NumInsts - NumInstsBeforeThisBB;
Dan Gohmane4aeec02009-10-13 18:30:07 +0000149}
150
Owen Anderson082bf2a2010-09-09 16:56:42 +0000151// CountCodeReductionForConstant - Figure out an approximation for how many
152// instructions will be constant folded if the specified value is constant.
153//
154unsigned CodeMetrics::CountCodeReductionForConstant(Value *V) {
155 unsigned Reduction = 0;
156 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
157 User *U = *UI;
158 if (isa<BranchInst>(U) || isa<SwitchInst>(U)) {
159 // We will be able to eliminate all but one of the successors.
160 const TerminatorInst &TI = cast<TerminatorInst>(*U);
161 const unsigned NumSucc = TI.getNumSuccessors();
162 unsigned Instrs = 0;
163 for (unsigned I = 0; I != NumSucc; ++I)
164 Instrs += NumBBInsts[TI.getSuccessor(I)];
165 // We don't know which blocks will be eliminated, so use the average size.
166 Reduction += InlineConstants::InstrCost*Instrs*(NumSucc-1)/NumSucc;
Owen Anderson082bf2a2010-09-09 16:56:42 +0000167 } else {
168 // Figure out if this instruction will be removed due to simple constant
169 // propagation.
170 Instruction &Inst = cast<Instruction>(*U);
171
172 // We can't constant propagate instructions which have effects or
173 // read memory.
174 //
175 // FIXME: It would be nice to capture the fact that a load from a
176 // pointer-to-constant-global is actually a *really* good thing to zap.
177 // Unfortunately, we don't know the pointer that may get propagated here,
178 // so we can't make this decision.
179 if (Inst.mayReadFromMemory() || Inst.mayHaveSideEffects() ||
180 isa<AllocaInst>(Inst))
181 continue;
182
183 bool AllOperandsConstant = true;
184 for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i)
185 if (!isa<Constant>(Inst.getOperand(i)) && Inst.getOperand(i) != V) {
186 AllOperandsConstant = false;
187 break;
188 }
189
190 if (AllOperandsConstant) {
191 // We will get to remove this instruction...
192 Reduction += InlineConstants::InstrCost;
193
194 // And any other instructions that use it which become constants
195 // themselves.
196 Reduction += CountCodeReductionForConstant(&Inst);
197 }
198 }
199 }
200 return Reduction;
201}
202
203// CountCodeReductionForAlloca - Figure out an approximation of how much smaller
204// the function will be if it is inlined into a context where an argument
205// becomes an alloca.
206//
207unsigned CodeMetrics::CountCodeReductionForAlloca(Value *V) {
208 if (!V->getType()->isPointerTy()) return 0; // Not a pointer
209 unsigned Reduction = 0;
210 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
211 Instruction *I = cast<Instruction>(*UI);
212 if (isa<LoadInst>(I) || isa<StoreInst>(I))
213 Reduction += InlineConstants::InstrCost;
214 else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(I)) {
215 // If the GEP has variable indices, we won't be able to do much with it.
216 if (GEP->hasAllConstantIndices())
217 Reduction += CountCodeReductionForAlloca(GEP);
218 } else if (BitCastInst *BCI = dyn_cast<BitCastInst>(I)) {
219 // Track pointer through bitcasts.
220 Reduction += CountCodeReductionForAlloca(BCI);
221 } else {
222 // If there is some other strange instruction, we're not going to be able
223 // to do much if we inline this.
224 return 0;
225 }
226 }
227
228 return Reduction;
229}
230
Dan Gohmane4aeec02009-10-13 18:30:07 +0000231/// analyzeFunction - Fill in the current structure with information gleaned
232/// from the specified function.
Andrew Trickb2ab2fa2011-10-01 01:39:05 +0000233void CodeMetrics::analyzeFunction(Function *F, const TargetData *TD) {
Bill Wendling728662f2011-10-17 18:22:52 +0000234 // If this function contains a call that "returns twice" (e.g., setjmp or
Joerg Sonnenberger34706932011-12-18 20:35:43 +0000235 // _setjmp) and it isn't marked with "returns twice" itself, never inline it.
236 // This is a hack because we depend on the user marking their local variables
237 // as volatile if they are live across a setjmp call, and they probably
238 // won't do this in callers.
239 exposesReturnsTwice = F->callsFunctionThatReturnsTwice() &&
240 !F->hasFnAttr(Attribute::ReturnsTwice);
Rafael Espindolaac53b0a2011-05-16 15:48:45 +0000241
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000242 // Look at the size of the callee.
Dan Gohmane4aeec02009-10-13 18:30:07 +0000243 for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
Andrew Trickb2ab2fa2011-10-01 01:39:05 +0000244 analyzeBasicBlock(&*BB, TD);
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000245}
246
247/// analyzeFunction - Fill in the current structure with information gleaned
248/// from the specified function.
Andrew Trickb2ab2fa2011-10-01 01:39:05 +0000249void InlineCostAnalyzer::FunctionInfo::analyzeFunction(Function *F,
250 const TargetData *TD) {
251 Metrics.analyzeFunction(F, TD);
Dan Gohmane4aeec02009-10-13 18:30:07 +0000252
253 // A function with exactly one return has it removed during the inlining
254 // process (see InlineFunction), so don't count it.
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000255 // FIXME: This knowledge should really be encoded outside of FunctionInfo.
256 if (Metrics.NumRets==1)
257 --Metrics.NumInsts;
Dan Gohmane4aeec02009-10-13 18:30:07 +0000258
259 // Check out all of the arguments to the function, figuring out how much
260 // code can be eliminated if one of the arguments is a constant.
Jakob Stoklund Olesene3039b62010-01-26 21:31:24 +0000261 ArgumentWeights.reserve(F->arg_size());
Dan Gohmane4aeec02009-10-13 18:30:07 +0000262 for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
Owen Anderson082bf2a2010-09-09 16:56:42 +0000263 ArgumentWeights.push_back(ArgInfo(Metrics.CountCodeReductionForConstant(I),
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000264 Metrics.CountCodeReductionForAlloca(I)));
Dan Gohmane4aeec02009-10-13 18:30:07 +0000265}
266
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000267/// NeverInline - returns true if the function should never be inlined into
268/// any caller
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000269bool InlineCostAnalyzer::FunctionInfo::NeverInline() {
Joerg Sonnenberger34706932011-12-18 20:35:43 +0000270 return (Metrics.exposesReturnsTwice || Metrics.isRecursive ||
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000271 Metrics.containsIndirectBr);
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000272}
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000273// getSpecializationBonus - The heuristic used to determine the per-call
274// performance boost for using a specialization of Callee with argument
275// specializedArgNo replaced by a constant.
276int InlineCostAnalyzer::getSpecializationBonus(Function *Callee,
277 SmallVectorImpl<unsigned> &SpecializedArgNos)
278{
279 if (Callee->mayBeOverridden())
280 return 0;
Andrew Trick5c655412011-10-01 01:27:56 +0000281
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000282 int Bonus = 0;
283 // If this function uses the coldcc calling convention, prefer not to
284 // specialize it.
285 if (Callee->getCallingConv() == CallingConv::Cold)
286 Bonus -= InlineConstants::ColdccPenalty;
Andrew Trick5c655412011-10-01 01:27:56 +0000287
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000288 // Get information about the callee.
289 FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
Andrew Trick5c655412011-10-01 01:27:56 +0000290
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000291 // If we haven't calculated this information yet, do so now.
292 if (CalleeFI->Metrics.NumBlocks == 0)
Andrew Trickb2ab2fa2011-10-01 01:39:05 +0000293 CalleeFI->analyzeFunction(Callee, TD);
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000294
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000295 unsigned ArgNo = 0;
296 unsigned i = 0;
297 for (Function::arg_iterator I = Callee->arg_begin(), E = Callee->arg_end();
298 I != E; ++I, ++ArgNo)
299 if (ArgNo == SpecializedArgNos[i]) {
300 ++i;
301 Bonus += CountBonusForConstant(I);
302 }
Eric Christopher7d3a16f2011-01-26 01:09:59 +0000303
Andrew Trick5c655412011-10-01 01:27:56 +0000304 // Calls usually take a long time, so they make the specialization gain
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000305 // smaller.
306 Bonus -= CalleeFI->Metrics.NumCalls * InlineConstants::CallPenalty;
307
308 return Bonus;
309}
310
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000311// ConstantFunctionBonus - Figure out how much of a bonus we can get for
312// possibly devirtualizing a function. We'll subtract the size of the function
313// we may wish to inline from the indirect call bonus providing a limit on
314// growth. Leave an upper limit of 0 for the bonus - we don't want to penalize
315// inlining because we decide we don't want to give a bonus for
316// devirtualizing.
317int InlineCostAnalyzer::ConstantFunctionBonus(CallSite CS, Constant *C) {
Andrew Trick5c655412011-10-01 01:27:56 +0000318
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000319 // This could just be NULL.
320 if (!C) return 0;
Andrew Trick5c655412011-10-01 01:27:56 +0000321
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000322 Function *F = dyn_cast<Function>(C);
323 if (!F) return 0;
Andrew Trick5c655412011-10-01 01:27:56 +0000324
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000325 int Bonus = InlineConstants::IndirectCallBonus + getInlineSize(CS, F);
326 return (Bonus > 0) ? 0 : Bonus;
327}
328
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000329// CountBonusForConstant - Figure out an approximation for how much per-call
330// performance boost we can expect if the specified value is constant.
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000331int InlineCostAnalyzer::CountBonusForConstant(Value *V, Constant *C) {
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000332 unsigned Bonus = 0;
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000333 for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
334 User *U = *UI;
335 if (CallInst *CI = dyn_cast<CallInst>(U)) {
336 // Turning an indirect call into a direct call is a BIG win
337 if (CI->getCalledValue() == V)
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000338 Bonus += ConstantFunctionBonus(CallSite(CI), C);
339 } else if (InvokeInst *II = dyn_cast<InvokeInst>(U)) {
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000340 // Turning an indirect call into a direct call is a BIG win
341 if (II->getCalledValue() == V)
Eric Christophera818d032011-02-05 02:48:47 +0000342 Bonus += ConstantFunctionBonus(CallSite(II), C);
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000343 }
344 // FIXME: Eliminating conditional branches and switches should
345 // also yield a per-call performance boost.
346 else {
347 // Figure out the bonuses that wll accrue due to simple constant
348 // propagation.
349 Instruction &Inst = cast<Instruction>(*U);
350
351 // We can't constant propagate instructions which have effects or
352 // read memory.
353 //
354 // FIXME: It would be nice to capture the fact that a load from a
355 // pointer-to-constant-global is actually a *really* good thing to zap.
356 // Unfortunately, we don't know the pointer that may get propagated here,
357 // so we can't make this decision.
358 if (Inst.mayReadFromMemory() || Inst.mayHaveSideEffects() ||
359 isa<AllocaInst>(Inst))
360 continue;
361
362 bool AllOperandsConstant = true;
363 for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i)
364 if (!isa<Constant>(Inst.getOperand(i)) && Inst.getOperand(i) != V) {
365 AllOperandsConstant = false;
366 break;
367 }
368
369 if (AllOperandsConstant)
370 Bonus += CountBonusForConstant(&Inst);
371 }
372 }
Andrew Trick5c655412011-10-01 01:27:56 +0000373
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000374 return Bonus;
375}
376
377int InlineCostAnalyzer::getInlineSize(CallSite CS, Function *Callee) {
378 // Get information about the callee.
379 FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
Andrew Trick5c655412011-10-01 01:27:56 +0000380
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000381 // If we haven't calculated this information yet, do so now.
382 if (CalleeFI->Metrics.NumBlocks == 0)
Andrew Trickb2ab2fa2011-10-01 01:39:05 +0000383 CalleeFI->analyzeFunction(Callee, TD);
Andrew Trick5c655412011-10-01 01:27:56 +0000384
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000385 // InlineCost - This value measures how good of an inline candidate this call
386 // site is to inline. A lower inline cost make is more likely for the call to
387 // be inlined. This value may go negative.
388 //
389 int InlineCost = 0;
390
391 // Compute any size reductions we can expect due to arguments being passed into
392 // the function.
393 //
394 unsigned ArgNo = 0;
395 CallSite::arg_iterator I = CS.arg_begin();
396 for (Function::arg_iterator FI = Callee->arg_begin(), FE = Callee->arg_end();
397 FI != FE; ++I, ++FI, ++ArgNo) {
398
399 // If an alloca is passed in, inlining this function is likely to allow
400 // significant future optimization possibilities (like scalar promotion, and
401 // scalarization), so encourage the inlining of the function.
402 //
403 if (isa<AllocaInst>(I))
404 InlineCost -= CalleeFI->ArgumentWeights[ArgNo].AllocaWeight;
405
406 // If this is a constant being passed into the function, use the argument
407 // weights calculated for the callee to determine how much will be folded
408 // away with this information.
409 else if (isa<Constant>(I))
Andrew Trick5c655412011-10-01 01:27:56 +0000410 InlineCost -= CalleeFI->ArgumentWeights[ArgNo].ConstantWeight;
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000411 }
Andrew Trick5c655412011-10-01 01:27:56 +0000412
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000413 // Each argument passed in has a cost at both the caller and the callee
414 // sides. Measurements show that each argument costs about the same as an
415 // instruction.
416 InlineCost -= (CS.arg_size() * InlineConstants::InstrCost);
417
418 // Now that we have considered all of the factors that make the call site more
419 // likely to be inlined, look at factors that make us not want to inline it.
420
421 // Calls usually take a long time, so they make the inlining gain smaller.
422 InlineCost += CalleeFI->Metrics.NumCalls * InlineConstants::CallPenalty;
423
424 // Look at the size of the callee. Each instruction counts as 5.
425 InlineCost += CalleeFI->Metrics.NumInsts*InlineConstants::InstrCost;
Andrew Trick5c655412011-10-01 01:27:56 +0000426
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000427 return InlineCost;
428}
429
430int InlineCostAnalyzer::getInlineBonuses(CallSite CS, Function *Callee) {
431 // Get information about the callee.
432 FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
Andrew Trick5c655412011-10-01 01:27:56 +0000433
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000434 // If we haven't calculated this information yet, do so now.
435 if (CalleeFI->Metrics.NumBlocks == 0)
Andrew Trickb2ab2fa2011-10-01 01:39:05 +0000436 CalleeFI->analyzeFunction(Callee, TD);
Andrew Trick5c655412011-10-01 01:27:56 +0000437
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000438 bool isDirectCall = CS.getCalledFunction() == Callee;
439 Instruction *TheCall = CS.getInstruction();
440 int Bonus = 0;
Andrew Trick5c655412011-10-01 01:27:56 +0000441
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000442 // If there is only one call of the function, and it has internal linkage,
443 // make it almost guaranteed to be inlined.
444 //
445 if (Callee->hasLocalLinkage() && Callee->hasOneUse() && isDirectCall)
446 Bonus += InlineConstants::LastCallToStaticBonus;
Andrew Trick5c655412011-10-01 01:27:56 +0000447
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000448 // If the instruction after the call, or if the normal destination of the
449 // invoke is an unreachable instruction, the function is noreturn. As such,
450 // there is little point in inlining this.
451 if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall)) {
452 if (isa<UnreachableInst>(II->getNormalDest()->begin()))
453 Bonus += InlineConstants::NoreturnPenalty;
454 } else if (isa<UnreachableInst>(++BasicBlock::iterator(TheCall)))
455 Bonus += InlineConstants::NoreturnPenalty;
Andrew Trick5c655412011-10-01 01:27:56 +0000456
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000457 // If this function uses the coldcc calling convention, prefer not to inline
458 // it.
459 if (Callee->getCallingConv() == CallingConv::Cold)
460 Bonus += InlineConstants::ColdccPenalty;
Andrew Trick5c655412011-10-01 01:27:56 +0000461
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000462 // Add to the inline quality for properties that make the call valuable to
463 // inline. This includes factors that indicate that the result of inlining
464 // the function will be optimizable. Currently this just looks at arguments
465 // passed into the function.
466 //
467 CallSite::arg_iterator I = CS.arg_begin();
468 for (Function::arg_iterator FI = Callee->arg_begin(), FE = Callee->arg_end();
469 FI != FE; ++I, ++FI)
470 // Compute any constant bonus due to inlining we want to give here.
471 if (isa<Constant>(I))
472 Bonus += CountBonusForConstant(FI, cast<Constant>(I));
Andrew Trick5c655412011-10-01 01:27:56 +0000473
Eric Christopher8e2da0c2011-02-01 01:16:32 +0000474 return Bonus;
475}
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000476
Dan Gohmane4aeec02009-10-13 18:30:07 +0000477// getInlineCost - The heuristic used to determine if we should inline the
478// function call or not.
479//
480InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
Chris Lattner44b04a52010-04-17 17:55:00 +0000481 SmallPtrSet<const Function*, 16> &NeverInline) {
David Chisnall752e2592010-05-01 15:47:41 +0000482 return getInlineCost(CS, CS.getCalledFunction(), NeverInline);
483}
484
485InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
486 Function *Callee,
487 SmallPtrSet<const Function*, 16> &NeverInline) {
Dan Gohmane4aeec02009-10-13 18:30:07 +0000488 Instruction *TheCall = CS.getInstruction();
Dan Gohmane4aeec02009-10-13 18:30:07 +0000489 Function *Caller = TheCall->getParent()->getParent();
490
491 // Don't inline functions which can be redefined at link-time to mean
Eric Christopherf27e6082010-03-25 04:49:10 +0000492 // something else. Don't inline functions marked noinline or call sites
493 // marked noinline.
Dan Gohmane4aeec02009-10-13 18:30:07 +0000494 if (Callee->mayBeOverridden() ||
Eric Christopherf27e6082010-03-25 04:49:10 +0000495 Callee->hasFnAttr(Attribute::NoInline) || NeverInline.count(Callee) ||
496 CS.isNoInline())
Dan Gohmane4aeec02009-10-13 18:30:07 +0000497 return llvm::InlineCost::getNever();
498
Chris Lattner44b04a52010-04-17 17:55:00 +0000499 // Get information about the callee.
500 FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
Andrew Trick5c655412011-10-01 01:27:56 +0000501
Dan Gohmane4aeec02009-10-13 18:30:07 +0000502 // If we haven't calculated this information yet, do so now.
Chris Lattner44b04a52010-04-17 17:55:00 +0000503 if (CalleeFI->Metrics.NumBlocks == 0)
Andrew Trickb2ab2fa2011-10-01 01:39:05 +0000504 CalleeFI->analyzeFunction(Callee, TD);
Dan Gohmane4aeec02009-10-13 18:30:07 +0000505
506 // If we should never inline this, return a huge cost.
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000507 if (CalleeFI->NeverInline())
Dan Gohmane4aeec02009-10-13 18:30:07 +0000508 return InlineCost::getNever();
509
Chris Lattner44b04a52010-04-17 17:55:00 +0000510 // FIXME: It would be nice to kill off CalleeFI->NeverInline. Then we
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000511 // could move this up and avoid computing the FunctionInfo for
Dan Gohmane4aeec02009-10-13 18:30:07 +0000512 // things we are going to just return always inline for. This
513 // requires handling setjmp somewhere else, however.
514 if (!Callee->isDeclaration() && Callee->hasFnAttr(Attribute::AlwaysInline))
515 return InlineCost::getAlways();
Andrew Trick5c655412011-10-01 01:27:56 +0000516
Chris Lattner44b04a52010-04-17 17:55:00 +0000517 if (CalleeFI->Metrics.usesDynamicAlloca) {
Chris Lattner7a2bdde2011-04-15 05:18:47 +0000518 // Get information about the caller.
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000519 FunctionInfo &CallerFI = CachedFunctionInfo[Caller];
Dan Gohmane4aeec02009-10-13 18:30:07 +0000520
521 // If we haven't calculated this information yet, do so now.
Chris Lattnerf84755b2010-04-17 17:57:56 +0000522 if (CallerFI.Metrics.NumBlocks == 0) {
Andrew Trickb2ab2fa2011-10-01 01:39:05 +0000523 CallerFI.analyzeFunction(Caller, TD);
Andrew Trick5c655412011-10-01 01:27:56 +0000524
Chris Lattnerf84755b2010-04-17 17:57:56 +0000525 // Recompute the CalleeFI pointer, getting Caller could have invalidated
526 // it.
527 CalleeFI = &CachedFunctionInfo[Callee];
528 }
Dan Gohmane4aeec02009-10-13 18:30:07 +0000529
530 // Don't inline a callee with dynamic alloca into a caller without them.
531 // Functions containing dynamic alloca's are inefficient in various ways;
532 // don't create more inefficiency.
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000533 if (!CallerFI.Metrics.usesDynamicAlloca)
Dan Gohmane4aeec02009-10-13 18:30:07 +0000534 return InlineCost::getNever();
535 }
536
Eric Christopher1bcb4282011-01-25 01:34:31 +0000537 // InlineCost - This value measures how good of an inline candidate this call
538 // site is to inline. A lower inline cost make is more likely for the call to
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000539 // be inlined. This value may go negative due to the fact that bonuses
540 // are negative numbers.
Eric Christopher1bcb4282011-01-25 01:34:31 +0000541 //
Eric Christopher4e8af6d2011-02-05 00:49:15 +0000542 int InlineCost = getInlineSize(CS, Callee) + getInlineBonuses(CS, Callee);
Dan Gohmane4aeec02009-10-13 18:30:07 +0000543 return llvm::InlineCost::get(InlineCost);
544}
545
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000546// getSpecializationCost - The heuristic used to determine the code-size
547// impact of creating a specialized version of Callee with argument
548// SpecializedArgNo replaced by a constant.
549InlineCost InlineCostAnalyzer::getSpecializationCost(Function *Callee,
550 SmallVectorImpl<unsigned> &SpecializedArgNos)
551{
552 // Don't specialize functions which can be redefined at link-time to mean
553 // something else.
554 if (Callee->mayBeOverridden())
555 return llvm::InlineCost::getNever();
Andrew Trick5c655412011-10-01 01:27:56 +0000556
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000557 // Get information about the callee.
558 FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
Andrew Trick5c655412011-10-01 01:27:56 +0000559
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000560 // If we haven't calculated this information yet, do so now.
561 if (CalleeFI->Metrics.NumBlocks == 0)
Andrew Trickb2ab2fa2011-10-01 01:39:05 +0000562 CalleeFI->analyzeFunction(Callee, TD);
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000563
564 int Cost = 0;
Andrew Trick5c655412011-10-01 01:27:56 +0000565
Chris Lattner7a2bdde2011-04-15 05:18:47 +0000566 // Look at the original size of the callee. Each instruction counts as 5.
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000567 Cost += CalleeFI->Metrics.NumInsts * InlineConstants::InstrCost;
568
569 // Offset that with the amount of code that can be constant-folded
570 // away with the given arguments replaced by constants.
571 for (SmallVectorImpl<unsigned>::iterator an = SpecializedArgNos.begin(),
572 ae = SpecializedArgNos.end(); an != ae; ++an)
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000573 Cost -= CalleeFI->ArgumentWeights[*an].ConstantWeight;
Kenneth Uildriks74fa7322010-10-09 22:06:36 +0000574
575 return llvm::InlineCost::get(Cost);
576}
577
Dan Gohmane4aeec02009-10-13 18:30:07 +0000578// getInlineFudgeFactor - Return a > 1.0 factor if the inliner should use a
579// higher threshold to determine if the function call should be inlined.
580float InlineCostAnalyzer::getInlineFudgeFactor(CallSite CS) {
581 Function *Callee = CS.getCalledFunction();
Andrew Trick5c655412011-10-01 01:27:56 +0000582
Chris Lattner44b04a52010-04-17 17:55:00 +0000583 // Get information about the callee.
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000584 FunctionInfo &CalleeFI = CachedFunctionInfo[Callee];
Andrew Trick5c655412011-10-01 01:27:56 +0000585
Dan Gohmane4aeec02009-10-13 18:30:07 +0000586 // If we haven't calculated this information yet, do so now.
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000587 if (CalleeFI.Metrics.NumBlocks == 0)
Andrew Trickb2ab2fa2011-10-01 01:39:05 +0000588 CalleeFI.analyzeFunction(Callee, TD);
Dan Gohmane4aeec02009-10-13 18:30:07 +0000589
590 float Factor = 1.0f;
591 // Single BB functions are often written to be inlined.
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000592 if (CalleeFI.Metrics.NumBlocks == 1)
Dan Gohmane4aeec02009-10-13 18:30:07 +0000593 Factor += 0.5f;
594
595 // Be more aggressive if the function contains a good chunk (if it mades up
596 // at least 10% of the instructions) of vector instructions.
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000597 if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/2)
Dan Gohmane4aeec02009-10-13 18:30:07 +0000598 Factor += 2.0f;
Dan Gohmane7f0ed52009-10-13 19:58:07 +0000599 else if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/10)
Dan Gohmane4aeec02009-10-13 18:30:07 +0000600 Factor += 1.5f;
601 return Factor;
602}
Jakob Stoklund Olesenf7477472010-03-09 23:02:17 +0000603
604/// growCachedCostInfo - update the cached cost info for Caller after Callee has
605/// been inlined.
606void
Chris Lattner44b04a52010-04-17 17:55:00 +0000607InlineCostAnalyzer::growCachedCostInfo(Function *Caller, Function *Callee) {
608 CodeMetrics &CallerMetrics = CachedFunctionInfo[Caller].Metrics;
Jakob Stoklund Olesenf7477472010-03-09 23:02:17 +0000609
610 // For small functions we prefer to recalculate the cost for better accuracy.
Eli Friedmanb1763992011-05-24 20:22:24 +0000611 if (CallerMetrics.NumBlocks < 10 && CallerMetrics.NumInsts < 1000) {
Jakob Stoklund Olesenf7477472010-03-09 23:02:17 +0000612 resetCachedCostInfo(Caller);
613 return;
614 }
615
616 // For large functions, we can save a lot of computation time by skipping
617 // recalculations.
Chris Lattner44b04a52010-04-17 17:55:00 +0000618 if (CallerMetrics.NumCalls > 0)
619 --CallerMetrics.NumCalls;
Jakob Stoklund Olesenf7477472010-03-09 23:02:17 +0000620
Chris Lattner44b04a52010-04-17 17:55:00 +0000621 if (Callee == 0) return;
Andrew Trick5c655412011-10-01 01:27:56 +0000622
Chris Lattner44b04a52010-04-17 17:55:00 +0000623 CodeMetrics &CalleeMetrics = CachedFunctionInfo[Callee].Metrics;
Jakob Stoklund Olesenf7477472010-03-09 23:02:17 +0000624
Chris Lattner44b04a52010-04-17 17:55:00 +0000625 // If we don't have metrics for the callee, don't recalculate them just to
626 // update an approximation in the caller. Instead, just recalculate the
627 // caller info from scratch.
628 if (CalleeMetrics.NumBlocks == 0) {
629 resetCachedCostInfo(Caller);
630 return;
Jakob Stoklund Olesenf7477472010-03-09 23:02:17 +0000631 }
Andrew Trick5c655412011-10-01 01:27:56 +0000632
Chris Lattnerf84755b2010-04-17 17:57:56 +0000633 // Since CalleeMetrics were already calculated, we know that the CallerMetrics
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000634 // reference isn't invalidated: both were in the DenseMap.
Chris Lattner44b04a52010-04-17 17:55:00 +0000635 CallerMetrics.usesDynamicAlloca |= CalleeMetrics.usesDynamicAlloca;
636
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000637 // FIXME: If any of these three are true for the callee, the callee was
638 // not inlined into the caller, so I think they're redundant here.
Joerg Sonnenberger34706932011-12-18 20:35:43 +0000639 CallerMetrics.exposesReturnsTwice |= CalleeMetrics.exposesReturnsTwice;
Kenneth Uildriks42c7d232010-06-09 15:11:37 +0000640 CallerMetrics.isRecursive |= CalleeMetrics.isRecursive;
641 CallerMetrics.containsIndirectBr |= CalleeMetrics.containsIndirectBr;
642
Chris Lattner44b04a52010-04-17 17:55:00 +0000643 CallerMetrics.NumInsts += CalleeMetrics.NumInsts;
644 CallerMetrics.NumBlocks += CalleeMetrics.NumBlocks;
645 CallerMetrics.NumCalls += CalleeMetrics.NumCalls;
646 CallerMetrics.NumVectorInsts += CalleeMetrics.NumVectorInsts;
647 CallerMetrics.NumRets += CalleeMetrics.NumRets;
648
649 // analyzeBasicBlock counts each function argument as an inst.
650 if (CallerMetrics.NumInsts >= Callee->arg_size())
651 CallerMetrics.NumInsts -= Callee->arg_size();
652 else
653 CallerMetrics.NumInsts = 0;
Andrew Trick5c655412011-10-01 01:27:56 +0000654
Nick Lewycky9a1581b2010-05-12 21:48:15 +0000655 // We are not updating the argument weights. We have already determined that
Jakob Stoklund Olesenf7477472010-03-09 23:02:17 +0000656 // Caller is a fairly large function, so we accept the loss of precision.
657}
Nick Lewycky9a1581b2010-05-12 21:48:15 +0000658
659/// clear - empty the cache of inline costs
660void InlineCostAnalyzer::clear() {
661 CachedFunctionInfo.clear();
662}