2018-11-09 Richard Biener <rguenther@suse.de>
[official-gcc.git] / gcc / tree-inline.h
blob29caab7115476f6edb509a54743cf4cfa4f0c8a6
1 /* Tree inlining hooks and declarations.
2 Copyright (C) 2001-2018 Free Software Foundation, Inc.
3 Contributed by Alexandre Oliva <aoliva@redhat.com>
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
10 any later version.
12 GCC is distributed in the hope that it will be useful,
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.
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/>. */
21 #ifndef GCC_TREE_INLINE_H
22 #define GCC_TREE_INLINE_H
25 struct cgraph_edge;
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). */
31 enum copy_body_cge_which
33 CB_CGE_DUPLICATE,
34 CB_CGE_MOVE,
35 CB_CGE_MOVE_CLONES
38 typedef int_hash <unsigned short, 0> dependence_hash;
40 /* Data required for function body duplication. */
42 struct copy_body_data
44 /* FUNCTION_DECL for function being inlined, or in general the
45 source function providing the original trees. */
46 tree src_fn;
48 /* FUNCTION_DECL for function being inlined into, or in general
49 the destination function receiving the new trees. */
50 tree dst_fn;
52 /* Callgraph node of the source function. */
53 struct cgraph_node *src_node;
55 /* Callgraph node of the destination function. */
56 struct cgraph_node *dst_node;
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;
63 /* The VAR_DECL for the return value. */
64 tree retvar;
66 /* Assign statements that need bounds copy. */
67 vec<gimple *> assign_stmts;
69 /* The map from local declarations in the inlined function to
70 equivalents in the function into which it is being inlined. */
71 hash_map<tree, tree> *decl_map;
73 /* Create a new decl to replace DECL in the destination function. */
74 tree (*copy_decl) (tree, struct copy_body_data *);
76 /* Current BLOCK. */
77 tree block;
79 /* GIMPLE_CALL if va arg parameter packs should be expanded or NULL
80 is not. */
81 gcall *call_stmt;
83 /* > 0 if we are remapping a type currently. */
84 int remapping_type_depth;
86 /* Exception landing pad the inlined call lies in. */
87 int eh_lp_nr;
89 /* Maps region and landing pad structures from the function being copied
90 to duplicates created within the function we inline into. */
91 hash_map<void *, void *> *eh_map;
93 /* We use the same mechanism do all sorts of different things. Rather
94 than enumerating the different cases, we categorize the behavior
95 in the various situations. */
97 /* What to do with call graph edges. */
98 enum copy_body_cge_which transform_call_graph_edges;
100 /* True if a new CFG should be created. False for inlining, true for
101 everything else. */
102 bool transform_new_cfg;
104 /* True if RETURN_EXPRs should be transformed to just the contained
105 MODIFY_EXPR. The branch semantics of the return will be handled
106 by manipulating the CFG rather than a statement. */
107 bool transform_return_to_modify;
109 /* True if the parameters of the source function are transformed.
110 Only true for inlining. */
111 bool transform_parameter;
113 /* True if this statement will need to be regimplified. */
114 bool regimplify;
116 /* True if trees may not be unshared. */
117 bool do_not_unshare;
119 /* True if new declarations may not be created during type remapping. */
120 bool prevent_decl_creation_for_types;
122 /* True if the location information will need to be reset. */
123 bool reset_location;
125 /* A function to be called when duplicating BLOCK nodes. */
126 void (*transform_lang_insert_block) (tree);
128 /* Statements that might be possibly folded. */
129 hash_set<gimple *> *statements_to_fold;
131 /* Entry basic block to currently copied body. */
132 basic_block entry_bb;
134 /* For partial function versioning, bitmap of bbs to be copied,
135 otherwise NULL. */
136 bitmap blocks_to_copy;
138 /* Debug statements that need processing. */
139 vec<gdebug *> debug_stmts;
141 /* A map from local declarations in the inlined function to
142 equivalents in the function into which it is being inlined, where
143 the originals have been mapped to a value rather than to a
144 variable. */
145 hash_map<tree, tree> *debug_map;
147 /* A map from the inlined functions dependence info cliques to
148 equivalents in the function into which it is being inlined. */
149 hash_map<dependence_hash, unsigned short> *dependence_map;
151 /* A list of addressable local variables remapped into the caller
152 when inlining a call within an OpenMP SIMD-on-SIMT loop. */
153 vec<tree> *dst_simt_vars;
156 /* Weights of constructions for estimate_num_insns. */
158 struct eni_weights
160 /* Cost per call. */
161 unsigned call_cost;
163 /* Cost per indirect call. */
164 unsigned indirect_call_cost;
166 /* Cost per call to a target specific builtin */
167 unsigned target_builtin_call_cost;
169 /* Cost of "expensive" div and mod operations. */
170 unsigned div_mod_cost;
172 /* Cost for omp construct. */
173 unsigned omp_cost;
175 /* Cost for tm transaction. */
176 unsigned tm_cost;
178 /* Cost of return. */
179 unsigned return_cost;
181 /* True when time of statement should be estimated. Thus, the
182 cost of a switch statement is logarithmic rather than linear in number
183 of cases. */
184 bool time_based;
187 /* Weights that estimate_num_insns uses for heuristics in inlining. */
189 extern eni_weights eni_inlining_weights;
191 /* Weights that estimate_num_insns uses to estimate the size of the
192 produced code. */
194 extern eni_weights eni_size_weights;
196 /* Weights that estimate_num_insns uses to estimate the time necessary
197 to execute the produced code. */
199 extern eni_weights eni_time_weights;
201 /* Function prototypes. */
202 void init_inline_once (void);
203 extern tree copy_tree_body_r (tree *, int *, void *);
204 extern void insert_decl_map (copy_body_data *, tree, tree);
205 unsigned int optimize_inline_calls (tree);
206 tree maybe_inline_call_in_expr (tree);
207 bool tree_inlinable_function_p (tree);
208 tree copy_tree_r (tree *, int *, void *);
209 tree copy_decl_no_change (tree decl, copy_body_data *id);
210 int estimate_move_cost (tree type, bool);
211 int estimate_num_insns (gimple *, eni_weights *);
212 int estimate_num_insns_fn (tree, eni_weights *);
213 int estimate_num_insns_seq (gimple_seq, eni_weights *);
214 bool tree_versionable_function_p (tree);
215 extern tree remap_decl (tree decl, copy_body_data *id);
216 extern tree remap_type (tree type, copy_body_data *id);
217 extern gimple_seq copy_gimple_seq_and_replace_locals (gimple_seq seq);
218 extern bool debug_find_tree (tree, tree);
219 extern tree copy_fn (tree, tree&, tree&);
220 extern const char *copy_forbidden (struct function *fun);
221 extern tree copy_decl_for_dup_finish (copy_body_data *id, tree decl, tree copy);
223 /* This is in tree-inline.c since the routine uses
224 data structures from the inliner. */
225 extern tree build_duplicate_type (tree);
227 #endif /* GCC_TREE_INLINE_H */