Daily bump.
[official-gcc.git] / gcc / tree-inline.h
blob13c551666ddf940ac1c412fe26b00ecb0eabf0e4
1 /* Tree inlining hooks and declarations.
2 Copyright (C) 2001-2014 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
24 struct cgraph_edge;
26 /* Indicate the desired behavior wrt call graph edges. We can either
27 duplicate the edge (inlining, cloning), move the edge (versioning,
28 parallelization), or move the edges of the clones (saving). */
30 enum copy_body_cge_which
32 CB_CGE_DUPLICATE,
33 CB_CGE_MOVE,
34 CB_CGE_MOVE_CLONES
37 /* Data required for function body duplication. */
39 struct copy_body_data
41 /* FUNCTION_DECL for function being inlined, or in general the
42 source function providing the original trees. */
43 tree src_fn;
45 /* FUNCTION_DECL for function being inlined into, or in general
46 the destination function receiving the new trees. */
47 tree dst_fn;
49 /* Callgraph node of the source function. */
50 struct cgraph_node *src_node;
52 /* Callgraph node of the destination function. */
53 struct cgraph_node *dst_node;
55 /* struct function for function being inlined. Usually this is the same
56 as DECL_STRUCT_FUNCTION (src_fn), but can be different if saved_cfg
57 and saved_eh are in use. */
58 struct function *src_cfun;
60 /* The VAR_DECL for the return value. */
61 tree retvar;
63 /* The map from local declarations in the inlined function to
64 equivalents in the function into which it is being inlined. */
65 struct pointer_map_t *decl_map;
67 /* Create a new decl to replace DECL in the destination function. */
68 tree (*copy_decl) (tree, struct copy_body_data *);
70 /* Current BLOCK. */
71 tree block;
73 /* GIMPLE_CALL if va arg parameter packs should be expanded or NULL
74 is not. */
75 gimple gimple_call;
77 /* Exception landing pad the inlined call lies in. */
78 int eh_lp_nr;
80 /* Maps region and landing pad structures from the function being copied
81 to duplicates created within the function we inline into. */
82 struct pointer_map_t *eh_map;
84 /* We use the same mechanism do all sorts of different things. Rather
85 than enumerating the different cases, we categorize the behavior
86 in the various situations. */
88 /* What to do with call graph edges. */
89 enum copy_body_cge_which transform_call_graph_edges;
91 /* True if a new CFG should be created. False for inlining, true for
92 everything else. */
93 bool transform_new_cfg;
95 /* True if RETURN_EXPRs should be transformed to just the contained
96 MODIFY_EXPR. The branch semantics of the return will be handled
97 by manipulating the CFG rather than a statement. */
98 bool transform_return_to_modify;
100 /* True if the parameters of the source function are transformed.
101 Only true for inlining. */
102 bool transform_parameter;
104 /* True if this statement will need to be regimplified. */
105 bool regimplify;
107 /* True if trees should not be unshared. */
108 bool do_not_unshare;
110 /* > 0 if we are remapping a type currently. */
111 int remapping_type_depth;
113 /* A function to be called when duplicating BLOCK nodes. */
114 void (*transform_lang_insert_block) (tree);
116 /* Statements that might be possibly folded. */
117 struct pointer_set_t *statements_to_fold;
119 /* Entry basic block to currently copied body. */
120 basic_block entry_bb;
122 /* For partial function versioning, bitmap of bbs to be copied,
123 otherwise NULL. */
124 bitmap blocks_to_copy;
126 /* Debug statements that need processing. */
127 vec<gimple> debug_stmts;
129 /* A map from local declarations in the inlined function to
130 equivalents in the function into which it is being inlined, where
131 the originals have been mapped to a value rather than to a
132 variable. */
133 struct pointer_map_t *debug_map;
135 /* Cilk keywords currently need to replace some variables that
136 ordinary nested functions do not. */
137 bool remap_var_for_cilk;
140 /* Weights of constructions for estimate_num_insns. */
142 typedef struct eni_weights_d
144 /* Cost per call. */
145 unsigned call_cost;
147 /* Cost per indirect call. */
148 unsigned indirect_call_cost;
150 /* Cost per call to a target specific builtin */
151 unsigned target_builtin_call_cost;
153 /* Cost of "expensive" div and mod operations. */
154 unsigned div_mod_cost;
156 /* Cost for omp construct. */
157 unsigned omp_cost;
159 /* Cost for tm transaction. */
160 unsigned tm_cost;
162 /* Cost of return. */
163 unsigned return_cost;
165 /* True when time of statement should be estimated. Thus, the
166 cost of a switch statement is logarithmic rather than linear in number
167 of cases. */
168 bool time_based;
169 } eni_weights;
171 /* Weights that estimate_num_insns uses for heuristics in inlining. */
173 extern eni_weights eni_inlining_weights;
175 /* Weights that estimate_num_insns uses to estimate the size of the
176 produced code. */
178 extern eni_weights eni_size_weights;
180 /* Weights that estimate_num_insns uses to estimate the time necessary
181 to execute the produced code. */
183 extern eni_weights eni_time_weights;
185 /* Function prototypes. */
186 void init_inline_once (void);
187 extern tree copy_tree_body_r (tree *, int *, void *);
188 extern void insert_decl_map (copy_body_data *, tree, tree);
189 unsigned int optimize_inline_calls (tree);
190 tree maybe_inline_call_in_expr (tree);
191 bool tree_inlinable_function_p (tree);
192 tree copy_tree_r (tree *, int *, void *);
193 tree copy_decl_no_change (tree decl, copy_body_data *id);
194 int estimate_move_cost (tree type);
195 int estimate_num_insns (gimple, eni_weights *);
196 int estimate_num_insns_fn (tree, eni_weights *);
197 int count_insns_seq (gimple_seq, eni_weights *);
198 bool tree_versionable_function_p (tree);
199 extern tree remap_decl (tree decl, copy_body_data *id);
200 extern tree remap_type (tree type, copy_body_data *id);
201 extern gimple_seq copy_gimple_seq_and_replace_locals (gimple_seq seq);
202 extern bool debug_find_tree (tree, tree);
204 /* This is in tree-inline.c since the routine uses
205 data structures from the inliner. */
206 extern tree build_duplicate_type (tree);
208 #endif /* GCC_TREE_INLINE_H */