1 /* Tree inlining hooks and declarations. 2 Copyright (C) 2001-2017 Free Software Foundation, Inc. 3 Contributed by Alexandre Oliva <aoliva@redhat.com> 4 5 This file is part of GCC. 6 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. 11 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. 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_TREE_INLINE_H 22 #define GCC_TREE_INLINE_H 23 24 25 struct 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 31 enum copy_body_cge_which 32 { 33 CB_CGE_DUPLICATE, 34 CB_CGE_MOVE, 35 CB_CGE_MOVE_CLONES 36 }; 37 38 typedef int_hash <unsigned short, 0> dependence_hash; 39 40 /* Data required for function body duplication. */ 41 42 struct copy_body_data 43 { 44 /* FUNCTION_DECL for function being inlined, or in general the 45 source function providing the original trees. */ 46 tree src_fn; 47 48 /* FUNCTION_DECL for function being inlined into, or in general 49 the destination function receiving the new trees. */ 50 tree dst_fn; 51 52 /* Callgraph node of the source function. */ 53 struct cgraph_node *src_node; 54 55 /* Callgraph node of the destination function. */ 56 struct cgraph_node *dst_node; 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. */ 61 struct function *src_cfun; 62 63 /* The VAR_DECL for the return value. */ 64 tree retvar; 65 66 /* The VAR_DECL for the return bounds. */ 67 tree retbnd; 68 69 /* Assign statements that need bounds copy. */ 70 vec<gimple *> assign_stmts; 71 72 /* The map from local declarations in the inlined function to 73 equivalents in the function into which it is being inlined. */ 74 hash_map<tree, tree> *decl_map; 75 76 /* Create a new decl to replace DECL in the destination function. */ 77 tree (*copy_decl) (tree, struct copy_body_data *); 78 79 /* Current BLOCK. */ 80 tree block; 81 82 /* GIMPLE_CALL if va arg parameter packs should be expanded or NULL 83 is not. */ 84 gcall *call_stmt; 85 86 /* Exception landing pad the inlined call lies in. */ 87 int eh_lp_nr; 88 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; 92 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. */ 96 97 /* What to do with call graph edges. */ 98 enum copy_body_cge_which transform_call_graph_edges; 99 100 /* True if a new CFG should be created. False for inlining, true for 101 everything else. */ 102 bool transform_new_cfg; 103 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; 108 109 /* True if the parameters of the source function are transformed. 110 Only true for inlining. */ 111 bool transform_parameter; 112 113 /* True if this statement will need to be regimplified. */ 114 bool regimplify; 115 116 /* True if trees should not be unshared. */ 117 bool do_not_unshare; 118 119 /* > 0 if we are remapping a type currently. */ 120 int remapping_type_depth; 121 122 /* Usually copy_decl callback always creates new decls, in that case 123 we want to remap all variably_modified_type_p types. If this flag 124 is set, remap_type will do further checks to see if remap_decl 125 of any decls mentioned in the type will remap to anything but itself 126 and only in that case will actually remap the type. */ 127 bool dont_remap_vla_if_no_change; 128 129 /* A function to be called when duplicating BLOCK nodes. */ 130 void (*transform_lang_insert_block) (tree); 131 132 /* Statements that might be possibly folded. */ 133 hash_set<gimple *> *statements_to_fold; 134 135 /* Entry basic block to currently copied body. */ 136 basic_block entry_bb; 137 138 /* For partial function versioning, bitmap of bbs to be copied, 139 otherwise NULL. */ 140 bitmap blocks_to_copy; 141 142 /* Debug statements that need processing. */ 143 vec<gdebug *> debug_stmts; 144 145 /* A map from local declarations in the inlined function to 146 equivalents in the function into which it is being inlined, where 147 the originals have been mapped to a value rather than to a 148 variable. */ 149 hash_map<tree, tree> *debug_map; 150 151 /* A map from the inlined functions dependence info cliques to 152 equivalents in the function into which it is being inlined. */ 153 hash_map<dependence_hash, unsigned short> *dependence_map; 154 155 /* A list of addressable local variables remapped into the caller 156 when inlining a call within an OpenMP SIMD-on-SIMT loop. */ 157 vec<tree> *dst_simt_vars; 158 159 /* Cilk keywords currently need to replace some variables that 160 ordinary nested functions do not. */ 161 bool remap_var_for_cilk; 162 163 /* Do not create new declarations when within type remapping. */ 164 bool prevent_decl_creation_for_types; 165 }; 166 167 /* Weights of constructions for estimate_num_insns. */ 168 169 struct eni_weights 170 { 171 /* Cost per call. */ 172 unsigned call_cost; 173 174 /* Cost per indirect call. */ 175 unsigned indirect_call_cost; 176 177 /* Cost per call to a target specific builtin */ 178 unsigned target_builtin_call_cost; 179 180 /* Cost of "expensive" div and mod operations. */ 181 unsigned div_mod_cost; 182 183 /* Cost for omp construct. */ 184 unsigned omp_cost; 185 186 /* Cost for tm transaction. */ 187 unsigned tm_cost; 188 189 /* Cost of return. */ 190 unsigned return_cost; 191 192 /* True when time of statement should be estimated. Thus, the 193 cost of a switch statement is logarithmic rather than linear in number 194 of cases. */ 195 bool time_based; 196 }; 197 198 /* Weights that estimate_num_insns uses for heuristics in inlining. */ 199 200 extern eni_weights eni_inlining_weights; 201 202 /* Weights that estimate_num_insns uses to estimate the size of the 203 produced code. */ 204 205 extern eni_weights eni_size_weights; 206 207 /* Weights that estimate_num_insns uses to estimate the time necessary 208 to execute the produced code. */ 209 210 extern eni_weights eni_time_weights; 211 212 /* Function prototypes. */ 213 void init_inline_once (void); 214 extern tree copy_tree_body_r (tree *, int *, void *); 215 extern void insert_decl_map (copy_body_data *, tree, tree); 216 unsigned int optimize_inline_calls (tree); 217 tree maybe_inline_call_in_expr (tree); 218 bool tree_inlinable_function_p (tree); 219 tree copy_tree_r (tree *, int *, void *); 220 tree copy_decl_no_change (tree decl, copy_body_data *id); 221 int estimate_move_cost (tree type, bool); 222 int estimate_num_insns (gimple *, eni_weights *); 223 int estimate_num_insns_fn (tree, eni_weights *); 224 int estimate_num_insns_seq (gimple_seq, eni_weights *); 225 bool tree_versionable_function_p (tree); 226 extern tree remap_decl (tree decl, copy_body_data *id); 227 extern tree remap_type (tree type, copy_body_data *id); 228 extern gimple_seq copy_gimple_seq_and_replace_locals (gimple_seq seq); 229 extern bool debug_find_tree (tree, tree); 230 extern tree copy_fn (tree, tree&, tree&); 231 extern const char *copy_forbidden (struct function *fun); 232 extern tree copy_decl_for_dup_finish (copy_body_data *id, tree decl, tree copy); 233 234 /* This is in tree-inline.c since the routine uses 235 data structures from the inliner. */ 236 extern tree build_duplicate_type (tree); 237 238 #endif /* GCC_TREE_INLINE_H */ 239