OSDN Git Service

* ipa-inline-transform.c (save_inline_function_body): Add comments.
[pf3gnuchains/gcc-fork.git] / gcc / ipa-inline.c
1 /* Inlining decision heuristics.
2    Copyright (C) 2003, 2004, 2007, 2008, 2009, 2010, 2011
3    Free Software Foundation, Inc.
4    Contributed by Jan Hubicka
5
6 This file is part of GCC.
7
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 3, or (at your option) any later
11 version.
12
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
16 for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3.  If not see
20 <http://www.gnu.org/licenses/>.  */
21
22 /*  Inlining decision heuristics
23
24     The implementation of inliner is organized as follows:
25
26     inlining heuristics limits
27
28       can_inline_edge_p allow to check that particular inlining is allowed
29       by the limits specified by user (allowed function growth, growth and so
30       on).
31
32       Functions are inlined when it is obvious the result is profitable (such
33       as functions called once or when inlining reduce code size).
34       In addition to that we perform inlining of small functions and recursive
35       inlining.
36
37     inlining heuristics
38
39        The inliner itself is split into two passes:
40
41        pass_early_inlining
42
43          Simple local inlining pass inlining callees into current function.
44          This pass makes no use of whole unit analysis and thus it can do only
45          very simple decisions based on local properties.
46
47          The strength of the pass is that it is run in topological order
48          (reverse postorder) on the callgraph. Functions are converted into SSA
49          form just before this pass and optimized subsequently. As a result, the
50          callees of the function seen by the early inliner was already optimized
51          and results of early inlining adds a lot of optimization opportunities
52          for the local optimization.
53
54          The pass handle the obvious inlining decisions within the compilation
55          unit - inlining auto inline functions, inlining for size and
56          flattening.
57
58          main strength of the pass is the ability to eliminate abstraction
59          penalty in C++ code (via combination of inlining and early
60          optimization) and thus improve quality of analysis done by real IPA
61          optimizers.
62
63          Because of lack of whole unit knowledge, the pass can not really make
64          good code size/performance tradeoffs.  It however does very simple
65          speculative inlining allowing code size to grow by
66          EARLY_INLINING_INSNS when callee is leaf function.  In this case the
67          optimizations performed later are very likely to eliminate the cost.
68
69        pass_ipa_inline
70
71          This is the real inliner able to handle inlining with whole program
72          knowledge. It performs following steps:
73
74          1) inlining of small functions.  This is implemented by greedy
75          algorithm ordering all inlinable cgraph edges by their badness and
76          inlining them in this order as long as inline limits allows doing so.
77
78          This heuristics is not very good on inlining recursive calls. Recursive
79          calls can be inlined with results similar to loop unrolling. To do so,
80          special purpose recursive inliner is executed on function when
81          recursive edge is met as viable candidate.
82
83          2) Unreachable functions are removed from callgraph.  Inlining leads
84          to devirtualization and other modification of callgraph so functions
85          may become unreachable during the process. Also functions declared as
86          extern inline or virtual functions are removed, since after inlining
87          we no longer need the offline bodies.
88
89          3) Functions called once and not exported from the unit are inlined.
90          This should almost always lead to reduction of code size by eliminating
91          the need for offline copy of the function.  */
92
93 #include "config.h"
94 #include "system.h"
95 #include "coretypes.h"
96 #include "tm.h"
97 #include "tree.h"
98 #include "tree-inline.h"
99 #include "langhooks.h"
100 #include "flags.h"
101 #include "cgraph.h"
102 #include "diagnostic.h"
103 #include "gimple-pretty-print.h"
104 #include "timevar.h"
105 #include "params.h"
106 #include "fibheap.h"
107 #include "intl.h"
108 #include "tree-pass.h"
109 #include "coverage.h"
110 #include "ggc.h"
111 #include "rtl.h"
112 #include "tree-flow.h"
113 #include "ipa-prop.h"
114 #include "except.h"
115 #include "target.h"
116 #include "ipa-inline.h"
117
118 /* Statistics we collect about inlining algorithm.  */
119 static int overall_size;
120 static gcov_type max_count, max_benefit;
121
122 /* Return false when inlining edge E would lead to violating
123    limits on function unit growth or stack usage growth.  
124
125    The relative function body growth limit is present generally
126    to avoid problems with non-linear behavior of the compiler.
127    To allow inlining huge functions into tiny wrapper, the limit
128    is always based on the bigger of the two functions considered.
129
130    For stack growth limits we always base the growth in stack usage
131    of the callers.  We want to prevent applications from segfaulting
132    on stack overflow when functions with huge stack frames gets
133    inlined. */
134
135 static bool
136 caller_growth_limits (struct cgraph_edge *e)
137 {
138   struct cgraph_node *to = e->caller;
139   struct cgraph_node *what = e->callee;
140   int newsize;
141   int limit = 0;
142   HOST_WIDE_INT stack_size_limit = 0, inlined_stack;
143   struct inline_summary *info, *what_info, *outer_info = inline_summary (to);
144
145   /* Look for function e->caller is inlined to.  While doing
146      so work out the largest function body on the way.  As
147      described above, we want to base our function growth
148      limits based on that.  Not on the self size of the
149      outer function, not on the self size of inline code
150      we immediately inline to.  This is the most relaxed
151      interpretation of the rule "do not grow large functions
152      too much in order to prevent compiler from exploding".  */
153   do
154     {
155       info = inline_summary (to);
156       if (limit < info->self_size)
157         limit = info->self_size;
158       if (stack_size_limit < info->estimated_self_stack_size)
159         stack_size_limit = info->estimated_self_stack_size;
160       if (to->global.inlined_to)
161         to = to->callers->caller;
162     }
163   while (to->global.inlined_to);
164
165   what_info = inline_summary (what);
166
167   if (limit < what_info->self_size)
168     limit = what_info->self_size;
169
170   limit += limit * PARAM_VALUE (PARAM_LARGE_FUNCTION_GROWTH) / 100;
171
172   /* Check the size after inlining against the function limits.  But allow
173      the function to shrink if it went over the limits by forced inlining.  */
174   newsize = estimate_size_after_inlining (to, e);
175   if (newsize >= info->size
176       && newsize > PARAM_VALUE (PARAM_LARGE_FUNCTION_INSNS)
177       && newsize > limit)
178     {
179       e->inline_failed = CIF_LARGE_FUNCTION_GROWTH_LIMIT;
180       return false;
181     }
182
183   /* FIXME: Stack size limit often prevents inlining in Fortran programs
184      due to large i/o datastructures used by the Fortran front-end.
185      We ought to ignore this limit when we know that the edge is executed
186      on every invocation of the caller (i.e. its call statement dominates
187      exit block).  We do not track this information, yet.  */
188   stack_size_limit += (stack_size_limit
189                        * PARAM_VALUE (PARAM_STACK_FRAME_GROWTH) / 100);
190
191   inlined_stack = (outer_info->stack_frame_offset
192                    + outer_info->estimated_self_stack_size
193                    + what_info->estimated_stack_size);
194   /* Check new stack consumption with stack consumption at the place
195      stack is used.  */
196   if (inlined_stack > stack_size_limit
197       /* If function already has large stack usage from sibling
198          inline call, we can inline, too.
199          This bit overoptimistically assume that we are good at stack
200          packing.  */
201       && inlined_stack > info->estimated_stack_size
202       && inlined_stack > PARAM_VALUE (PARAM_LARGE_STACK_FRAME))
203     {
204       e->inline_failed = CIF_LARGE_STACK_FRAME_GROWTH_LIMIT;
205       return false;
206     }
207   return true;
208 }
209
210 /* Dump info about why inlining has failed.  */
211
212 static void
213 report_inline_failed_reason (struct cgraph_edge *e)
214 {
215   if (dump_file)
216     {
217       fprintf (dump_file, "  not inlinable: %s/%i -> %s/%i, %s\n",
218                cgraph_node_name (e->caller), e->caller->uid,
219                cgraph_node_name (e->callee), e->callee->uid,
220                cgraph_inline_failed_string (e->inline_failed));
221     }
222 }
223
224 /* Decide if we can inline the edge and possibly update
225    inline_failed reason.  
226    We check whether inlining is possible at all and whether
227    caller growth limits allow doing so.  
228
229    if REPORT is true, output reason to the dump file.  */
230
231 static bool
232 can_inline_edge_p (struct cgraph_edge *e, bool report)
233 {
234   bool inlinable = true;
235   tree caller_tree = DECL_FUNCTION_SPECIFIC_OPTIMIZATION (e->caller->decl);
236   tree callee_tree = DECL_FUNCTION_SPECIFIC_OPTIMIZATION (e->callee->decl);
237
238   gcc_assert (e->inline_failed);
239
240   if (!e->callee->analyzed)
241     {
242       e->inline_failed = CIF_BODY_NOT_AVAILABLE;
243       inlinable = false;
244     }
245   else if (!inline_summary (e->callee)->inlinable)
246     {
247       e->inline_failed = CIF_FUNCTION_NOT_INLINABLE;
248       inlinable = false;
249     }
250   else if (cgraph_function_body_availability (e->callee) <= AVAIL_OVERWRITABLE)
251     {
252       e->inline_failed = CIF_OVERWRITABLE;
253       return false;
254     }
255   else if (e->call_stmt_cannot_inline_p)
256     {
257       e->inline_failed = CIF_MISMATCHED_ARGUMENTS;
258       inlinable = false;
259     }
260   /* Don't inline if the functions have different EH personalities.  */
261   else if (DECL_FUNCTION_PERSONALITY (e->caller->decl)
262            && DECL_FUNCTION_PERSONALITY (e->callee->decl)
263            && (DECL_FUNCTION_PERSONALITY (e->caller->decl)
264                != DECL_FUNCTION_PERSONALITY (e->callee->decl)))
265     {
266       e->inline_failed = CIF_EH_PERSONALITY;
267       inlinable = false;
268     }
269   /* Don't inline if the callee can throw non-call exceptions but the
270      caller cannot.
271      FIXME: this is obviously wrong for LTO where STRUCT_FUNCTION is missing.
272      Move the flag into cgraph node or mirror it in the inline summary.  */
273   else if (DECL_STRUCT_FUNCTION (e->callee->decl)
274            && DECL_STRUCT_FUNCTION (e->callee->decl)->can_throw_non_call_exceptions
275            && !(DECL_STRUCT_FUNCTION (e->caller->decl)
276                 && DECL_STRUCT_FUNCTION (e->caller->decl)->can_throw_non_call_exceptions))
277     {
278       e->inline_failed = CIF_NON_CALL_EXCEPTIONS;
279       inlinable = false;
280     }
281   /* Check compatibility of target optimization options.  */
282   else if (!targetm.target_option.can_inline_p (e->caller->decl,
283                                                 e->callee->decl))
284     {
285       e->inline_failed = CIF_TARGET_OPTION_MISMATCH;
286       inlinable = false;
287     }
288   /* Check if caller growth allows the inlining.  */
289   else if (!DECL_DISREGARD_INLINE_LIMITS (e->callee->decl)
290            && !caller_growth_limits (e))
291     inlinable = false;
292   /* Don't inline a function with a higher optimization level than the
293      caller.  FIXME: this is really just tip of iceberg of handling
294      optimization attribute.  */
295   else if (caller_tree != callee_tree)
296     {
297       struct cl_optimization *caller_opt
298         = TREE_OPTIMIZATION ((caller_tree)
299                              ? caller_tree
300                              : optimization_default_node);
301
302       struct cl_optimization *callee_opt
303         = TREE_OPTIMIZATION ((callee_tree)
304                              ? callee_tree
305                              : optimization_default_node);
306
307       if ((caller_opt->x_optimize > callee_opt->x_optimize)
308           || (caller_opt->x_optimize_size != callee_opt->x_optimize_size))
309         {
310           e->inline_failed = CIF_TARGET_OPTIMIZATION_MISMATCH;
311           inlinable = false;
312         }
313     }
314
315   /* Be sure that the cannot_inline_p flag is up to date.  */
316   gcc_checking_assert (!e->call_stmt
317                        || (gimple_call_cannot_inline_p (e->call_stmt)
318                            == e->call_stmt_cannot_inline_p)
319                        /* In -flto-partition=none mode we really keep things out of
320                           sync because call_stmt_cannot_inline_p is set at cgraph
321                           merging when function bodies are not there yet.  */
322                        || (in_lto_p && !gimple_call_cannot_inline_p (e->call_stmt)));
323   if (!inlinable && report)
324     report_inline_failed_reason (e);
325   return inlinable;
326 }
327
328
329 /* Return true if the edge E is inlinable during early inlining.  */
330
331 static bool
332 can_early_inline_edge_p (struct cgraph_edge *e)
333 {
334   /* Early inliner might get called at WPA stage when IPA pass adds new
335      function.  In this case we can not really do any of early inlining
336      because function bodies are missing.  */
337   if (!gimple_has_body_p (e->callee->decl))
338     {
339       e->inline_failed = CIF_BODY_NOT_AVAILABLE;
340       return false;
341     }
342   /* In early inliner some of callees may not be in SSA form yet
343      (i.e. the callgraph is cyclic and we did not process
344      the callee by early inliner, yet).  We don't have CIF code for this
345      case; later we will re-do the decision in the real inliner.  */
346   if (!gimple_in_ssa_p (DECL_STRUCT_FUNCTION (e->caller->decl))
347       || !gimple_in_ssa_p (DECL_STRUCT_FUNCTION (e->callee->decl)))
348     {
349       if (dump_file)
350         fprintf (dump_file, "  edge not inlinable: not in SSA form\n");
351       return false;
352     }
353   if (!can_inline_edge_p (e, true))
354     return false;
355   return true;
356 }
357
358
359 /* Return true when N is leaf function.  Accept cheap builtins
360    in leaf functions.  */
361
362 static bool
363 leaf_node_p (struct cgraph_node *n)
364 {
365   struct cgraph_edge *e;
366   for (e = n->callees; e; e = e->next_callee)
367     if (!is_inexpensive_builtin (e->callee->decl))
368       return false;
369   return true;
370 }
371
372
373 /* Return true if we are interested in inlining small function.  */
374
375 static bool
376 want_early_inline_function_p (struct cgraph_edge *e)
377 {
378   bool want_inline = true;
379
380   if (DECL_DISREGARD_INLINE_LIMITS (e->callee->decl))
381     ;
382   else if (!DECL_DECLARED_INLINE_P (e->callee->decl)
383            && !flag_inline_small_functions)
384     {
385       e->inline_failed = CIF_FUNCTION_NOT_INLINE_CANDIDATE;
386       report_inline_failed_reason (e);
387       want_inline = false;
388     }
389   else
390     {
391       int growth = estimate_edge_growth (e);
392       if (growth <= 0)
393         ;
394       else if (!cgraph_maybe_hot_edge_p (e)
395                && growth > 0)
396         {
397           if (dump_file)
398             fprintf (dump_file, "  will not early inline: %s/%i->%s/%i, "
399                      "call is cold and code would grow by %i\n",
400                      cgraph_node_name (e->caller), e->caller->uid,
401                      cgraph_node_name (e->callee), e->callee->uid,
402                      growth);
403           want_inline = false;
404         }
405       else if (!leaf_node_p (e->callee)
406                && growth > 0)
407         {
408           if (dump_file)
409             fprintf (dump_file, "  will not early inline: %s/%i->%s/%i, "
410                      "callee is not leaf and code would grow by %i\n",
411                      cgraph_node_name (e->caller), e->caller->uid,
412                      cgraph_node_name (e->callee), e->callee->uid,
413                      growth);
414           want_inline = false;
415         }
416       else if (growth > PARAM_VALUE (PARAM_EARLY_INLINING_INSNS))
417         {
418           if (dump_file)
419             fprintf (dump_file, "  will not early inline: %s/%i->%s/%i, "
420                      "growth %i exceeds --param early-inlining-insns\n",
421                      cgraph_node_name (e->caller), e->caller->uid,
422                      cgraph_node_name (e->callee), e->callee->uid,
423                      growth);
424           want_inline = false;
425         }
426     }
427   return want_inline;
428 }
429
430 /* Return true if we are interested in inlining small function.
431    When REPORT is true, report reason to dump file.  */
432
433 static bool
434 want_inline_small_function_p (struct cgraph_edge *e, bool report)
435 {
436   bool want_inline = true;
437
438   if (DECL_DISREGARD_INLINE_LIMITS (e->callee->decl))
439     ;
440   else if (!DECL_DECLARED_INLINE_P (e->callee->decl)
441            && !flag_inline_small_functions)
442     {
443       e->inline_failed = CIF_FUNCTION_NOT_INLINE_CANDIDATE;
444       want_inline = false;
445     }
446   else
447     {
448       int growth = estimate_edge_growth (e);
449
450       if (growth <= 0)
451         ;
452       else if (DECL_DECLARED_INLINE_P (e->callee->decl)
453                && growth >= MAX_INLINE_INSNS_SINGLE)
454         {
455           e->inline_failed = CIF_MAX_INLINE_INSNS_SINGLE_LIMIT;
456           want_inline = false;
457         }
458       else if (!DECL_DECLARED_INLINE_P (e->callee->decl)
459                && !flag_inline_functions)
460         {
461           e->inline_failed = CIF_NOT_DECLARED_INLINED;
462           want_inline = false;
463         }
464       else if (!DECL_DECLARED_INLINE_P (e->callee->decl)
465                && growth >= MAX_INLINE_INSNS_AUTO)
466         {
467           e->inline_failed = CIF_MAX_INLINE_INSNS_AUTO_LIMIT;
468           want_inline = false;
469         }
470       else if (!cgraph_maybe_hot_edge_p (e)
471                && estimate_growth (e->callee) > 0)
472         {
473           e->inline_failed = CIF_UNLIKELY_CALL;
474           want_inline = false;
475         }
476     }
477   if (!want_inline && report)
478     report_inline_failed_reason (e);
479   return want_inline;
480 }
481
482 /* EDGE is self recursive edge.
483    We hand two cases - when function A is inlining into itself
484    or when function A is being inlined into another inliner copy of function
485    A within function B.  
486
487    In first case OUTER_NODE points to the toplevel copy of A, while
488    in the second case OUTER_NODE points to the outermost copy of A in B.
489
490    In both cases we want to be extra selective since
491    inlining the call will just introduce new recursive calls to appear.  */
492
493 static bool
494 want_inline_self_recursive_call_p (struct cgraph_edge *edge,
495                                    struct cgraph_node *outer_node,
496                                    bool peeling,
497                                    int depth)
498 {
499   char const *reason = NULL;
500   bool want_inline = true;
501   int caller_freq = CGRAPH_FREQ_BASE;
502   int max_depth = PARAM_VALUE (PARAM_MAX_INLINE_RECURSIVE_DEPTH_AUTO);
503
504   if (DECL_DECLARED_INLINE_P (edge->callee->decl))
505     max_depth = PARAM_VALUE (PARAM_MAX_INLINE_RECURSIVE_DEPTH);
506
507   if (!cgraph_maybe_hot_edge_p (edge))
508     {
509       reason = "recursive call is cold";
510       want_inline = false;
511     }
512   else if (max_count && !outer_node->count)
513     {
514       reason = "not executed in profile";
515       want_inline = false;
516     }
517   else if (depth > max_depth)
518     {
519       reason = "--param max-inline-recursive-depth exceeded.";
520       want_inline = false;
521     }
522
523   if (outer_node->global.inlined_to)
524     caller_freq = outer_node->callers->frequency;
525
526   if (!want_inline)
527     ;
528   /* Inlining of self recursive function into copy of itself within other function
529      is transformation similar to loop peeling.
530
531      Peeling is profitable if we can inline enough copies to make probability
532      of actual call to the self recursive function very small.  Be sure that
533      the probability of recursion is small.
534
535      We ensure that the frequency of recursing is at most 1 - (1/max_depth).
536      This way the expected number of recision is at most max_depth.  */
537   else if (peeling)
538     {
539       int max_prob = CGRAPH_FREQ_BASE - ((CGRAPH_FREQ_BASE + max_depth - 1)
540                                          / max_depth);
541       int i;
542       for (i = 1; i < depth; i++)
543         max_prob = max_prob * max_prob / CGRAPH_FREQ_BASE;
544       if (max_count
545           && (edge->count * CGRAPH_FREQ_BASE / outer_node->count
546               >= max_prob))
547         {
548           reason = "profile of recursive call is too large";
549           want_inline = false;
550         }
551       if (!max_count
552           && (edge->frequency * CGRAPH_FREQ_BASE / caller_freq
553               >= max_prob))
554         {
555           reason = "frequency of recursive call is too large";
556           want_inline = false;
557         }
558     }
559   /* Recursive inlining, i.e. equivalent of unrolling, is profitable if recursion
560      depth is large.  We reduce function call overhead and increase chances that
561      things fit in hardware return predictor.
562
563      Recursive inlining might however increase cost of stack frame setup
564      actually slowing down functions whose recursion tree is wide rather than
565      deep.
566
567      Deciding reliably on when to do recursive inlining without profile feedback
568      is tricky.  For now we disable recursive inlining when probability of self
569      recursion is low. 
570
571      Recursive inlining of self recursive call within loop also results in large loop
572      depths that generally optimize badly.  We may want to throttle down inlining
573      in those cases.  In particular this seems to happen in one of libstdc++ rb tree
574      methods.  */
575   else
576     {
577       if (max_count
578           && (edge->count * 100 / outer_node->count
579               <= PARAM_VALUE (PARAM_MIN_INLINE_RECURSIVE_PROBABILITY)))
580         {
581           reason = "profile of recursive call is too small";
582           want_inline = false;
583         }
584       else if (!max_count
585                && (edge->frequency * 100 / caller_freq
586                    <= PARAM_VALUE (PARAM_MIN_INLINE_RECURSIVE_PROBABILITY)))
587         {
588           reason = "frequency of recursive call is too small";
589           want_inline = false;
590         }
591     }
592   if (!want_inline && dump_file)
593     fprintf (dump_file, "   not inlining recursively: %s\n", reason);
594   return want_inline;
595 }
596
597
598 /* Decide if NODE is called once inlining it would eliminate need
599    for the offline copy of function.  */
600
601 static bool
602 want_inline_function_called_once_p (struct cgraph_node *node)
603 {
604    /* Already inlined?  */
605    if (node->global.inlined_to)
606      return false;
607    /* Zero or more then one callers?  */
608    if (!node->callers
609        || node->callers->next_caller)
610      return false;
611    /* Recursive call makes no sense to inline.  */
612    if (node->callers->caller == node)
613      return false;
614    /* External functions are not really in the unit, so inlining
615       them when called once would just increase the program size.  */
616    if (DECL_EXTERNAL (node->decl))
617      return false;
618    /* Offline body must be optimized out.  */
619    if (!cgraph_will_be_removed_from_program_if_no_direct_calls (node))
620      return false;
621    if (!can_inline_edge_p (node->callers, true))
622      return false;
623    return true;
624 }
625
626 /* A cost model driving the inlining heuristics in a way so the edges with
627    smallest badness are inlined first.  After each inlining is performed
628    the costs of all caller edges of nodes affected are recomputed so the
629    metrics may accurately depend on values such as number of inlinable callers
630    of the function or function body size.  */
631
632 static int
633 edge_badness (struct cgraph_edge *edge, bool dump)
634 {
635   gcov_type badness;
636   int growth;
637   struct inline_summary *callee_info = inline_summary (edge->callee);
638
639   if (DECL_DISREGARD_INLINE_LIMITS (edge->callee->decl))
640     return INT_MIN;
641
642   growth = estimate_edge_growth (edge);
643
644   if (dump)
645     {
646       fprintf (dump_file, "    Badness calculation for %s -> %s\n",
647                cgraph_node_name (edge->caller),
648                cgraph_node_name (edge->callee));
649       fprintf (dump_file, "      growth %i, time %i-%i, size %i-%i\n",
650                growth,
651                callee_info->time,
652                callee_info->time_inlining_benefit
653                + edge->call_stmt_time,
654                callee_info->size,
655                callee_info->size_inlining_benefit
656                + edge->call_stmt_size);
657     }
658
659   /* Always prefer inlining saving code size.  */
660   if (growth <= 0)
661     {
662       badness = INT_MIN - growth;
663       if (dump)
664         fprintf (dump_file, "      %i: Growth %i < 0\n", (int) badness,
665                  growth);
666     }
667
668   /* When profiling is available, base priorities -(#calls / growth).
669      So we optimize for overall number of "executed" inlined calls.  */
670   else if (max_count)
671     {
672       badness =
673         ((int)
674          ((double) edge->count * INT_MIN / max_count / (max_benefit + 1)) *
675          (callee_info->time_inlining_benefit
676           + edge->call_stmt_time + 1)) / growth;
677       
678       /* Be sure that insanity of the profile won't lead to increasing counts
679          in the scalling and thus to overflow in the computation above.  */
680       gcc_assert (max_count >= edge->count);
681       if (dump)
682         {
683           fprintf (dump_file,
684                    "      %i (relative %f): profile info. Relative count %f"
685                    " * Relative benefit %f\n",
686                    (int) badness, (double) badness / INT_MIN,
687                    (double) edge->count / max_count,
688                    (double) (inline_summary (edge->callee)->
689                              time_inlining_benefit
690                              + edge->call_stmt_time + 1) / (max_benefit + 1));
691         }
692     }
693
694   /* When function local profile is available, base priorities on
695      growth / frequency, so we optimize for overall frequency of inlined
696      calls.  This is not too accurate since while the call might be frequent
697      within function, the function itself is infrequent.
698
699      Other objective to optimize for is number of different calls inlined.
700      We add the estimated growth after inlining all functions to bias the
701      priorities slightly in this direction (so fewer times called functions
702      of the same size gets priority).  */
703   else if (flag_guess_branch_prob)
704     {
705       int div = edge->frequency * 100 / CGRAPH_FREQ_BASE + 1;
706       int benefitperc;
707       int growth_for_all;
708       badness = growth * 10000;
709       benefitperc =
710         100 * (callee_info->time_inlining_benefit
711                + edge->call_stmt_time)
712             / (callee_info->time + 1) + 1;
713       benefitperc = MIN (benefitperc, 100);
714       div *= benefitperc;
715
716       /* Decrease badness if call is nested.  */
717       /* Compress the range so we don't overflow.  */
718       if (div > 10000)
719         div = 10000 + ceil_log2 (div) - 8;
720       if (div < 1)
721         div = 1;
722       if (badness > 0)
723         badness /= div;
724       growth_for_all = estimate_growth (edge->callee);
725       badness += growth_for_all;
726       if (badness > INT_MAX)
727         badness = INT_MAX;
728       if (dump)
729         {
730           fprintf (dump_file,
731                    "      %i: guessed profile. frequency %i, overall growth %i,"
732                    " benefit %i%%, divisor %i\n",
733                    (int) badness, edge->frequency, growth_for_all,
734                    benefitperc, div);
735         }
736     }
737   /* When function local profile is not available or it does not give
738      useful information (ie frequency is zero), base the cost on
739      loop nest and overall size growth, so we optimize for overall number
740      of functions fully inlined in program.  */
741   else
742     {
743       int nest = MIN (edge->loop_nest, 8);
744       badness = estimate_growth (edge->callee) * 256;
745
746       /* Decrease badness if call is nested.  */
747       if (badness > 0)
748         badness >>= nest;
749       else
750         {
751           badness <<= nest;
752         }
753       if (dump)
754         fprintf (dump_file, "      %i: no profile. nest %i\n", (int) badness,
755                  nest);
756     }
757
758   /* Ensure that we did not overflow in all the fixed point math above.  */
759   gcc_assert (badness >= INT_MIN);
760   gcc_assert (badness <= INT_MAX - 1);
761   /* Make recursive inlining happen always after other inlining is done.  */
762   if (cgraph_edge_recursive_p (edge))
763     return badness + 1;
764   else
765     return badness;
766 }
767
768 /* Recompute badness of EDGE and update its key in HEAP if needed.  */
769 static inline void
770 update_edge_key (fibheap_t heap, struct cgraph_edge *edge)
771 {
772   int badness = edge_badness (edge, false);
773   if (edge->aux)
774     {
775       fibnode_t n = (fibnode_t) edge->aux;
776       gcc_checking_assert (n->data == edge);
777
778       /* fibheap_replace_key only decrease the keys.
779          When we increase the key we do not update heap
780          and instead re-insert the element once it becomes
781          a minimum of heap.  */
782       if (badness < n->key)
783         {
784           fibheap_replace_key (heap, n, badness);
785           if (dump_file && (dump_flags & TDF_DETAILS))
786             {
787               fprintf (dump_file,
788                        "  decreasing badness %s/%i -> %s/%i, %i to %i\n",
789                        cgraph_node_name (edge->caller), edge->caller->uid,
790                        cgraph_node_name (edge->callee), edge->callee->uid,
791                        (int)n->key,
792                        badness);
793             }
794           gcc_checking_assert (n->key == badness);
795         }
796     }
797   else
798     {
799        if (dump_file && (dump_flags & TDF_DETAILS))
800          {
801            fprintf (dump_file,
802                     "  enqueuing call %s/%i -> %s/%i, badness %i\n",
803                     cgraph_node_name (edge->caller), edge->caller->uid,
804                     cgraph_node_name (edge->callee), edge->callee->uid,
805                     badness);
806          }
807       edge->aux = fibheap_insert (heap, badness, edge);
808     }
809 }
810
811 /* Recompute heap nodes for each of caller edge.  */
812
813 static void
814 update_caller_keys (fibheap_t heap, struct cgraph_node *node,
815                     bitmap updated_nodes)
816 {
817   struct cgraph_edge *edge;
818
819   if (!inline_summary (node)->inlinable
820       || cgraph_function_body_availability (node) <= AVAIL_OVERWRITABLE
821       || node->global.inlined_to)
822     return;
823   if (!bitmap_set_bit (updated_nodes, node->uid))
824     return;
825   inline_summary (node)->estimated_growth = INT_MIN;
826
827   /* See if there is something to do.  */
828   for (edge = node->callers; edge; edge = edge->next_caller)
829     if (edge->inline_failed)
830       break;
831   if (!edge)
832     return;
833
834   for (; edge; edge = edge->next_caller)
835     if (edge->inline_failed)
836       {
837         if (can_inline_edge_p (edge, false)
838             && want_inline_small_function_p (edge, false))
839           update_edge_key (heap, edge);
840         else if (edge->aux)
841           {
842             report_inline_failed_reason (edge);
843             fibheap_delete_node (heap, (fibnode_t) edge->aux);
844             edge->aux = NULL;
845           }
846       }
847 }
848
849 /* Recompute heap nodes for each uninlined call.
850    This is used when we know that edge badnesses are going only to increase
851    (we introduced new call site) and thus all we need is to insert newly
852    created edges into heap.  */
853
854 static void
855 update_callee_keys (fibheap_t heap, struct cgraph_node *node,
856                     bitmap updated_nodes)
857 {
858   struct cgraph_edge *e = node->callees;
859
860   inline_summary (node)->estimated_growth = INT_MIN;
861
862   if (!e)
863     return;
864   while (true)
865     if (!e->inline_failed && e->callee->callees)
866       e = e->callee->callees;
867     else
868       {
869         if (e->inline_failed
870             && inline_summary (e->callee)->inlinable
871             && cgraph_function_body_availability (e->callee) >= AVAIL_AVAILABLE
872             && !bitmap_bit_p (updated_nodes, e->callee->uid))
873           {
874             inline_summary (node)->estimated_growth = INT_MIN;
875             update_edge_key (heap, e);
876           }
877         if (e->next_callee)
878           e = e->next_callee;
879         else
880           {
881             do
882               {
883                 if (e->caller == node)
884                   return;
885                 e = e->caller->callers;
886               }
887             while (!e->next_callee);
888             e = e->next_callee;
889           }
890       }
891 }
892
893 /* Recompute heap nodes for each of caller edges of each of callees.
894    Walk recursively into all inline clones.  */
895
896 static void
897 update_all_callee_keys (fibheap_t heap, struct cgraph_node *node,
898                         bitmap updated_nodes)
899 {
900   struct cgraph_edge *e = node->callees;
901
902   inline_summary (node)->estimated_growth = INT_MIN;
903
904   if (!e)
905     return;
906   while (true)
907     if (!e->inline_failed && e->callee->callees)
908       e = e->callee->callees;
909     else
910       {
911         if (e->inline_failed)
912           update_caller_keys (heap, e->callee, updated_nodes);
913         if (e->next_callee)
914           e = e->next_callee;
915         else
916           {
917             do
918               {
919                 if (e->caller == node)
920                   return;
921                 e = e->caller->callers;
922               }
923             while (!e->next_callee);
924             e = e->next_callee;
925           }
926       }
927 }
928
929 /* Enqueue all recursive calls from NODE into priority queue depending on
930    how likely we want to recursively inline the call.  */
931
932 static void
933 lookup_recursive_calls (struct cgraph_node *node, struct cgraph_node *where,
934                         fibheap_t heap)
935 {
936   struct cgraph_edge *e;
937   for (e = where->callees; e; e = e->next_callee)
938     if (e->callee == node)
939       {
940         /* When profile feedback is available, prioritize by expected number
941            of calls.  */
942         fibheap_insert (heap,
943                         !max_count ? -e->frequency
944                         : -(e->count / ((max_count + (1<<24) - 1) / (1<<24))),
945                         e);
946       }
947   for (e = where->callees; e; e = e->next_callee)
948     if (!e->inline_failed)
949       lookup_recursive_calls (node, e->callee, heap);
950 }
951
952 /* Decide on recursive inlining: in the case function has recursive calls,
953    inline until body size reaches given argument.  If any new indirect edges
954    are discovered in the process, add them to *NEW_EDGES, unless NEW_EDGES
955    is NULL.  */
956
957 static bool
958 recursive_inlining (struct cgraph_edge *edge,
959                     VEC (cgraph_edge_p, heap) **new_edges)
960 {
961   int limit = PARAM_VALUE (PARAM_MAX_INLINE_INSNS_RECURSIVE_AUTO);
962   fibheap_t heap;
963   struct cgraph_node *node;
964   struct cgraph_edge *e;
965   struct cgraph_node *master_clone = NULL, *next;
966   int depth = 0;
967   int n = 0;
968
969   node = edge->caller;
970   if (node->global.inlined_to)
971     node = node->global.inlined_to;
972
973   if (DECL_DECLARED_INLINE_P (node->decl))
974     limit = PARAM_VALUE (PARAM_MAX_INLINE_INSNS_RECURSIVE);
975
976   /* Make sure that function is small enough to be considered for inlining.  */
977   if (estimate_size_after_inlining (node, edge)  >= limit)
978     return false;
979   heap = fibheap_new ();
980   lookup_recursive_calls (node, node, heap);
981   if (fibheap_empty (heap))
982     {
983       fibheap_delete (heap);
984       return false;
985     }
986
987   if (dump_file)
988     fprintf (dump_file,
989              "  Performing recursive inlining on %s\n",
990              cgraph_node_name (node));
991
992   /* Do the inlining and update list of recursive call during process.  */
993   while (!fibheap_empty (heap))
994     {
995       struct cgraph_edge *curr
996         = (struct cgraph_edge *) fibheap_extract_min (heap);
997       struct cgraph_node *cnode;
998
999       if (estimate_size_after_inlining (node, curr) > limit)
1000         break;
1001
1002       if (!can_inline_edge_p (curr, true))
1003         continue;
1004
1005       depth = 1;
1006       for (cnode = curr->caller;
1007            cnode->global.inlined_to; cnode = cnode->callers->caller)
1008         if (node->decl == curr->callee->decl)
1009           depth++;
1010
1011       if (!want_inline_self_recursive_call_p (curr, node, false, depth))
1012         continue;
1013
1014       if (dump_file)
1015         {
1016           fprintf (dump_file,
1017                    "   Inlining call of depth %i", depth);
1018           if (node->count)
1019             {
1020               fprintf (dump_file, " called approx. %.2f times per call",
1021                        (double)curr->count / node->count);
1022             }
1023           fprintf (dump_file, "\n");
1024         }
1025       if (!master_clone)
1026         {
1027           /* We need original clone to copy around.  */
1028           master_clone = cgraph_clone_node (node, node->decl,
1029                                             node->count, CGRAPH_FREQ_BASE, 1,
1030                                             false, NULL);
1031           for (e = master_clone->callees; e; e = e->next_callee)
1032             if (!e->inline_failed)
1033               clone_inlined_nodes (e, true, false, NULL);
1034         }
1035
1036       cgraph_redirect_edge_callee (curr, master_clone);
1037       inline_call (curr, false, new_edges, &overall_size);
1038       lookup_recursive_calls (node, curr->callee, heap);
1039       n++;
1040     }
1041
1042   if (!fibheap_empty (heap) && dump_file)
1043     fprintf (dump_file, "    Recursive inlining growth limit met.\n");
1044   fibheap_delete (heap);
1045
1046   if (!master_clone)
1047     return false;
1048
1049   if (dump_file)
1050     fprintf (dump_file,
1051              "\n   Inlined %i times, "
1052              "body grown from size %i to %i, time %i to %i\n", n,
1053              inline_summary (master_clone)->size, inline_summary (node)->size,
1054              inline_summary (master_clone)->time, inline_summary (node)->time);
1055
1056   /* Remove master clone we used for inlining.  We rely that clones inlined
1057      into master clone gets queued just before master clone so we don't
1058      need recursion.  */
1059   for (node = cgraph_nodes; node != master_clone;
1060        node = next)
1061     {
1062       next = node->next;
1063       if (node->global.inlined_to == master_clone)
1064         cgraph_remove_node (node);
1065     }
1066   cgraph_remove_node (master_clone);
1067   return true;
1068 }
1069
1070
1071 /* Given whole compilation unit estimate of INSNS, compute how large we can
1072    allow the unit to grow.  */
1073
1074 static int
1075 compute_max_insns (int insns)
1076 {
1077   int max_insns = insns;
1078   if (max_insns < PARAM_VALUE (PARAM_LARGE_UNIT_INSNS))
1079     max_insns = PARAM_VALUE (PARAM_LARGE_UNIT_INSNS);
1080
1081   return ((HOST_WIDEST_INT) max_insns
1082           * (100 + PARAM_VALUE (PARAM_INLINE_UNIT_GROWTH)) / 100);
1083 }
1084
1085
1086 /* Compute badness of all edges in NEW_EDGES and add them to the HEAP.  */
1087
1088 static void
1089 add_new_edges_to_heap (fibheap_t heap, VEC (cgraph_edge_p, heap) *new_edges)
1090 {
1091   while (VEC_length (cgraph_edge_p, new_edges) > 0)
1092     {
1093       struct cgraph_edge *edge = VEC_pop (cgraph_edge_p, new_edges);
1094
1095       gcc_assert (!edge->aux);
1096       if (inline_summary (edge->callee)->inlinable
1097           && edge->inline_failed
1098           && can_inline_edge_p (edge, true)
1099           && want_inline_small_function_p (edge, true))
1100         edge->aux = fibheap_insert (heap, edge_badness (edge, false), edge);
1101     }
1102 }
1103
1104
1105 /* We use greedy algorithm for inlining of small functions:
1106    All inline candidates are put into prioritized heap ordered in
1107    increasing badness.
1108
1109    The inlining of small functions is bounded by unit growth parameters.  */
1110
1111 static void
1112 inline_small_functions (void)
1113 {
1114   struct cgraph_node *node;
1115   struct cgraph_edge *edge;
1116   fibheap_t heap = fibheap_new ();
1117   bitmap updated_nodes = BITMAP_ALLOC (NULL);
1118   int min_size, max_size;
1119   VEC (cgraph_edge_p, heap) *new_indirect_edges = NULL;
1120   int initial_size = 0;
1121
1122   if (flag_indirect_inlining)
1123     new_indirect_edges = VEC_alloc (cgraph_edge_p, heap, 8);
1124
1125   if (dump_file)
1126     fprintf (dump_file,
1127              "\nDeciding on inlining of small functions.  Starting with size %i.\n",
1128              initial_size);
1129
1130   /* Compute overall unit size and other global parameters used by badness
1131      metrics.  */
1132
1133   max_count = 0;
1134   max_benefit = 0;
1135
1136   for (node = cgraph_nodes; node; node = node->next)
1137     if (node->analyzed
1138         && !node->global.inlined_to)
1139       {
1140         struct inline_summary *info = inline_summary (node);
1141
1142         info->estimated_growth = INT_MIN;
1143
1144         if (!DECL_EXTERNAL (node->decl))
1145           initial_size += info->size;
1146
1147         for (edge = node->callers; edge; edge = edge->next_caller)
1148           {
1149             int benefit = (info->time_inlining_benefit
1150                            + edge->call_stmt_time);
1151             if (max_count < edge->count)
1152               max_count = edge->count;
1153             if (max_benefit < benefit)
1154               max_benefit = benefit;
1155            }
1156       }
1157
1158   overall_size = initial_size;
1159   max_size = compute_max_insns (overall_size);
1160   min_size = overall_size;
1161
1162   /* Populate the heeap with all edges we might inline.  */
1163
1164   for (node = cgraph_nodes; node; node = node->next)
1165     if (node->analyzed
1166         && !node->global.inlined_to)
1167       {
1168         if (dump_file)
1169           fprintf (dump_file, "Enqueueing calls of %s/%i.\n",
1170                    cgraph_node_name (node), node->uid);
1171
1172         for (edge = node->callers; edge; edge = edge->next_caller)
1173           if (edge->inline_failed
1174               && can_inline_edge_p (edge, true)
1175               && want_inline_small_function_p (edge, true)
1176               && edge->inline_failed)
1177             {
1178               gcc_assert (!edge->aux);
1179               update_edge_key (heap, edge);
1180             }
1181       }
1182
1183   gcc_assert (in_lto_p
1184               || !max_count
1185               || (profile_info && flag_branch_probabilities));
1186
1187   while (!fibheap_empty (heap))
1188     {
1189       int old_size = overall_size;
1190       struct cgraph_node *where, *callee;
1191       int badness = fibheap_min_key (heap);
1192       int current_badness;
1193       int growth;
1194
1195       edge = (struct cgraph_edge *) fibheap_extract_min (heap);
1196       gcc_assert (edge->aux);
1197       edge->aux = NULL;
1198       if (!edge->inline_failed)
1199         continue;
1200
1201       /* When updating the edge costs, we only decrease badness in the keys.
1202          Increases of badness are handled lazilly; when we see key with out
1203          of date value on it, we re-insert it now.  */
1204       current_badness = edge_badness (edge, false);
1205       gcc_assert (current_badness >= badness);
1206       if (current_badness != badness)
1207         {
1208           edge->aux = fibheap_insert (heap, current_badness, edge);
1209           continue;
1210         }
1211
1212       if (!can_inline_edge_p (edge, true))
1213         continue;
1214       
1215       callee = edge->callee;
1216       growth = estimate_edge_growth (edge);
1217       if (dump_file)
1218         {
1219           fprintf (dump_file,
1220                    "\nConsidering %s with %i size\n",
1221                    cgraph_node_name (edge->callee),
1222                    inline_summary (edge->callee)->size);
1223           fprintf (dump_file,
1224                    " to be inlined into %s in %s:%i\n"
1225                    " Estimated growth after inlined into all is %+i insns.\n"
1226                    " Estimated badness is %i, frequency %.2f.\n",
1227                    cgraph_node_name (edge->caller),
1228                    flag_wpa ? "unknown"
1229                    : gimple_filename ((const_gimple) edge->call_stmt),
1230                    flag_wpa ? -1
1231                    : gimple_lineno ((const_gimple) edge->call_stmt),
1232                    estimate_growth (edge->callee),
1233                    badness,
1234                    edge->frequency / (double)CGRAPH_FREQ_BASE);
1235           if (edge->count)
1236             fprintf (dump_file," Called "HOST_WIDEST_INT_PRINT_DEC"x\n",
1237                      edge->count);
1238           if (dump_flags & TDF_DETAILS)
1239             edge_badness (edge, true);
1240         }
1241
1242       if (overall_size + growth > max_size
1243           && !DECL_DISREGARD_INLINE_LIMITS (edge->callee->decl))
1244         {
1245           edge->inline_failed = CIF_INLINE_UNIT_GROWTH_LIMIT;
1246           report_inline_failed_reason (edge);
1247           continue;
1248         }
1249
1250       if (!want_inline_small_function_p (edge, true))
1251         continue;
1252
1253       /* Heuristics for inlining small functions works poorly for
1254          recursive calls where we do efect similar to loop unrolling.
1255          When inliing such edge seems profitable, leave decision on
1256          specific inliner.  */
1257       if (cgraph_edge_recursive_p (edge))
1258         {
1259           where = edge->caller;
1260           if (where->global.inlined_to)
1261             where = where->global.inlined_to;
1262           if (!recursive_inlining (edge,
1263                                    flag_indirect_inlining
1264                                    ? &new_indirect_edges : NULL))
1265             {
1266               edge->inline_failed = CIF_RECURSIVE_INLINING;
1267               continue;
1268             }
1269           /* Recursive inliner inlines all recursive calls of the function
1270              at once. Consequently we need to update all callee keys.  */
1271           if (flag_indirect_inlining)
1272             add_new_edges_to_heap (heap, new_indirect_edges);
1273           update_all_callee_keys (heap, where, updated_nodes);
1274         }
1275       else
1276         {
1277           struct cgraph_node *callee;
1278           struct cgraph_node *outer_node = NULL;
1279           int depth = 0;
1280
1281           /* Consider the case where self recursive function A is inlined into B.
1282              This is desired optimization in some cases, since it leads to effect
1283              similar of loop peeling and we might completely optimize out the
1284              recursive call.  However we must be extra selective.  */
1285
1286           where = edge->caller;
1287           while (where->global.inlined_to)
1288             {
1289               if (where->decl == edge->callee->decl)
1290                 outer_node = where, depth++;
1291               where = where->callers->caller;
1292             }
1293           if (outer_node
1294               && !want_inline_self_recursive_call_p (edge, outer_node,
1295                                                      true, depth))
1296             {
1297               edge->inline_failed
1298                 = (DECL_DISREGARD_INLINE_LIMITS (edge->callee->decl)
1299                    ? CIF_RECURSIVE_INLINING : CIF_UNSPECIFIED);
1300               continue;
1301             }
1302           else if (depth && dump_file)
1303             fprintf (dump_file, " Peeling recursion with depth %i\n", depth);
1304
1305           callee = edge->callee;
1306           gcc_checking_assert (!callee->global.inlined_to);
1307           inline_call (edge, true, &new_indirect_edges, &overall_size);
1308           if (flag_indirect_inlining)
1309             add_new_edges_to_heap (heap, new_indirect_edges);
1310
1311           /* We inlined last offline copy to the body.  This might lead
1312              to callees of function having fewer call sites and thus they
1313              may need updating.  */
1314           if (callee->global.inlined_to)
1315             update_all_callee_keys (heap, callee, updated_nodes);
1316           else
1317             update_callee_keys (heap, edge->callee, updated_nodes);
1318         }
1319       where = edge->caller;
1320       if (where->global.inlined_to)
1321         where = where->global.inlined_to;
1322
1323       /* Our profitability metric can depend on local properties
1324          such as number of inlinable calls and size of the function body.
1325          After inlining these properties might change for the function we
1326          inlined into (since it's body size changed) and for the functions
1327          called by function we inlined (since number of it inlinable callers
1328          might change).  */
1329       update_caller_keys (heap, where, updated_nodes);
1330
1331       /* We removed one call of the function we just inlined.  If offline
1332          copy is still needed, be sure to update the keys.  */
1333       if (callee != where && !callee->global.inlined_to)
1334         update_caller_keys (heap, callee, updated_nodes);
1335       bitmap_clear (updated_nodes);
1336
1337       if (dump_file)
1338         {
1339           fprintf (dump_file,
1340                    " Inlined into %s which now has time %i and size %i,"
1341                    "net change of %+i.\n",
1342                    cgraph_node_name (edge->caller),
1343                    inline_summary (edge->caller)->time,
1344                    inline_summary (edge->caller)->size,
1345                    overall_size - old_size);
1346         }
1347       if (min_size > overall_size)
1348         {
1349           min_size = overall_size;
1350           max_size = compute_max_insns (min_size);
1351
1352           if (dump_file)
1353             fprintf (dump_file, "New minimal size reached: %i\n", min_size);
1354         }
1355     }
1356
1357   if (new_indirect_edges)
1358     VEC_free (cgraph_edge_p, heap, new_indirect_edges);
1359   fibheap_delete (heap);
1360   if (dump_file)
1361     fprintf (dump_file,
1362              "Unit growth for small function inlining: %i->%i (%i%%)\n",
1363              overall_size, initial_size,
1364              overall_size * 100 / (initial_size + 1) - 100);
1365   BITMAP_FREE (updated_nodes);
1366 }
1367
1368 /* Flatten NODE.  Performed both during early inlining and
1369    at IPA inlining time.  */
1370
1371 static void
1372 flatten_function (struct cgraph_node *node)
1373 {
1374   struct cgraph_edge *e;
1375
1376   /* We shouldn't be called recursively when we are being processed.  */
1377   gcc_assert (node->aux == NULL);
1378
1379   node->aux = (void *) node;
1380
1381   for (e = node->callees; e; e = e->next_callee)
1382     {
1383       struct cgraph_node *orig_callee;
1384
1385       /* We've hit cycle?  It is time to give up.  */
1386       if (e->callee->aux)
1387         {
1388           if (dump_file)
1389             fprintf (dump_file,
1390                      "Not inlining %s into %s to avoid cycle.\n",
1391                      cgraph_node_name (e->callee),
1392                      cgraph_node_name (e->caller));
1393           e->inline_failed = CIF_RECURSIVE_INLINING;
1394           continue;
1395         }
1396
1397       /* When the edge is already inlined, we just need to recurse into
1398          it in order to fully flatten the leaves.  */
1399       if (!e->inline_failed)
1400         {
1401           flatten_function (e->callee);
1402           continue;
1403         }
1404
1405       /* Flatten attribute needs to be processed during late inlining. For
1406          extra code quality we however do flattening during early optimization,
1407          too.  */
1408       if (cgraph_state != CGRAPH_STATE_IPA_SSA
1409           ? !can_inline_edge_p (e, true)
1410           : !can_early_inline_edge_p (e))
1411         continue;
1412
1413       if (cgraph_edge_recursive_p (e))
1414         {
1415           if (dump_file)
1416             fprintf (dump_file, "Not inlining: recursive call.\n");
1417           continue;
1418         }
1419
1420       if (gimple_in_ssa_p (DECL_STRUCT_FUNCTION (node->decl))
1421           != gimple_in_ssa_p (DECL_STRUCT_FUNCTION (e->callee->decl)))
1422         {
1423           if (dump_file)
1424             fprintf (dump_file, "Not inlining: SSA form does not match.\n");
1425           continue;
1426         }
1427
1428       /* Inline the edge and flatten the inline clone.  Avoid
1429          recursing through the original node if the node was cloned.  */
1430       if (dump_file)
1431         fprintf (dump_file, " Inlining %s into %s.\n",
1432                  cgraph_node_name (e->callee),
1433                  cgraph_node_name (e->caller));
1434       orig_callee = e->callee;
1435       inline_call (e, true, NULL, NULL);
1436       if (e->callee != orig_callee)
1437         orig_callee->aux = (void *) node;
1438       flatten_function (e->callee);
1439       if (e->callee != orig_callee)
1440         orig_callee->aux = NULL;
1441     }
1442
1443   node->aux = NULL;
1444 }
1445
1446 /* Decide on the inlining.  We do so in the topological order to avoid
1447    expenses on updating data structures.  */
1448
1449 static unsigned int
1450 ipa_inline (void)
1451 {
1452   struct cgraph_node *node;
1453   int nnodes;
1454   struct cgraph_node **order =
1455     XCNEWVEC (struct cgraph_node *, cgraph_n_nodes);
1456   int i;
1457
1458   if (in_lto_p && flag_indirect_inlining)
1459     ipa_update_after_lto_read ();
1460   if (flag_indirect_inlining)
1461     ipa_create_all_structures_for_iinln ();
1462
1463   if (dump_file)
1464     dump_inline_summaries (dump_file);
1465
1466   nnodes = cgraph_postorder (order);
1467
1468   for (node = cgraph_nodes; node; node = node->next)
1469     node->aux = 0;
1470
1471   if (dump_file)
1472     fprintf (dump_file, "\nFlattening functions:\n");
1473
1474   /* In the first pass handle functions to be flattened.  Do this with
1475      a priority so none of our later choices will make this impossible.  */
1476   for (i = nnodes - 1; i >= 0; i--)
1477     {
1478       node = order[i];
1479
1480       /* Handle nodes to be flattened.
1481          Ideally when processing callees we stop inlining at the
1482          entry of cycles, possibly cloning that entry point and
1483          try to flatten itself turning it into a self-recursive
1484          function.  */
1485       if (lookup_attribute ("flatten",
1486                             DECL_ATTRIBUTES (node->decl)) != NULL)
1487         {
1488           if (dump_file)
1489             fprintf (dump_file,
1490                      "Flattening %s\n", cgraph_node_name (node));
1491           flatten_function (node);
1492         }
1493     }
1494
1495   inline_small_functions ();
1496   cgraph_remove_unreachable_nodes (true, dump_file);
1497   free (order);
1498
1499   /* We already perform some inlining of functions called once during
1500      inlining small functions above.  After unreachable nodes are removed,
1501      we still might do a quick check that nothing new is found.  */
1502   if (flag_inline_functions_called_once)
1503     {
1504       int cold;
1505       if (dump_file)
1506         fprintf (dump_file, "\nDeciding on functions called once:\n");
1507
1508       /* Inlining one function called once has good chance of preventing
1509          inlining other function into the same callee.  Ideally we should
1510          work in priority order, but probably inlining hot functions first
1511          is good cut without the extra pain of maintaining the queue.
1512
1513          ??? this is not really fitting the bill perfectly: inlining function
1514          into callee often leads to better optimization of callee due to
1515          increased context for optimization.
1516          For example if main() function calls a function that outputs help
1517          and then function that does the main optmization, we should inline
1518          the second with priority even if both calls are cold by themselves.
1519
1520          We probably want to implement new predicate replacing our use of
1521          maybe_hot_edge interpreted as maybe_hot_edge || callee is known
1522          to be hot.  */
1523       for (cold = 0; cold <= 1; cold ++)
1524         {
1525           for (node = cgraph_nodes; node; node = node->next)
1526             {
1527               if (want_inline_function_called_once_p (node)
1528                   && (cold
1529                       || cgraph_maybe_hot_edge_p (node->callers)))
1530                 {
1531                   struct cgraph_node *caller = node->callers->caller;
1532
1533                   if (dump_file)
1534                     {
1535                       fprintf (dump_file,
1536                                "\nInlining %s size %i.\n",
1537                                cgraph_node_name (node), inline_summary (node)->size);
1538                       fprintf (dump_file,
1539                                " Called once from %s %i insns.\n",
1540                                cgraph_node_name (node->callers->caller),
1541                                inline_summary (node->callers->caller)->size);
1542                     }
1543
1544                   inline_call (node->callers, true, NULL, NULL);
1545                   if (dump_file)
1546                     fprintf (dump_file,
1547                              " Inlined into %s which now has %i size\n",
1548                              cgraph_node_name (caller),
1549                              inline_summary (caller)->size);
1550                 }
1551             }
1552         }
1553     }
1554
1555   /* Free ipa-prop structures if they are no longer needed.  */
1556   if (flag_indirect_inlining)
1557     ipa_free_all_structures_after_iinln ();
1558
1559   if (dump_file)
1560     fprintf (dump_file,
1561              "\nInlined %i calls, eliminated %i functions\n\n",
1562              ncalls_inlined, nfunctions_inlined);
1563
1564   /* In WPA we use inline summaries for partitioning process.  */
1565   if (!flag_wpa)
1566     inline_free_summary ();
1567   return 0;
1568 }
1569
1570 /* Inline always-inline function calls in NODE.  */
1571
1572 static bool
1573 inline_always_inline_functions (struct cgraph_node *node)
1574 {
1575   struct cgraph_edge *e;
1576   bool inlined = false;
1577
1578   for (e = node->callees; e; e = e->next_callee)
1579     {
1580       if (!DECL_DISREGARD_INLINE_LIMITS (e->callee->decl))
1581         continue;
1582
1583       if (cgraph_edge_recursive_p (e))
1584         {
1585           if (dump_file)
1586             fprintf (dump_file, "  Not inlining recursive call to %s.\n",
1587                      cgraph_node_name (e->callee));
1588           e->inline_failed = CIF_RECURSIVE_INLINING;
1589           continue;
1590         }
1591
1592       if (!can_early_inline_edge_p (e))
1593         continue;
1594
1595       if (dump_file)
1596         fprintf (dump_file, "  Inlining %s into %s (always_inline).\n",
1597                  cgraph_node_name (e->callee),
1598                  cgraph_node_name (e->caller));
1599       inline_call (e, true, NULL, NULL);
1600       inlined = true;
1601     }
1602
1603   return inlined;
1604 }
1605
1606 /* Decide on the inlining.  We do so in the topological order to avoid
1607    expenses on updating data structures.  */
1608
1609 static bool
1610 early_inline_small_functions (struct cgraph_node *node)
1611 {
1612   struct cgraph_edge *e;
1613   bool inlined = false;
1614
1615   for (e = node->callees; e; e = e->next_callee)
1616     {
1617       if (!inline_summary (e->callee)->inlinable
1618           || !e->inline_failed)
1619         continue;
1620
1621       /* Do not consider functions not declared inline.  */
1622       if (!DECL_DECLARED_INLINE_P (e->callee->decl)
1623           && !flag_inline_small_functions
1624           && !flag_inline_functions)
1625         continue;
1626
1627       if (dump_file)
1628         fprintf (dump_file, "Considering inline candidate %s.\n",
1629                  cgraph_node_name (e->callee));
1630
1631       if (!can_early_inline_edge_p (e))
1632         continue;
1633
1634       if (cgraph_edge_recursive_p (e))
1635         {
1636           if (dump_file)
1637             fprintf (dump_file, "  Not inlining: recursive call.\n");
1638           continue;
1639         }
1640
1641       if (!want_early_inline_function_p (e))
1642         continue;
1643
1644       if (dump_file)
1645         fprintf (dump_file, " Inlining %s into %s.\n",
1646                  cgraph_node_name (e->callee),
1647                  cgraph_node_name (e->caller));
1648       inline_call (e, true, NULL, NULL);
1649       inlined = true;
1650     }
1651
1652   return inlined;
1653 }
1654
1655 /* Do inlining of small functions.  Doing so early helps profiling and other
1656    passes to be somewhat more effective and avoids some code duplication in
1657    later real inlining pass for testcases with very many function calls.  */
1658 static unsigned int
1659 early_inliner (void)
1660 {
1661   struct cgraph_node *node = cgraph_get_node (current_function_decl);
1662   struct cgraph_edge *edge;
1663   unsigned int todo = 0;
1664   int iterations = 0;
1665   bool inlined = false;
1666
1667   if (seen_error ())
1668     return 0;
1669
1670 #ifdef ENABLE_CHECKING
1671   verify_cgraph_node (node);
1672 #endif
1673
1674   /* Even when not optimizing or not inlining inline always-inline
1675      functions.  */
1676   inlined = inline_always_inline_functions (node);
1677
1678   if (!optimize
1679       || flag_no_inline
1680       || !flag_early_inlining
1681       /* Never inline regular functions into always-inline functions
1682          during incremental inlining.  This sucks as functions calling
1683          always inline functions will get less optimized, but at the
1684          same time inlining of functions calling always inline
1685          function into an always inline function might introduce
1686          cycles of edges to be always inlined in the callgraph.
1687
1688          We might want to be smarter and just avoid this type of inlining.  */
1689       || DECL_DISREGARD_INLINE_LIMITS (node->decl))
1690     ;
1691   else if (lookup_attribute ("flatten",
1692                              DECL_ATTRIBUTES (node->decl)) != NULL)
1693     {
1694       /* When the function is marked to be flattened, recursively inline
1695          all calls in it.  */
1696       if (dump_file)
1697         fprintf (dump_file,
1698                  "Flattening %s\n", cgraph_node_name (node));
1699       flatten_function (node);
1700       inlined = true;
1701     }
1702   else
1703     {
1704       /* We iterate incremental inlining to get trivial cases of indirect
1705          inlining.  */
1706       while (iterations < PARAM_VALUE (PARAM_EARLY_INLINER_MAX_ITERATIONS)
1707              && early_inline_small_functions (node))
1708         {
1709           timevar_push (TV_INTEGRATION);
1710           todo |= optimize_inline_calls (current_function_decl);
1711
1712           /* Technically we ought to recompute inline parameters so the new
1713              iteration of early inliner works as expected.  We however have
1714              values approximately right and thus we only need to update edge
1715              info that might be cleared out for newly discovered edges.  */
1716           for (edge = node->callees; edge; edge = edge->next_callee)
1717             {
1718               edge->call_stmt_size
1719                 = estimate_num_insns (edge->call_stmt, &eni_size_weights);
1720               edge->call_stmt_time
1721                 = estimate_num_insns (edge->call_stmt, &eni_time_weights);
1722             }
1723           timevar_pop (TV_INTEGRATION);
1724           iterations++;
1725           inlined = false;
1726         }
1727       if (dump_file)
1728         fprintf (dump_file, "Iterations: %i\n", iterations);
1729     }
1730
1731   if (inlined)
1732     {
1733       timevar_push (TV_INTEGRATION);
1734       todo |= optimize_inline_calls (current_function_decl);
1735       timevar_pop (TV_INTEGRATION);
1736     }
1737
1738   cfun->always_inline_functions_inlined = true;
1739
1740   return todo;
1741 }
1742
1743 struct gimple_opt_pass pass_early_inline =
1744 {
1745  {
1746   GIMPLE_PASS,
1747   "einline",                            /* name */
1748   NULL,                                 /* gate */
1749   early_inliner,                        /* execute */
1750   NULL,                                 /* sub */
1751   NULL,                                 /* next */
1752   0,                                    /* static_pass_number */
1753   TV_INLINE_HEURISTICS,                 /* tv_id */
1754   PROP_ssa,                             /* properties_required */
1755   0,                                    /* properties_provided */
1756   0,                                    /* properties_destroyed */
1757   0,                                    /* todo_flags_start */
1758   TODO_dump_func                        /* todo_flags_finish */
1759  }
1760 };
1761
1762
1763 /* When to run IPA inlining.  Inlining of always-inline functions
1764    happens during early inlining.  */
1765
1766 static bool
1767 gate_ipa_inline (void)
1768 {
1769   /* ???  We'd like to skip this if not optimizing or not inlining as
1770      all always-inline functions have been processed by early
1771      inlining already.  But this at least breaks EH with C++ as
1772      we need to unconditionally run fixup_cfg even at -O0.
1773      So leave it on unconditionally for now.  */
1774   return 1;
1775 }
1776
1777 struct ipa_opt_pass_d pass_ipa_inline =
1778 {
1779  {
1780   IPA_PASS,
1781   "inline",                             /* name */
1782   gate_ipa_inline,                      /* gate */
1783   ipa_inline,                           /* execute */
1784   NULL,                                 /* sub */
1785   NULL,                                 /* next */
1786   0,                                    /* static_pass_number */
1787   TV_INLINE_HEURISTICS,                 /* tv_id */
1788   0,                                    /* properties_required */
1789   0,                                    /* properties_provided */
1790   0,                                    /* properties_destroyed */
1791   TODO_remove_functions,                /* todo_flags_finish */
1792   TODO_dump_cgraph | TODO_dump_func
1793   | TODO_remove_functions | TODO_ggc_collect    /* todo_flags_finish */
1794  },
1795  inline_generate_summary,               /* generate_summary */
1796  inline_write_summary,                  /* write_summary */
1797  inline_read_summary,                   /* read_summary */
1798  NULL,                                  /* write_optimization_summary */
1799  NULL,                                  /* read_optimization_summary */
1800  NULL,                                  /* stmt_fixup */
1801  0,                                     /* TODOs */
1802  inline_transform,                      /* function_transform */
1803  NULL,                                  /* variable_transform */
1804 };