GCC Middle and Back End API Reference
tree-inline.h
Go to the documentation of this file.
1/* Tree inlining hooks and declarations.
2 Copyright (C) 2001-2024 Free Software Foundation, Inc.
3 Contributed by Alexandre Oliva <aoliva@redhat.com>
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
9the Free Software Foundation; either version 3, or (at your option)
10any later version.
11
12GCC is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING3. If not see
19<http://www.gnu.org/licenses/>. */
20
21#ifndef GCC_TREE_INLINE_H
22#define GCC_TREE_INLINE_H
23
24
25struct cgraph_edge;
26
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
37
38typedef int_hash <unsigned short, 0> dependence_hash;
39
40/* Data required for function body duplication. */
41
43{
44 /* FUNCTION_DECL for function being inlined, or in general the
45 source function providing the original trees. */
47
48 /* FUNCTION_DECL for function being inlined into, or in general
49 the destination function receiving the new trees. */
51
52 /* Callgraph node of the source function. */
54
55 /* Callgraph node of the destination function. */
57
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. */
62
63 /* The VAR_DECL for the return value. */
65
66 /* The map from local declarations in the inlined function to
67 equivalents in the function into which it is being inlined. */
69
70 /* Create a new decl to replace DECL in the destination function. */
72
73 /* Current BLOCK. */
75
76 /* GIMPLE_CALL if va arg parameter packs should be expanded or NULL
77 is not. */
79
80 /* > 0 if we are remapping a type currently. */
82
83 /* Exception landing pad the inlined call lies in. */
85
86 /* Maps region and landing pad structures from the function being copied
87 to duplicates created within the function we inline into. */
89
90 /* We use the same mechanism do all sorts of different things. Rather
91 than enumerating the different cases, we categorize the behavior
92 in the various situations. */
93
94 /* What to do with call graph edges. */
96
97 /* True if a new CFG should be created. False for inlining, true for
98 everything else. */
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. */
105
106 /* True if the parameters of the source function are transformed.
107 Only true for inlining. */
109
110 /* True if this statement will need to be regimplified. */
112
113 /* True if trees may not be unshared. */
115
116 /* True if trees should not be folded during the copying. */
118
119 /* True if new declarations may not be created during type remapping. */
121
122 /* True if the location information will need to be reset. */
124
125 /* Replace error_mark_node as upper bound of array types with
126 an uninitialized VAR_DECL temporary. */
128
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. */
135
136 /* Statements that might be possibly folded. */
138
139 /* Entry basic block to currently copied body. */
141
142 /* For partial function versioning, bitmap of bbs to be copied,
143 otherwise NULL. */
145
146 /* Debug statements that need processing. */
148
149 /* A map from local declarations in the inlined function to
150 equivalents in the function into which it is being inlined,
151 where the originals have been mapped to a value rather than
152 to a variable. */
154
155 /* A map from the inlined functions dependence info cliques to
156 equivalents in the function into which it is being inlined. */
158
159 /* A list of addressable local variables remapped into the caller
160 when inlining a call within an OpenMP SIMD-on-SIMT loop. */
162
163 /* Basic block to which clobbers for local variables from the inline
164 function that need to live in memory should be added. */
166
167 /* If clobbers for local variables from the inline function
168 that need to live in memory should be added to EH landing pads
169 outside of the inlined function, this should be the number
170 of basic blocks in the caller before inlining. Zero otherwise. */
172
173 /* Class managing changes to function parameters and return value planned
174 during IPA stage. */
176
177 /* Hash set of SSA names that have been killed during call graph edge
178 redirection and should not be introduced into debug statements or NULL if no
179 SSA_NAME was deleted during redirections happened. */
180 hash_set <tree> *killed_new_ssa_names;
181};
182
183/* Weights of constructions for estimate_num_insns. */
184
186{
187 /* Cost per call. */
188 unsigned call_cost;
189
190 /* Cost per indirect call. */
192
193 /* Cost per call to a target specific builtin */
195
196 /* Cost of "expensive" div and mod operations. */
197 unsigned div_mod_cost;
198
199 /* Cost for omp construct. */
200 unsigned omp_cost;
201
202 /* Cost for tm transaction. */
203 unsigned tm_cost;
204
205 /* Cost of return. */
206 unsigned return_cost;
207
208 /* True when time of statement should be estimated. Thus, the
209 cost of a switch statement is logarithmic rather than linear in number
210 of cases. */
212};
213
214/* Weights that estimate_num_insns uses for heuristics in inlining. */
215
217
218/* Weights that estimate_num_insns uses to estimate the size of the
219 produced code. */
220
222
223/* Weights that estimate_num_insns uses to estimate the time necessary
224 to execute the produced code. */
225
227
228/* Function prototypes. */
229void init_inline_once (void);
230extern tree copy_tree_body_r (tree *, int *, void *);
231extern void insert_decl_map (copy_body_data *, tree, tree);
232unsigned int optimize_inline_calls (tree);
235tree copy_tree_r (tree *, int *, void *);
245extern bool debug_find_tree (tree, tree);
246extern tree copy_fn (tree, tree&, tree&);
247extern const char *copy_forbidden (struct function *fun);
250extern tree force_value_to_type (tree type, tree value);
251
252/* This is in tree-inline.cc since the routine uses
253 data structures from the inliner. */
255
256#endif /* GCC_TREE_INLINE_H */
Definition cgraph.h:1696
Definition hash-map.h:40
Definition hash-set.h:37
Definition ipa-param-manipulation.h:296
class bitmap_head * bitmap
Definition coretypes.h:51
union tree_node * tree
Definition coretypes.h:97
Definition basic-block.h:117
Definition cgraph.h:875
Definition tree-inline.h:43
int eh_lp_nr
Definition tree-inline.h:84
bitmap blocks_to_copy
Definition tree-inline.h:144
bool adjust_array_error_bounds
Definition tree-inline.h:127
gcall * call_stmt
Definition tree-inline.h:78
hash_map< tree, tree > * debug_map
Definition tree-inline.h:153
hash_map< void *, void * > * eh_map
Definition tree-inline.h:88
tree dst_fn
Definition tree-inline.h:50
bool regimplify
Definition tree-inline.h:111
struct cgraph_node * dst_node
Definition tree-inline.h:56
hash_set< gimple * > * statements_to_fold
Definition tree-inline.h:137
bool do_not_fold
Definition tree-inline.h:117
bool dont_remap_vla_if_no_change
Definition tree-inline.h:134
bool transform_return_to_modify
Definition tree-inline.h:104
int remapping_type_depth
Definition tree-inline.h:81
vec< tree > * dst_simt_vars
Definition tree-inline.h:161
tree retvar
Definition tree-inline.h:64
vec< gdebug * > debug_stmts
Definition tree-inline.h:147
tree(* copy_decl)(tree, struct copy_body_data *)
Definition tree-inline.h:71
tree src_fn
Definition tree-inline.h:46
basic_block entry_bb
Definition tree-inline.h:140
struct cgraph_node * src_node
Definition tree-inline.h:53
hash_set< tree > * killed_new_ssa_names
Definition tree-inline.h:180
bool transform_parameter
Definition tree-inline.h:108
tree block
Definition tree-inline.h:74
int add_clobbers_to_eh_landing_pads
Definition tree-inline.h:171
hash_map< tree, tree > * decl_map
Definition tree-inline.h:68
bool transform_new_cfg
Definition tree-inline.h:99
bool do_not_unshare
Definition tree-inline.h:114
hash_map< dependence_hash, unsigned short > * dependence_map
Definition tree-inline.h:157
class ipa_param_body_adjustments * param_body_adjs
Definition tree-inline.h:175
basic_block eh_landing_pad_dest
Definition tree-inline.h:165
struct function * src_cfun
Definition tree-inline.h:61
bool prevent_decl_creation_for_types
Definition tree-inline.h:120
enum copy_body_cge_which transform_call_graph_edges
Definition tree-inline.h:95
bool reset_location
Definition tree-inline.h:123
Definition genautomata.cc:499
Definition tree-inline.h:186
unsigned target_builtin_call_cost
Definition tree-inline.h:194
unsigned div_mod_cost
Definition tree-inline.h:197
bool time_based
Definition tree-inline.h:211
unsigned return_cost
Definition tree-inline.h:206
unsigned indirect_call_cost
Definition tree-inline.h:191
unsigned call_cost
Definition tree-inline.h:188
unsigned omp_cost
Definition tree-inline.h:200
unsigned tm_cost
Definition tree-inline.h:203
Definition function.h:249
Definition gimple.h:349
Definition gimple.h:221
Definition gengtype.h:252
Definition vec.h:450
tree build_duplicate_type(tree)
Definition tree-inline.cc:6645
unsigned int optimize_inline_calls(tree)
Definition tree-inline.cc:5536
tree copy_decl_to_var(tree, copy_body_data *)
Definition tree-inline.cc:6067
int estimate_num_insns_seq(gimple_seq, eni_weights *)
Definition tree-inline.cc:4391
bool tree_versionable_function_p(tree)
Definition tree-inline.cc:6197
const char * copy_forbidden(struct function *fun)
Definition tree-inline.cc:3923
int estimate_num_insns_fn(tree, eni_weights *)
Definition tree-inline.cc:4642
int estimate_move_cost(tree type, bool)
int_hash< unsigned short, 0 > dependence_hash
Definition tree-inline.h:38
tree copy_fn(tree, tree &, tree &)
Definition tree-inline.cc:6673
tree force_value_to_type(tree type, tree value)
Definition tree-inline.cc:3472
eni_weights eni_inlining_weights
tree maybe_inline_call_in_expr(tree)
Definition tree-inline.cc:6593
tree copy_decl_no_change(tree decl, copy_body_data *id)
Definition tree-inline.cc:6125
eni_weights eni_size_weights
Definition tree-inline.cc:121
void init_inline_once(void)
Definition tree-inline.cc:4663
void insert_decl_map(copy_body_data *, tree, tree)
Definition tree-inline.cc:146
copy_body_cge_which
Definition tree-inline.h:32
@ CB_CGE_MOVE
Definition tree-inline.h:34
@ CB_CGE_DUPLICATE
Definition tree-inline.h:33
@ CB_CGE_MOVE_CLONES
Definition tree-inline.h:35
tree remap_type(tree type, copy_body_data *id)
Definition tree-inline.cc:690
tree copy_tree_body_r(tree *, int *, void *)
Definition tree-inline.cc:1189
tree copy_tree_r(tree *, int *, void *)
Definition tree-inline.cc:5643
bool debug_find_tree(tree, tree)
Definition tree-inline.cc:5980
gimple_seq copy_gimple_seq_and_replace_locals(gimple_seq seq)
Definition tree-inline.cc:5916
int estimate_num_insns(gimple *, eni_weights *)
Definition tree-inline.cc:4408
tree remap_decl(tree decl, copy_body_data *id)
Definition tree-inline.cc:337
bool tree_inlinable_function_p(tree)
Definition tree-inline.cc:4156
tree copy_decl_for_dup_finish(copy_body_data *id, tree decl, tree copy)
Definition tree-inline.cc:6009
eni_weights eni_time_weights
Definition tree-inline.cc:126