]>
Commit | Line | Data |
---|---|---|
1431bff6 | 1 | /* Tree inlining hooks and declarations. |
fbd26352 | 2 | Copyright (C) 2001-2019 Free Software Foundation, Inc. |
1431bff6 | 3 | Contributed by Alexandre Oliva <aoliva@redhat.com> |
4 | ||
4642865b | 5 | This file is part of GCC. |
1431bff6 | 6 | |
4642865b | 7 | GCC is free software; you can redistribute it and/or modify |
1431bff6 | 8 | it under the terms of the GNU General Public License as published by |
8c4c00c1 | 9 | the Free Software Foundation; either version 3, or (at your option) |
1431bff6 | 10 | any later version. |
11 | ||
4642865b | 12 | GCC is distributed in the hope that it will be useful, |
1431bff6 | 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
8c4c00c1 | 18 | along with GCC; see the file COPYING3. If not see |
19 | <http://www.gnu.org/licenses/>. */ | |
1431bff6 | 20 | |
21 | #ifndef GCC_TREE_INLINE_H | |
22 | #define GCC_TREE_INLINE_H | |
23 | ||
431205b7 | 24 | |
19bcf521 | 25 | struct cgraph_edge; |
51a48c27 | 26 | |
0b09525f | 27 | /* Indicate the desired behavior wrt call graph edges. We can either |
28 | duplicate the edge (inlining, cloning), move the edge (versioning, | |
29 | parallelization), or move the edges of the clones (saving). */ | |
30 | ||
31 | enum copy_body_cge_which | |
32 | { | |
33 | CB_CGE_DUPLICATE, | |
34 | CB_CGE_MOVE, | |
35 | CB_CGE_MOVE_CLONES | |
36 | }; | |
37 | ||
613732c1 | 38 | typedef int_hash <unsigned short, 0> dependence_hash; |
62b0a610 | 39 | |
51a48c27 | 40 | /* Data required for function body duplication. */ |
41 | ||
b3e7c666 | 42 | struct copy_body_data |
51a48c27 | 43 | { |
44 | /* FUNCTION_DECL for function being inlined, or in general the | |
45 | source function providing the original trees. */ | |
46 | tree src_fn; | |
75a70cf9 | 47 | |
51a48c27 | 48 | /* FUNCTION_DECL for function being inlined into, or in general |
49 | the destination function receiving the new trees. */ | |
50 | tree dst_fn; | |
75a70cf9 | 51 | |
51a48c27 | 52 | /* Callgraph node of the source function. */ |
53 | struct cgraph_node *src_node; | |
75a70cf9 | 54 | |
51a48c27 | 55 | /* Callgraph node of the destination function. */ |
56 | struct cgraph_node *dst_node; | |
75a70cf9 | 57 | |
51a48c27 | 58 | /* struct function for function being inlined. Usually this is the same |
59 | as DECL_STRUCT_FUNCTION (src_fn), but can be different if saved_cfg | |
60 | and saved_eh are in use. */ | |
61 | struct function *src_cfun; | |
62 | ||
63 | /* The VAR_DECL for the return value. */ | |
64 | tree retvar; | |
75a70cf9 | 65 | |
51a48c27 | 66 | /* The map from local declarations in the inlined function to |
67 | equivalents in the function into which it is being inlined. */ | |
06ecf488 | 68 | hash_map<tree, tree> *decl_map; |
51a48c27 | 69 | |
70 | /* Create a new decl to replace DECL in the destination function. */ | |
71 | tree (*copy_decl) (tree, struct copy_body_data *); | |
72 | ||
73 | /* Current BLOCK. */ | |
74 | tree block; | |
75 | ||
75a70cf9 | 76 | /* GIMPLE_CALL if va arg parameter packs should be expanded or NULL |
48dc2227 | 77 | is not. */ |
7d9dfee0 | 78 | gcall *call_stmt; |
48dc2227 | 79 | |
42cf43fc | 80 | /* > 0 if we are remapping a type currently. */ |
81 | int remapping_type_depth; | |
82 | ||
e38def9c | 83 | /* Exception landing pad the inlined call lies in. */ |
84 | int eh_lp_nr; | |
75a70cf9 | 85 | |
e38def9c | 86 | /* Maps region and landing pad structures from the function being copied |
87 | to duplicates created within the function we inline into. */ | |
06ecf488 | 88 | hash_map<void *, void *> *eh_map; |
51a48c27 | 89 | |
90 | /* We use the same mechanism do all sorts of different things. Rather | |
9ca2c29a | 91 | than enumerating the different cases, we categorize the behavior |
51a48c27 | 92 | in the various situations. */ |
93 | ||
0b09525f | 94 | /* What to do with call graph edges. */ |
95 | enum copy_body_cge_which transform_call_graph_edges; | |
51a48c27 | 96 | |
97 | /* True if a new CFG should be created. False for inlining, true for | |
98 | everything else. */ | |
99 | bool transform_new_cfg; | |
100 | ||
101 | /* True if RETURN_EXPRs should be transformed to just the contained | |
102 | MODIFY_EXPR. The branch semantics of the return will be handled | |
103 | by manipulating the CFG rather than a statement. */ | |
104 | bool transform_return_to_modify; | |
105 | ||
6b99cb5e | 106 | /* True if the parameters of the source function are transformed. |
107 | Only true for inlining. */ | |
108 | bool transform_parameter; | |
109 | ||
3d053ea5 | 110 | /* True if this statement will need to be regimplified. */ |
111 | bool regimplify; | |
112 | ||
42cf43fc | 113 | /* True if trees may not be unshared. */ |
4189e677 | 114 | bool do_not_unshare; |
115 | ||
5b81d1a1 | 116 | /* True if trees should not be folded during the copying. */ |
117 | bool do_not_fold; | |
118 | ||
42cf43fc | 119 | /* True if new declarations may not be created during type remapping. */ |
120 | bool prevent_decl_creation_for_types; | |
121 | ||
122 | /* True if the location information will need to be reset. */ | |
123 | bool reset_location; | |
ed6049c8 | 124 | |
45b37eaa | 125 | /* Replace error_mark_node as upper bound of array types with |
126 | an uninitialized VAR_DECL temporary. */ | |
127 | bool adjust_array_error_bounds; | |
128 | ||
744a33a1 | 129 | /* Usually copy_decl callback always creates new decls, in that case |
130 | we want to remap all variably_modified_type_p types. If this flag | |
131 | is set, remap_type will do further checks to see if remap_decl | |
132 | of any decls mentioned in the type will remap to anything but itself | |
133 | and only in that case will actually remap the type. */ | |
134 | bool dont_remap_vla_if_no_change; | |
135 | ||
32020b10 | 136 | /* A function to be called when duplicating BLOCK nodes. */ |
137 | void (*transform_lang_insert_block) (tree); | |
138 | ||
3e9045dd | 139 | /* Statements that might be possibly folded. */ |
42acab1c | 140 | hash_set<gimple *> *statements_to_fold; |
186f5fff | 141 | |
142 | /* Entry basic block to currently copied body. */ | |
161dfa6e | 143 | basic_block entry_bb; |
9845d120 | 144 | |
da51794e | 145 | /* For partial function versioning, bitmap of bbs to be copied, |
146 | otherwise NULL. */ | |
147 | bitmap blocks_to_copy; | |
148 | ||
9845d120 | 149 | /* Debug statements that need processing. */ |
1a91d914 | 150 | vec<gdebug *> debug_stmts; |
9845d120 | 151 | |
152 | /* A map from local declarations in the inlined function to | |
153 | equivalents in the function into which it is being inlined, where | |
154 | the originals have been mapped to a value rather than to a | |
155 | variable. */ | |
06ecf488 | 156 | hash_map<tree, tree> *debug_map; |
62b0a610 | 157 | |
158 | /* A map from the inlined functions dependence info cliques to | |
159 | equivalents in the function into which it is being inlined. */ | |
ee34b0e4 | 160 | hash_map<dependence_hash, unsigned short> *dependence_map; |
5d2cbc45 | 161 | |
1b576300 | 162 | /* A list of addressable local variables remapped into the caller |
163 | when inlining a call within an OpenMP SIMD-on-SIMT loop. */ | |
164 | vec<tree> *dst_simt_vars; | |
273d44ee | 165 | |
91b30299 | 166 | /* Basic block to which clobbers for local variables from the inline |
167 | function that need to live in memory should be added. */ | |
168 | basic_block eh_landing_pad_dest; | |
169 | ||
273d44ee | 170 | /* If clobbers for local variables from the inline function |
171 | that need to live in memory should be added to EH landing pads | |
172 | outside of the inlined function, this should be the number | |
173 | of basic blocks in the caller before inlining. Zero otherwise. */ | |
174 | int add_clobbers_to_eh_landing_pads; | |
b3e7c666 | 175 | }; |
51a48c27 | 176 | |
bc8bb825 | 177 | /* Weights of constructions for estimate_num_insns. */ |
178 | ||
6dc50383 | 179 | struct eni_weights |
bc8bb825 | 180 | { |
181 | /* Cost per call. */ | |
182 | unsigned call_cost; | |
183 | ||
20da2013 | 184 | /* Cost per indirect call. */ |
185 | unsigned indirect_call_cost; | |
186 | ||
4a5b1b7c | 187 | /* Cost per call to a target specific builtin */ |
188 | unsigned target_builtin_call_cost; | |
189 | ||
bc8bb825 | 190 | /* Cost of "expensive" div and mod operations. */ |
191 | unsigned div_mod_cost; | |
192 | ||
bc8bb825 | 193 | /* Cost for omp construct. */ |
194 | unsigned omp_cost; | |
94e6e359 | 195 | |
4c0315d0 | 196 | /* Cost for tm transaction. */ |
197 | unsigned tm_cost; | |
198 | ||
958b3c8a | 199 | /* Cost of return. */ |
200 | unsigned return_cost; | |
201 | ||
10260337 | 202 | /* True when time of statement should be estimated. Thus, the |
203 | cost of a switch statement is logarithmic rather than linear in number | |
94e6e359 | 204 | of cases. */ |
205 | bool time_based; | |
6dc50383 | 206 | }; |
bc8bb825 | 207 | |
208 | /* Weights that estimate_num_insns uses for heuristics in inlining. */ | |
209 | ||
210 | extern eni_weights eni_inlining_weights; | |
211 | ||
212 | /* Weights that estimate_num_insns uses to estimate the size of the | |
213 | produced code. */ | |
214 | ||
215 | extern eni_weights eni_size_weights; | |
216 | ||
217 | /* Weights that estimate_num_insns uses to estimate the time necessary | |
218 | to execute the produced code. */ | |
219 | ||
220 | extern eni_weights eni_time_weights; | |
221 | ||
1431bff6 | 222 | /* Function prototypes. */ |
9ed99284 | 223 | void init_inline_once (void); |
75a70cf9 | 224 | extern tree copy_tree_body_r (tree *, int *, void *); |
51a48c27 | 225 | extern void insert_decl_map (copy_body_data *, tree, tree); |
09a2e412 | 226 | unsigned int optimize_inline_calls (tree); |
4189e677 | 227 | tree maybe_inline_call_in_expr (tree); |
746149b7 | 228 | bool tree_inlinable_function_p (tree); |
ff6fba0d | 229 | tree copy_tree_r (tree *, int *, void *); |
32020b10 | 230 | tree copy_decl_no_change (tree decl, copy_body_data *id); |
96c7c99c | 231 | int estimate_move_cost (tree type, bool); |
42acab1c | 232 | int estimate_num_insns (gimple *, eni_weights *); |
75a70cf9 | 233 | int estimate_num_insns_fn (tree, eni_weights *); |
100f989e | 234 | int estimate_num_insns_seq (gimple_seq, eni_weights *); |
c5235c0b | 235 | bool tree_versionable_function_p (tree); |
51a48c27 | 236 | extern tree remap_decl (tree decl, copy_body_data *id); |
237 | extern tree remap_type (tree type, copy_body_data *id); | |
75a70cf9 | 238 | extern gimple_seq copy_gimple_seq_and_replace_locals (gimple_seq seq); |
9ed99284 | 239 | extern bool debug_find_tree (tree, tree); |
9c96033c | 240 | extern tree copy_fn (tree, tree&, tree&); |
37af779a | 241 | extern const char *copy_forbidden (struct function *fun); |
c51887c5 | 242 | extern tree copy_decl_for_dup_finish (copy_body_data *id, tree decl, tree copy); |
9ed99284 | 243 | |
244 | /* This is in tree-inline.c since the routine uses | |
245 | data structures from the inliner. */ | |
246 | extern tree build_duplicate_type (tree); | |
1431bff6 | 247 | |
1431bff6 | 248 | #endif /* GCC_TREE_INLINE_H */ |