1 /* Inlining decision heuristics.
2    Copyright (C) 2003-2019 Free Software Foundation, Inc.
3    Contributed by Jan Hubicka
4 
5 This file is part of GCC.
6 
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
10 version.
11 
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16 
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3.  If not see
19 <http://www.gnu.org/licenses/>.  */
20 
21 #ifndef GCC_IPA_INLINE_H
22 #define GCC_IPA_INLINE_H
23 
24 /* Data we cache about callgraph edges during inlining to avoid expensive
25    re-computations during the greedy algorithm.  */
26 struct edge_growth_cache_entry
27 {
28   sreal time, nonspec_time;
29   int size;
30   ipa_hints hints;
31 
edge_growth_cache_entryedge_growth_cache_entry32   edge_growth_cache_entry()
33     : size (0), hints (0) {}
34 
edge_growth_cache_entryedge_growth_cache_entry35   edge_growth_cache_entry(int64_t time, int64_t nonspec_time,
36 			  int size, ipa_hints hints)
37     : time (time), nonspec_time (nonspec_time), size (size),
38       hints (hints) {}
39 };
40 
41 extern call_summary<edge_growth_cache_entry *> *edge_growth_cache;
42 
43 /* In ipa-inline-analysis.c  */
44 int estimate_size_after_inlining (struct cgraph_node *, struct cgraph_edge *);
45 int estimate_growth (struct cgraph_node *);
46 bool growth_likely_positive (struct cgraph_node *, int);
47 int do_estimate_edge_size (struct cgraph_edge *edge);
48 sreal do_estimate_edge_time (struct cgraph_edge *edge);
49 ipa_hints do_estimate_edge_hints (struct cgraph_edge *edge);
50 void free_growth_caches (void);
51 
52 /* In ipa-inline.c  */
53 unsigned int early_inliner (function *fun);
54 bool inline_account_function_p (struct cgraph_node *node);
55 
56 
57 /* In ipa-inline-transform.c  */
58 bool inline_call (struct cgraph_edge *, bool, vec<cgraph_edge *> *, int *, bool,
59 		  bool *callee_removed = NULL);
60 unsigned int inline_transform (struct cgraph_node *);
61 void clone_inlined_nodes (struct cgraph_edge *e, bool, bool, int *);
62 
63 extern int ncalls_inlined;
64 extern int nfunctions_inlined;
65 
66 /* Return estimated size of the inline sequence of EDGE.  */
67 
68 static inline int
estimate_edge_size(struct cgraph_edge * edge)69 estimate_edge_size (struct cgraph_edge *edge)
70 {
71   edge_growth_cache_entry *entry;
72   if (edge_growth_cache == NULL
73       || (entry = edge_growth_cache->get (edge)) == NULL
74       || entry->size == 0)
75     return do_estimate_edge_size (edge);
76   return entry->size - (entry->size > 0);
77 }
78 
79 /* Return estimated callee growth after inlining EDGE.  */
80 
81 static inline int
estimate_edge_growth(struct cgraph_edge * edge)82 estimate_edge_growth (struct cgraph_edge *edge)
83 {
84   ipa_call_summary *s = ipa_call_summaries->get (edge);
85   gcc_checking_assert (s->call_stmt_size || !edge->callee->analyzed);
86   return (estimate_edge_size (edge) - s->call_stmt_size);
87 }
88 
89 /* Return estimated callee runtime increase after inlining
90    EDGE.  */
91 
92 static inline sreal
93 estimate_edge_time (struct cgraph_edge *edge, sreal *nonspec_time = NULL)
94 {
95   edge_growth_cache_entry *entry;
96   if (edge_growth_cache == NULL
97       || (entry = edge_growth_cache->get (edge)) == NULL
98       || entry->time == 0)
99     return do_estimate_edge_time (edge);
100   if (nonspec_time)
101     *nonspec_time = edge_growth_cache->get (edge)->nonspec_time;
102   return entry->time;
103 }
104 
105 
106 /* Return estimated callee runtime increase after inlining
107    EDGE.  */
108 
109 static inline ipa_hints
estimate_edge_hints(struct cgraph_edge * edge)110 estimate_edge_hints (struct cgraph_edge *edge)
111 {
112   edge_growth_cache_entry *entry;
113   if (edge_growth_cache == NULL
114       || (entry = edge_growth_cache->get (edge)) == NULL
115       || entry->hints == 0)
116     return do_estimate_edge_hints (edge);
117   return entry->hints - 1;
118 }
119 
120 #endif /* GCC_IPA_INLINE_H */
121