Allow inlining of functions with returns_twice calls, if they have the
[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 (isa<DbgInfoIntrinsic>(II))
67         continue;  // Debug intrinsics don't count as size.
68
69       ImmutableCallSite CS(cast<Instruction>(II));
70
71       if (const Function *F = CS.getCalledFunction()) {
72         // 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
74         // exposed by an interleaved devirtualization pass).
75         if (F->hasInternalLinkage() && F->hasOneUse())
76           ++NumInlineCandidates;
77
78         // 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())
83           isRecursive = true;
84       }
85
86       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();
89
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;
94       }
95     }
96
97     if (const AllocaInst *AI = dyn_cast<AllocaInst>(II)) {
98       if (!AI->isStaticAlloca())
99         this->usesDynamicAlloca = true;
100     }
101
102     if (isa<ExtractElementInst>(II) || II->getType()->isVectorTy())
103       ++NumVectorInsts;
104
105     if (const CastInst *CI = dyn_cast<CastInst>(II)) {
106       // Noop casts, including ptr <-> int,  don't count.
107       if (CI->isLosslessCast() || isa<IntToPtrInst>(CI) ||
108           isa<PtrToIntInst>(CI))
109         continue;
110       // 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;
115       // Result of a cmp instruction is often extended (to be used by other
116       // cmp instructions, logical or return instructions). These are usually
117       // nop on most sane targets.
118       if (isa<CmpInst>(CI->getOperand(0)))
119         continue;
120     } else if (const GetElementPtrInst *GEPI = dyn_cast<GetElementPtrInst>(II)){
121       // 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
127     ++NumInsts;
128   }
129
130   if (isa<ReturnInst>(BB->getTerminator()))
131     ++NumRets;
132
133   // We never want to inline functions that contain an indirectbr.  This is
134   // incorrect because all the blockaddress's (in static global initializers
135   // for example) would be referring to the original function, and this indirect
136   // jump would jump from the inlined copy of the function into the original
137   // function which is extremely undefined behavior.
138   // 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.
144   if (isa<IndirectBrInst>(BB->getTerminator()))
145     containsIndirectBr = true;
146
147   // Remember NumInsts for this BB.
148   NumBBInsts[BB] = NumInsts - NumInstsBeforeThisBB;
149 }
150
151 // CountCodeReductionForConstant - Figure out an approximation for how many
152 // instructions will be constant folded if the specified value is constant.
153 //
154 unsigned 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;
167     } 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 //
207 unsigned 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
231 /// analyzeFunction - Fill in the current structure with information gleaned
232 /// from the specified function.
233 void CodeMetrics::analyzeFunction(Function *F, const TargetData *TD) {
234   // If this function contains a call that "returns twice" (e.g., setjmp or
235   // _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);
241
242   // Look at the size of the callee.
243   for (Function::const_iterator BB = F->begin(), E = F->end(); BB != E; ++BB)
244     analyzeBasicBlock(&*BB, TD);
245 }
246
247 /// analyzeFunction - Fill in the current structure with information gleaned
248 /// from the specified function.
249 void InlineCostAnalyzer::FunctionInfo::analyzeFunction(Function *F,
250                                                        const TargetData *TD) {
251   Metrics.analyzeFunction(F, TD);
252
253   // A function with exactly one return has it removed during the inlining
254   // process (see InlineFunction), so don't count it.
255   // FIXME: This knowledge should really be encoded outside of FunctionInfo.
256   if (Metrics.NumRets==1)
257     --Metrics.NumInsts;
258
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.
261   ArgumentWeights.reserve(F->arg_size());
262   for (Function::arg_iterator I = F->arg_begin(), E = F->arg_end(); I != E; ++I)
263     ArgumentWeights.push_back(ArgInfo(Metrics.CountCodeReductionForConstant(I),
264                                       Metrics.CountCodeReductionForAlloca(I)));
265 }
266
267 /// NeverInline - returns true if the function should never be inlined into
268 /// any caller
269 bool InlineCostAnalyzer::FunctionInfo::NeverInline() {
270   return (Metrics.exposesReturnsTwice || Metrics.isRecursive ||
271           Metrics.containsIndirectBr);
272 }
273 // 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.
276 int InlineCostAnalyzer::getSpecializationBonus(Function *Callee,
277          SmallVectorImpl<unsigned> &SpecializedArgNos)
278 {
279   if (Callee->mayBeOverridden())
280     return 0;
281
282   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;
287
288   // Get information about the callee.
289   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
290
291   // If we haven't calculated this information yet, do so now.
292   if (CalleeFI->Metrics.NumBlocks == 0)
293     CalleeFI->analyzeFunction(Callee, TD);
294
295   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     }
303
304   // Calls usually take a long time, so they make the specialization gain
305   // smaller.
306   Bonus -= CalleeFI->Metrics.NumCalls * InlineConstants::CallPenalty;
307
308   return Bonus;
309 }
310
311 // 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.
317 int InlineCostAnalyzer::ConstantFunctionBonus(CallSite CS, Constant *C) {
318
319   // This could just be NULL.
320   if (!C) return 0;
321
322   Function *F = dyn_cast<Function>(C);
323   if (!F) return 0;
324
325   int Bonus = InlineConstants::IndirectCallBonus + getInlineSize(CS, F);
326   return (Bonus > 0) ? 0 : Bonus;
327 }
328
329 // CountBonusForConstant - Figure out an approximation for how much per-call
330 // performance boost we can expect if the specified value is constant.
331 int InlineCostAnalyzer::CountBonusForConstant(Value *V, Constant *C) {
332   unsigned Bonus = 0;
333   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)
338         Bonus += ConstantFunctionBonus(CallSite(CI), C);
339     } else if (InvokeInst *II = dyn_cast<InvokeInst>(U)) {
340       // Turning an indirect call into a direct call is a BIG win
341       if (II->getCalledValue() == V)
342         Bonus += ConstantFunctionBonus(CallSite(II), C);
343     }
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   }
373
374   return Bonus;
375 }
376
377 int InlineCostAnalyzer::getInlineSize(CallSite CS, Function *Callee) {
378   // Get information about the callee.
379   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
380
381   // If we haven't calculated this information yet, do so now.
382   if (CalleeFI->Metrics.NumBlocks == 0)
383     CalleeFI->analyzeFunction(Callee, TD);
384
385   // 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))
410       InlineCost -= CalleeFI->ArgumentWeights[ArgNo].ConstantWeight;
411   }
412
413   // 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;
426
427   return InlineCost;
428 }
429
430 int InlineCostAnalyzer::getInlineBonuses(CallSite CS, Function *Callee) {
431   // Get information about the callee.
432   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
433
434   // If we haven't calculated this information yet, do so now.
435   if (CalleeFI->Metrics.NumBlocks == 0)
436     CalleeFI->analyzeFunction(Callee, TD);
437
438   bool isDirectCall = CS.getCalledFunction() == Callee;
439   Instruction *TheCall = CS.getInstruction();
440   int Bonus = 0;
441
442   // 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;
447
448   // 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;
456
457   // If this function uses the coldcc calling convention, prefer not to inline
458   // it.
459   if (Callee->getCallingConv() == CallingConv::Cold)
460     Bonus += InlineConstants::ColdccPenalty;
461
462   // 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));
473
474   return Bonus;
475 }
476
477 // getInlineCost - The heuristic used to determine if we should inline the
478 // function call or not.
479 //
480 InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
481                                SmallPtrSet<const Function*, 16> &NeverInline) {
482   return getInlineCost(CS, CS.getCalledFunction(), NeverInline);
483 }
484
485 InlineCost InlineCostAnalyzer::getInlineCost(CallSite CS,
486                                Function *Callee,
487                                SmallPtrSet<const Function*, 16> &NeverInline) {
488   Instruction *TheCall = CS.getInstruction();
489   Function *Caller = TheCall->getParent()->getParent();
490
491   // Don't inline functions which can be redefined at link-time to mean
492   // something else.  Don't inline functions marked noinline or call sites
493   // marked noinline.
494   if (Callee->mayBeOverridden() ||
495       Callee->hasFnAttr(Attribute::NoInline) || NeverInline.count(Callee) ||
496       CS.isNoInline())
497     return llvm::InlineCost::getNever();
498
499   // Get information about the callee.
500   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
501
502   // If we haven't calculated this information yet, do so now.
503   if (CalleeFI->Metrics.NumBlocks == 0)
504     CalleeFI->analyzeFunction(Callee, TD);
505
506   // If we should never inline this, return a huge cost.
507   if (CalleeFI->NeverInline())
508     return InlineCost::getNever();
509
510   // FIXME: It would be nice to kill off CalleeFI->NeverInline. Then we
511   // could move this up and avoid computing the FunctionInfo for
512   // 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();
516
517   if (CalleeFI->Metrics.usesDynamicAlloca) {
518     // Get information about the caller.
519     FunctionInfo &CallerFI = CachedFunctionInfo[Caller];
520
521     // If we haven't calculated this information yet, do so now.
522     if (CallerFI.Metrics.NumBlocks == 0) {
523       CallerFI.analyzeFunction(Caller, TD);
524
525       // Recompute the CalleeFI pointer, getting Caller could have invalidated
526       // it.
527       CalleeFI = &CachedFunctionInfo[Callee];
528     }
529
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.
533     if (!CallerFI.Metrics.usesDynamicAlloca)
534       return InlineCost::getNever();
535   }
536
537   // 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
539   // be inlined.  This value may go negative due to the fact that bonuses
540   // are negative numbers.
541   //
542   int InlineCost = getInlineSize(CS, Callee) + getInlineBonuses(CS, Callee);
543   return llvm::InlineCost::get(InlineCost);
544 }
545
546 // 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.
549 InlineCost 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();
556
557   // Get information about the callee.
558   FunctionInfo *CalleeFI = &CachedFunctionInfo[Callee];
559
560   // If we haven't calculated this information yet, do so now.
561   if (CalleeFI->Metrics.NumBlocks == 0)
562     CalleeFI->analyzeFunction(Callee, TD);
563
564   int Cost = 0;
565
566   // Look at the original size of the callee.  Each instruction counts as 5.
567   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)
573     Cost -= CalleeFI->ArgumentWeights[*an].ConstantWeight;
574
575   return llvm::InlineCost::get(Cost);
576 }
577
578 // getInlineFudgeFactor - Return a > 1.0 factor if the inliner should use a
579 // higher threshold to determine if the function call should be inlined.
580 float InlineCostAnalyzer::getInlineFudgeFactor(CallSite CS) {
581   Function *Callee = CS.getCalledFunction();
582
583   // Get information about the callee.
584   FunctionInfo &CalleeFI = CachedFunctionInfo[Callee];
585
586   // If we haven't calculated this information yet, do so now.
587   if (CalleeFI.Metrics.NumBlocks == 0)
588     CalleeFI.analyzeFunction(Callee, TD);
589
590   float Factor = 1.0f;
591   // Single BB functions are often written to be inlined.
592   if (CalleeFI.Metrics.NumBlocks == 1)
593     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.
597   if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/2)
598     Factor += 2.0f;
599   else if (CalleeFI.Metrics.NumVectorInsts > CalleeFI.Metrics.NumInsts/10)
600     Factor += 1.5f;
601   return Factor;
602 }
603
604 /// growCachedCostInfo - update the cached cost info for Caller after Callee has
605 /// been inlined.
606 void
607 InlineCostAnalyzer::growCachedCostInfo(Function *Caller, Function *Callee) {
608   CodeMetrics &CallerMetrics = CachedFunctionInfo[Caller].Metrics;
609
610   // For small functions we prefer to recalculate the cost for better accuracy.
611   if (CallerMetrics.NumBlocks < 10 && CallerMetrics.NumInsts < 1000) {
612     resetCachedCostInfo(Caller);
613     return;
614   }
615
616   // For large functions, we can save a lot of computation time by skipping
617   // recalculations.
618   if (CallerMetrics.NumCalls > 0)
619     --CallerMetrics.NumCalls;
620
621   if (Callee == 0) return;
622
623   CodeMetrics &CalleeMetrics = CachedFunctionInfo[Callee].Metrics;
624
625   // 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;
631   }
632
633   // Since CalleeMetrics were already calculated, we know that the CallerMetrics
634   // reference isn't invalidated: both were in the DenseMap.
635   CallerMetrics.usesDynamicAlloca |= CalleeMetrics.usesDynamicAlloca;
636
637   // 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.
639   CallerMetrics.exposesReturnsTwice |= CalleeMetrics.exposesReturnsTwice;
640   CallerMetrics.isRecursive |= CalleeMetrics.isRecursive;
641   CallerMetrics.containsIndirectBr |= CalleeMetrics.containsIndirectBr;
642
643   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;
654
655   // We are not updating the argument weights. We have already determined that
656   // Caller is a fairly large function, so we accept the loss of precision.
657 }
658
659 /// clear - empty the cache of inline costs
660 void InlineCostAnalyzer::clear() {
661   CachedFunctionInfo.clear();
662 }