Continue counting intrinsics as instructions (except when they aren't, such as
[oota-llvm.git] / 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 // CountCodeReductionForConstant - Figure out an approximation for how many
166 // instructions will be constant folded if the specified value is constant.
167 //
168 unsigned CodeMetrics::CountCodeReductionForConstant(Value *V) {
169   unsigned Reduction = 0;
170   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
171     User *U = *UI;
172     if (isa<BranchInst>(U) || isa<SwitchInst>(U)) {
173       // We will be able to eliminate all but one of the successors.
174       const TerminatorInst &TI = cast<TerminatorInst>(*U);
175       const unsigned NumSucc = TI.getNumSuccessors();
176       unsigned Instrs = 0;
177       for (unsigned I = 0; I != NumSucc; ++I)
178         Instrs += NumBBInsts[TI.getSuccessor(I)];
179       // We don't know which blocks will be eliminated, so use the average size.
180       Reduction += InlineConstants::InstrCost*Instrs*(NumSucc-1)/NumSucc;
181     } else {
182       // Figure out if this instruction will be removed due to simple constant
183       // propagation.
184       Instruction &Inst = cast<Instruction>(*U);
185
186       // We can't constant propagate instructions which have effects or
187       // read memory.
188       //
189       // FIXME: It would be nice to capture the fact that a load from a
190       // pointer-to-constant-global is actually a *really* good thing to zap.
191       // Unfortunately, we don't know the pointer that may get propagated here,
192       // so we can't make this decision.
193       if (Inst.mayReadFromMemory() || Inst.mayHaveSideEffects() ||
194           isa<AllocaInst>(Inst))
195         continue;
196
197       bool AllOperandsConstant = true;
198       for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i)
199         if (!isa<Constant>(Inst.getOperand(i)) && Inst.getOperand(i) != V) {
200           AllOperandsConstant = false;
201           break;
202         }
203
204       if (AllOperandsConstant) {
205         // We will get to remove this instruction...
206         Reduction += InlineConstants::InstrCost;
207
208         // And any other instructions that use it which become constants
209         // themselves.
210         Reduction += CountCodeReductionForConstant(&Inst);
211       }
212     }
213   }
214   return Reduction;
215 }
216
217 // CountCodeReductionForAlloca - Figure out an approximation of how much smaller
218 // the function will be if it is inlined into a context where an argument
219 // becomes an alloca.
220 //
221 unsigned CodeMetrics::CountCodeReductionForAlloca(Value *V) {
222   if (!V->getType()->isPointerTy()) return 0;  // Not a pointer
223   unsigned Reduction = 0;
224   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
225     Instruction *I = cast<Instruction>(*UI);
226     if (isa<LoadInst>(I) || isa<StoreInst>(I))
227       Reduction += InlineConstants::InstrCost;
228     else if (GetElementPtrInst *GEP = dyn_cast<GetElementPtrInst>(I)) {
229       // If the GEP has variable indices, we won't be able to do much with it.
230       if (GEP->hasAllConstantIndices())
231         Reduction += CountCodeReductionForAlloca(GEP);
232     } else if (BitCastInst *BCI = dyn_cast<BitCastInst>(I)) {
233       // Track pointer through bitcasts.
234       Reduction += CountCodeReductionForAlloca(BCI);
235     } else {
236       // If there is some other strange instruction, we're not going to be able
237       // to do much if we inline this.
238       return 0;
239     }
240   }
241
242   return Reduction;
243 }
244
245 /// analyzeFunction - Fill in the current structure with information gleaned
246 /// from the specified function.
247 void CodeMetrics::analyzeFunction(Function *F, const TargetData *TD) {
248   // If this function contains a call that "returns twice" (e.g., setjmp or
249   // _setjmp) and it isn't marked with "returns twice" itself, never inline it.
250   // This is a hack because we depend on the user marking their local variables
251   // as volatile if they are live across a setjmp call, and they probably
252   // won't do this in callers.
253   exposesReturnsTwice = F->callsFunctionThatReturnsTwice() &&
254     !F->hasFnAttr(Attribute::ReturnsTwice);
255
256   // Look at the size of the callee.
257   for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
258     analyzeBasicBlock(&*BB, TD);
259 }
260
261 /// analyzeFunction - Fill in the current structure with information gleaned
262 /// from the specified function.
263 void InlineCostAnalyzer::FunctionInfo::analyzeFunction(Function *F,
264                                                        const TargetData *TD) {
265   Metrics.analyzeFunction(F, TD);
266
267   // A function with exactly one return has it removed during the inlining
268   // process (see InlineFunction), so don't count it.
269   // FIXME: This knowledge should really be encoded outside of FunctionInfo.
270   if (Metrics.NumRets==1)
271     --Metrics.NumInsts;
272
273   // Check out all of the arguments to the function, figuring out how much
274   // code can be eliminated if one of the arguments is a constant.
275   ArgumentWeights.reserve(F->arg_size());
276   for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
277     ArgumentWeights.push_back(ArgInfo(Metrics.CountCodeReductionForConstant(I),
278                                       Metrics.CountCodeReductionForAlloca(I)));
279 }
280
281 /// NeverInline - returns true if the function should never be inlined into
282 /// any caller
283 bool InlineCostAnalyzer::FunctionInfo::NeverInline() {
284   return (Metrics.exposesReturnsTwice || Metrics.isRecursive ||
285           Metrics.containsIndirectBr);
286 }
287 // getSpecializationBonus - The heuristic used to determine the per-call
288 // performance boost for using a specialization of Callee with argument
289 // specializedArgNo replaced by a constant.
290 int InlineCostAnalyzer::getSpecializationBonus(Function *Callee,
291          SmallVectorImpl<unsigned> &SpecializedArgNos)
292 {
293   if (Callee->mayBeOverridden())
294     return 0;
295
296   int Bonus = 0;
297   // If this function uses the coldcc calling convention, prefer not to
298   // specialize it.
299   if (Callee->getCallingConv() == CallingConv::Cold)
300     Bonus -= InlineConstants::ColdccPenalty;
301
302   // Get information about the callee.
303   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
304
305   // If we haven't calculated this information yet, do so now.
306   if (CalleeFI->Metrics.NumBlocks == 0)
307     CalleeFI->analyzeFunction(Callee, TD);
308
309   unsigned ArgNo = 0;
310   unsigned i = 0;
311   for (Function::arg_iterator I = Callee->arg_begin(), E = Callee->arg_end();
312        I != E; ++I, ++ArgNo)
313     if (ArgNo == SpecializedArgNos[i]) {
314       ++i;
315       Bonus += CountBonusForConstant(I);
316     }
317
318   // Calls usually take a long time, so they make the specialization gain
319   // smaller.
320   Bonus -= CalleeFI->Metrics.NumCalls * InlineConstants::CallPenalty;
321
322   return Bonus;
323 }
324
325 // ConstantFunctionBonus - Figure out how much of a bonus we can get for
326 // possibly devirtualizing a function. We'll subtract the size of the function
327 // we may wish to inline from the indirect call bonus providing a limit on
328 // growth. Leave an upper limit of 0 for the bonus - we don't want to penalize
329 // inlining because we decide we don't want to give a bonus for
330 // devirtualizing.
331 int InlineCostAnalyzer::ConstantFunctionBonus(CallSite CS, Constant *C) {
332
333   // This could just be NULL.
334   if (!C) return 0;
335
336   Function *F = dyn_cast<Function>(C);
337   if (!F) return 0;
338
339   int Bonus = InlineConstants::IndirectCallBonus + getInlineSize(CS, F);
340   return (Bonus > 0) ? 0 : Bonus;
341 }
342
343 // CountBonusForConstant - Figure out an approximation for how much per-call
344 // performance boost we can expect if the specified value is constant.
345 int InlineCostAnalyzer::CountBonusForConstant(Value *V, Constant *C) {
346   unsigned Bonus = 0;
347   for (Value::use_iterator UI = V->use_begin(), E = V->use_end(); UI != E;++UI){
348     User *U = *UI;
349     if (CallInst *CI = dyn_cast<CallInst>(U)) {
350       // Turning an indirect call into a direct call is a BIG win
351       if (CI->getCalledValue() == V)
352         Bonus += ConstantFunctionBonus(CallSite(CI), C);
353     } else if (InvokeInst *II = dyn_cast<InvokeInst>(U)) {
354       // Turning an indirect call into a direct call is a BIG win
355       if (II->getCalledValue() == V)
356         Bonus += ConstantFunctionBonus(CallSite(II), C);
357     }
358     // FIXME: Eliminating conditional branches and switches should
359     // also yield a per-call performance boost.
360     else {
361       // Figure out the bonuses that wll accrue due to simple constant
362       // propagation.
363       Instruction &Inst = cast<Instruction>(*U);
364
365       // We can't constant propagate instructions which have effects or
366       // read memory.
367       //
368       // FIXME: It would be nice to capture the fact that a load from a
369       // pointer-to-constant-global is actually a *really* good thing to zap.
370       // Unfortunately, we don't know the pointer that may get propagated here,
371       // so we can't make this decision.
372       if (Inst.mayReadFromMemory() || Inst.mayHaveSideEffects() ||
373           isa<AllocaInst>(Inst))
374         continue;
375
376       bool AllOperandsConstant = true;
377       for (unsigned i = 0, e = Inst.getNumOperands(); i != e; ++i)
378         if (!isa<Constant>(Inst.getOperand(i)) && Inst.getOperand(i) != V) {
379           AllOperandsConstant = false;
380           break;
381         }
382
383       if (AllOperandsConstant)
384         Bonus += CountBonusForConstant(&Inst);
385     }
386   }
387
388   return Bonus;
389 }
390
391 int InlineCostAnalyzer::getInlineSize(CallSite CS, Function *Callee) {
392   // Get information about the callee.
393   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
394
395   // If we haven't calculated this information yet, do so now.
396   if (CalleeFI->Metrics.NumBlocks == 0)
397     CalleeFI->analyzeFunction(Callee, TD);
398
399   // InlineCost - This value measures how good of an inline candidate this call
400   // site is to inline.  A lower inline cost make is more likely for the call to
401   // be inlined.  This value may go negative.
402   //
403   int InlineCost = 0;
404
405   // Compute any size reductions we can expect due to arguments being passed into
406   // the function.
407   //
408   unsigned ArgNo = 0;
409   CallSite::arg_iterator I = CS.arg_begin();
410   for (Function::arg_iterator FI = Callee->arg_begin(), FE = Callee->arg_end();
411        FI != FE; ++I, ++FI, ++ArgNo) {
412
413     // If an alloca is passed in, inlining this function is likely to allow
414     // significant future optimization possibilities (like scalar promotion, and
415     // scalarization), so encourage the inlining of the function.
416     //
417     if (isa<AllocaInst>(I))
418       InlineCost -= CalleeFI->ArgumentWeights[ArgNo].AllocaWeight;
419
420     // If this is a constant being passed into the function, use the argument
421     // weights calculated for the callee to determine how much will be folded
422     // away with this information.
423     else if (isa<Constant>(I))
424       InlineCost -= CalleeFI->ArgumentWeights[ArgNo].ConstantWeight;
425   }
426
427   // Each argument passed in has a cost at both the caller and the callee
428   // sides.  Measurements show that each argument costs about the same as an
429   // instruction.
430   InlineCost -= (CS.arg_size() * InlineConstants::InstrCost);
431
432   // Now that we have considered all of the factors that make the call site more
433   // likely to be inlined, look at factors that make us not want to inline it.
434
435   // Calls usually take a long time, so they make the inlining gain smaller.
436   InlineCost += CalleeFI->Metrics.NumCalls * InlineConstants::CallPenalty;
437
438   // Look at the size of the callee. Each instruction counts as 5.
439   InlineCost += CalleeFI->Metrics.NumInsts * InlineConstants::InstrCost;
440
441   return InlineCost;
442 }
443
444 int InlineCostAnalyzer::getInlineBonuses(CallSite CS, Function *Callee) {
445   // Get information about the callee.
446   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
447
448   // If we haven't calculated this information yet, do so now.
449   if (CalleeFI->Metrics.NumBlocks == 0)
450     CalleeFI->analyzeFunction(Callee, TD);
451
452   bool isDirectCall = CS.getCalledFunction() == Callee;
453   Instruction *TheCall = CS.getInstruction();
454   int Bonus = 0;
455
456   // If there is only one call of the function, and it has internal linkage,
457   // make it almost guaranteed to be inlined.
458   //
459   if (Callee->hasLocalLinkage() && Callee->hasOneUse() && isDirectCall)
460     Bonus += InlineConstants::LastCallToStaticBonus;
461
462   // If the instruction after the call, or if the normal destination of the
463   // invoke is an unreachable instruction, the function is noreturn.  As such,
464   // there is little point in inlining this.
465   if (InvokeInst *II = dyn_cast<InvokeInst>(TheCall)) {
466     if (isa<UnreachableInst>(II->getNormalDest()->begin()))
467       Bonus += InlineConstants::NoreturnPenalty;
468   } else if (isa<UnreachableInst>(++BasicBlock::iterator(TheCall)))
469     Bonus += InlineConstants::NoreturnPenalty;
470
471   // If this function uses the coldcc calling convention, prefer not to inline
472   // it.
473   if (Callee->getCallingConv() == CallingConv::Cold)
474     Bonus += InlineConstants::ColdccPenalty;
475
476   // Add to the inline quality for properties that make the call valuable to
477   // inline.  This includes factors that indicate that the result of inlining
478   // the function will be optimizable.  Currently this just looks at arguments
479   // passed into the function.
480   //
481   CallSite::arg_iterator I = CS.arg_begin();
482   for (Function::arg_iterator FI = Callee->arg_begin(), FE = Callee->arg_end();
483        FI != FE; ++I, ++FI)
484     // Compute any constant bonus due to inlining we want to give here.
485     if (isa<Constant>(I))
486       Bonus += CountBonusForConstant(FI, cast<Constant>(I));
487
488   return Bonus;
489 }
490
491 // getInlineCost - The heuristic used to determine if we should inline the
492 // function call or not.
493 //
494 InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
495                                SmallPtrSet<const Function*, 16> &NeverInline) {
496   return getInlineCost(CS, CS.getCalledFunction(), NeverInline);
497 }
498
499 InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
500                                Function *Callee,
501                                SmallPtrSet<const Function*, 16> &NeverInline) {
502   Instruction *TheCall = CS.getInstruction();
503   Function *Caller = TheCall->getParent()->getParent();
504
505   // Don't inline functions which can be redefined at link-time to mean
506   // something else.  Don't inline functions marked noinline or call sites
507   // marked noinline.
508   if (Callee->mayBeOverridden() ||
509       Callee->hasFnAttr(Attribute::NoInline) || NeverInline.count(Callee) ||
510       CS.isNoInline())
511     return llvm::InlineCost::getNever();
512
513   // Get information about the callee.
514   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
515
516   // If we haven't calculated this information yet, do so now.
517   if (CalleeFI->Metrics.NumBlocks == 0)
518     CalleeFI->analyzeFunction(Callee, TD);
519
520   // If we should never inline this, return a huge cost.
521   if (CalleeFI->NeverInline())
522     return InlineCost::getNever();
523
524   // FIXME: It would be nice to kill off CalleeFI->NeverInline. Then we
525   // could move this up and avoid computing the FunctionInfo for
526   // things we are going to just return always inline for. This
527   // requires handling setjmp somewhere else, however.
528   if (!Callee->isDeclaration() && Callee->hasFnAttr(Attribute::AlwaysInline))
529     return InlineCost::getAlways();
530
531   if (CalleeFI->Metrics.usesDynamicAlloca) {
532     // Get information about the caller.
533     FunctionInfo &CallerFI = CachedFunctionInfo[Caller];
534
535     // If we haven't calculated this information yet, do so now.
536     if (CallerFI.Metrics.NumBlocks == 0) {
537       CallerFI.analyzeFunction(Caller, TD);
538
539       // Recompute the CalleeFI pointer, getting Caller could have invalidated
540       // it.
541       CalleeFI = &CachedFunctionInfo[Callee];
542     }
543
544     // Don't inline a callee with dynamic alloca into a caller without them.
545     // Functions containing dynamic alloca's are inefficient in various ways;
546     // don't create more inefficiency.
547     if (!CallerFI.Metrics.usesDynamicAlloca)
548       return InlineCost::getNever();
549   }
550
551   // InlineCost - This value measures how good of an inline candidate this call
552   // site is to inline.  A lower inline cost make is more likely for the call to
553   // be inlined.  This value may go negative due to the fact that bonuses
554   // are negative numbers.
555   //
556   int InlineCost = getInlineSize(CS, Callee) + getInlineBonuses(CS, Callee);
557   return llvm::InlineCost::get(InlineCost);
558 }
559
560 // getSpecializationCost - The heuristic used to determine the code-size
561 // impact of creating a specialized version of Callee with argument
562 // SpecializedArgNo replaced by a constant.
563 InlineCost InlineCostAnalyzer::getSpecializationCost(Function *Callee,
564                                SmallVectorImpl<unsigned> &SpecializedArgNos)
565 {
566   // Don't specialize functions which can be redefined at link-time to mean
567   // something else.
568   if (Callee->mayBeOverridden())
569     return llvm::InlineCost::getNever();
570
571   // Get information about the callee.
572   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
573
574   // If we haven't calculated this information yet, do so now.
575   if (CalleeFI->Metrics.NumBlocks == 0)
576     CalleeFI->analyzeFunction(Callee, TD);
577
578   int Cost = 0;
579
580   // Look at the original size of the callee.  Each instruction counts as 5.
581   Cost += CalleeFI->Metrics.NumInsts * InlineConstants::InstrCost;
582
583   // Offset that with the amount of code that can be constant-folded
584   // away with the given arguments replaced by constants.
585   for (SmallVectorImpl<unsigned>::iterator an = SpecializedArgNos.begin(),
586        ae = SpecializedArgNos.end(); an != ae; ++an)
587     Cost -= CalleeFI->ArgumentWeights[*an].ConstantWeight;
588
589   return llvm::InlineCost::get(Cost);
590 }
591
592 // getInlineFudgeFactor - Return a > 1.0 factor if the inliner should use a
593 // higher threshold to determine if the function call should be inlined.
594 float InlineCostAnalyzer::getInlineFudgeFactor(CallSite CS) {
595   Function *Callee = CS.getCalledFunction();
596
597   // Get information about the callee.
598   FunctionInfo &CalleeFI = CachedFunctionInfo[Callee];
599
600   // If we haven't calculated this information yet, do so now.
601   if (CalleeFI.Metrics.NumBlocks == 0)
602     CalleeFI.analyzeFunction(Callee, TD);
603
604   float Factor = 1.0f;
605   // Single BB functions are often written to be inlined.
606   if (CalleeFI.Metrics.NumBlocks == 1)
607     Factor += 0.5f;
608
609   // Be more aggressive if the function contains a good chunk (if it mades up
610   // at least 10% of the instructions) of vector instructions.
611   if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/2)
612     Factor += 2.0f;
613   else if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/10)
614     Factor += 1.5f;
615   return Factor;
616 }
617
618 /// growCachedCostInfo - update the cached cost info for Caller after Callee has
619 /// been inlined.
620 void
621 InlineCostAnalyzer::growCachedCostInfo(Function *Caller, Function *Callee) {
622   CodeMetrics &CallerMetrics = CachedFunctionInfo[Caller].Metrics;
623
624   // For small functions we prefer to recalculate the cost for better accuracy.
625   if (CallerMetrics.NumBlocks < 10 && CallerMetrics.NumInsts < 1000) {
626     resetCachedCostInfo(Caller);
627     return;
628   }
629
630   // For large functions, we can save a lot of computation time by skipping
631   // recalculations.
632   if (CallerMetrics.NumCalls > 0)
633     --CallerMetrics.NumCalls;
634
635   if (Callee == 0) return;
636
637   CodeMetrics &CalleeMetrics = CachedFunctionInfo[Callee].Metrics;
638
639   // If we don't have metrics for the callee, don't recalculate them just to
640   // update an approximation in the caller.  Instead, just recalculate the
641   // caller info from scratch.
642   if (CalleeMetrics.NumBlocks == 0) {
643     resetCachedCostInfo(Caller);
644     return;
645   }
646
647   // Since CalleeMetrics were already calculated, we know that the CallerMetrics
648   // reference isn't invalidated: both were in the DenseMap.
649   CallerMetrics.usesDynamicAlloca |= CalleeMetrics.usesDynamicAlloca;
650
651   // FIXME: If any of these three are true for the callee, the callee was
652   // not inlined into the caller, so I think they're redundant here.
653   CallerMetrics.exposesReturnsTwice |= CalleeMetrics.exposesReturnsTwice;
654   CallerMetrics.isRecursive |= CalleeMetrics.isRecursive;
655   CallerMetrics.containsIndirectBr |= CalleeMetrics.containsIndirectBr;
656
657   CallerMetrics.NumInsts += CalleeMetrics.NumInsts;
658   CallerMetrics.NumBlocks += CalleeMetrics.NumBlocks;
659   CallerMetrics.NumCalls += CalleeMetrics.NumCalls;
660   CallerMetrics.NumVectorInsts += CalleeMetrics.NumVectorInsts;
661   CallerMetrics.NumRets += CalleeMetrics.NumRets;
662
663   // analyzeBasicBlock counts each function argument as an inst.
664   if (CallerMetrics.NumInsts >= Callee->arg_size())
665     CallerMetrics.NumInsts -= Callee->arg_size();
666   else
667     CallerMetrics.NumInsts = 0;
668
669   // We are not updating the argument weights. We have already determined that
670   // Caller is a fairly large function, so we accept the loss of precision.
671 }
672
673 /// clear - empty the cache of inline costs
674 void InlineCostAnalyzer::clear() {
675   CachedFunctionInfo.clear();
676 }