2012-11-28 Oleg Raikhman <oleg@adapteva.com>
[official-gcc.git] / gcc / tree-inline.h
blobf6585fbf2b5b38d1998354c24f30a376f9368ec2
1 /* Tree inlining hooks and declarations.
2 Copyright 2001, 2003, 2004, 2005, 2007, 2008, 2009, 2010
3 Free Software Foundation, Inc.
4 Contributed by Alexandre Oliva <aoliva@redhat.com>
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
11 any later version.
13 GCC is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
22 #ifndef GCC_TREE_INLINE_H
23 #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 /* Data required for function body duplication. */
40 typedef struct copy_body_data
42 /* FUNCTION_DECL for function being inlined, or in general the
43 source function providing the original trees. */
44 tree src_fn;
46 /* FUNCTION_DECL for function being inlined into, or in general
47 the destination function receiving the new trees. */
48 tree dst_fn;
50 /* Callgraph node of the source function. */
51 struct cgraph_node *src_node;
53 /* Callgraph node of the destination function. */
54 struct cgraph_node *dst_node;
56 /* struct function for function being inlined. Usually this is the same
57 as DECL_STRUCT_FUNCTION (src_fn), but can be different if saved_cfg
58 and saved_eh are in use. */
59 struct function *src_cfun;
61 /* The VAR_DECL for the return value. */
62 tree retvar;
64 /* The map from local declarations in the inlined function to
65 equivalents in the function into which it is being inlined. */
66 struct pointer_map_t *decl_map;
68 /* Create a new decl to replace DECL in the destination function. */
69 tree (*copy_decl) (tree, struct copy_body_data *);
71 /* Current BLOCK. */
72 tree block;
74 /* GIMPLE_CALL if va arg parameter packs should be expanded or NULL
75 is not. */
76 gimple gimple_call;
78 /* Exception landing pad the inlined call lies in. */
79 int eh_lp_nr;
81 /* Maps region and landing pad structures from the function being copied
82 to duplicates created within the function we inline into. */
83 struct pointer_map_t *eh_map;
85 /* We use the same mechanism do all sorts of different things. Rather
86 than enumerating the different cases, we categorize the behavior
87 in the various situations. */
89 /* What to do with call graph edges. */
90 enum copy_body_cge_which transform_call_graph_edges;
92 /* True if a new CFG should be created. False for inlining, true for
93 everything else. */
94 bool transform_new_cfg;
96 /* True if RETURN_EXPRs should be transformed to just the contained
97 MODIFY_EXPR. The branch semantics of the return will be handled
98 by manipulating the CFG rather than a statement. */
99 bool transform_return_to_modify;
101 /* True if this statement will need to be regimplified. */
102 bool regimplify;
104 /* True if trees should not be unshared. */
105 bool do_not_unshare;
107 /* > 0 if we are remapping a type currently. */
108 int remapping_type_depth;
110 /* A function to be called when duplicating BLOCK nodes. */
111 void (*transform_lang_insert_block) (tree);
113 /* Statements that might be possibly folded. */
114 struct pointer_set_t *statements_to_fold;
116 /* Entry basic block to currently copied body. */
117 basic_block entry_bb;
119 /* Debug statements that need processing. */
120 vec<gimple> debug_stmts;
122 /* A map from local declarations in the inlined function to
123 equivalents in the function into which it is being inlined, where
124 the originals have been mapped to a value rather than to a
125 variable. */
126 struct pointer_map_t *debug_map;
127 } copy_body_data;
129 /* Weights of constructions for estimate_num_insns. */
131 typedef struct eni_weights_d
133 /* Cost per call. */
134 unsigned call_cost;
136 /* Cost per indirect call. */
137 unsigned indirect_call_cost;
139 /* Cost per call to a target specific builtin */
140 unsigned target_builtin_call_cost;
142 /* Cost of "expensive" div and mod operations. */
143 unsigned div_mod_cost;
145 /* Cost for omp construct. */
146 unsigned omp_cost;
148 /* Cost for tm transaction. */
149 unsigned tm_cost;
151 /* Cost of return. */
152 unsigned return_cost;
154 /* True when time of statemnt should be estimated. Thus i.e
155 cost of switch statement is logarithmic rather than linear in number
156 of cases. */
157 bool time_based;
158 } eni_weights;
160 /* Weights that estimate_num_insns uses for heuristics in inlining. */
162 extern eni_weights eni_inlining_weights;
164 /* Weights that estimate_num_insns uses to estimate the size of the
165 produced code. */
167 extern eni_weights eni_size_weights;
169 /* Weights that estimate_num_insns uses to estimate the time necessary
170 to execute the produced code. */
172 extern eni_weights eni_time_weights;
174 /* Function prototypes. */
176 extern tree copy_tree_body_r (tree *, int *, void *);
177 extern void insert_decl_map (copy_body_data *, tree, tree);
179 unsigned int optimize_inline_calls (tree);
180 tree maybe_inline_call_in_expr (tree);
181 bool tree_inlinable_function_p (tree);
182 tree copy_tree_r (tree *, int *, void *);
183 tree copy_decl_no_change (tree decl, copy_body_data *id);
184 int estimate_move_cost (tree type);
185 int estimate_num_insns (gimple, eni_weights *);
186 int estimate_num_insns_fn (tree, eni_weights *);
187 int count_insns_seq (gimple_seq, eni_weights *);
188 bool tree_versionable_function_p (tree);
190 extern tree remap_decl (tree decl, copy_body_data *id);
191 extern tree remap_type (tree type, copy_body_data *id);
192 extern gimple_seq copy_gimple_seq_and_replace_locals (gimple_seq seq);
194 extern HOST_WIDE_INT estimated_stack_frame_size (struct cgraph_node *);
196 #endif /* GCC_TREE_INLINE_H */