1/* Tree inlining hooks and declarations.
2   Copyright 2001, 2003, 2004, 2005, 2007, 2008, 2009
3   Free Software Foundation, Inc.
4   Contributed by Alexandre Oliva  <aoliva@redhat.com>
5
6This file is part of GCC.
7
8GCC is free software; you can redistribute it and/or modify
9it under the terms of the GNU General Public License as published by
10the Free Software Foundation; either version 3, or (at your option)
11any later version.
12
13GCC is distributed in the hope that it will be useful,
14but WITHOUT ANY WARRANTY; without even the implied warranty of
15MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16GNU General Public License for more details.
17
18You should have received a copy of the GNU General Public License
19along with GCC; see the file COPYING3.  If not see
20<http://www.gnu.org/licenses/>.  */
21
22#ifndef GCC_TREE_INLINE_H
23#define GCC_TREE_INLINE_H
24
25#include "gimple.h"
26
27struct cgraph_edge;
28
29/* Indicate the desired behavior wrt call graph edges.  We can either
30   duplicate the edge (inlining, cloning), move the edge (versioning,
31   parallelization), or move the edges of the clones (saving).  */
32
33enum copy_body_cge_which
34{
35  CB_CGE_DUPLICATE,
36  CB_CGE_MOVE,
37  CB_CGE_MOVE_CLONES
38};
39
40/* Data required for function body duplication.  */
41
42typedef 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 map from local declarations in the inlined function to
67     equivalents in the function into which it is being inlined.  */
68  struct pointer_map_t *decl_map;
69
70  /* Create a new decl to replace DECL in the destination function.  */
71  tree (*copy_decl) (tree, struct copy_body_data *);
72
73  /* Current BLOCK.  */
74  tree block;
75
76  /* GIMPLE_CALL if va arg parameter packs should be expanded or NULL
77     is not.  */
78  gimple gimple_call;
79
80  /* Exception landing pad the inlined call lies in.  */
81  int eh_lp_nr;
82
83  /* Maps region and landing pad structures from the function being copied
84     to duplicates created within the function we inline into.  */
85  struct pointer_map_t *eh_map;
86
87  /* We use the same mechanism do all sorts of different things.  Rather
88     than enumerating the different cases, we categorize the behavior
89     in the various situations.  */
90
91  /* What to do with call graph edges.  */
92  enum copy_body_cge_which transform_call_graph_edges;
93
94  /* True if a new CFG should be created.  False for inlining, true for
95     everything else.  */
96  bool transform_new_cfg;
97
98  /* True if RETURN_EXPRs should be transformed to just the contained
99     MODIFY_EXPR.  The branch semantics of the return will be handled
100     by manipulating the CFG rather than a statement.  */
101  bool transform_return_to_modify;
102
103  /* True if this statement will need to be regimplified.  */
104  bool regimplify;
105
106  /* True if trees should not be unshared.  */
107  bool do_not_unshare;
108
109  /* > 0 if we are remapping a type currently.  */
110  int remapping_type_depth;
111
112  /* A function to be called when duplicating BLOCK nodes.  */
113  void (*transform_lang_insert_block) (tree);
114
115  /* Statements that might be possibly folded.  */
116  struct pointer_set_t *statements_to_fold;
117
118  /* Entry basic block to currently copied body.  */
119  struct basic_block_def *entry_bb;
120
121  /* Debug statements that need processing.  */
122  VEC(gimple,heap) *debug_stmts;
123
124  /* A map from local declarations in the inlined function to
125     equivalents in the function into which it is being inlined, where
126     the originals have been mapped to a value rather than to a
127     variable.  */
128  struct pointer_map_t *debug_map;
129} copy_body_data;
130
131/* Weights of constructions for estimate_num_insns.  */
132
133typedef struct eni_weights_d
134{
135  /* Cost per call.  */
136  unsigned call_cost;
137
138  /* Cost per call to a target specific builtin */
139  unsigned target_builtin_call_cost;
140
141  /* Cost of "expensive" div and mod operations.  */
142  unsigned div_mod_cost;
143
144  /* Cost for omp construct.  */
145  unsigned omp_cost;
146
147  /* True when time of statemnt should be estimated.  Thus i.e
148     cost of switch statement is logarithmic rather than linear in number
149     of cases.  */
150  bool time_based;
151} eni_weights;
152
153/* Weights that estimate_num_insns uses for heuristics in inlining.  */
154
155extern eni_weights eni_inlining_weights;
156
157/* Weights that estimate_num_insns uses to estimate the size of the
158   produced code.  */
159
160extern eni_weights eni_size_weights;
161
162/* Weights that estimate_num_insns uses to estimate the time necessary
163   to execute the produced code.  */
164
165extern eni_weights eni_time_weights;
166
167/* Function prototypes.  */
168
169extern tree copy_tree_body_r (tree *, int *, void *);
170extern void insert_decl_map (copy_body_data *, tree, tree);
171
172unsigned int optimize_inline_calls (tree);
173tree maybe_inline_call_in_expr (tree);
174bool tree_inlinable_function_p (tree);
175tree copy_tree_r (tree *, int *, void *);
176tree copy_decl_no_change (tree decl, copy_body_data *id);
177void save_body (tree, tree *, tree *);
178int estimate_move_cost (tree type);
179int estimate_num_insns (gimple, eni_weights *);
180int estimate_num_insns_fn (tree, eni_weights *);
181int count_insns_seq (gimple_seq, eni_weights *);
182bool tree_versionable_function_p (tree);
183bool tree_can_inline_p (struct cgraph_edge *e);
184
185extern gimple_seq remap_gimple_seq (gimple_seq, copy_body_data *);
186extern tree remap_decl (tree decl, copy_body_data *id);
187extern tree remap_type (tree type, copy_body_data *id);
188extern gimple_seq copy_gimple_seq_and_replace_locals (gimple_seq seq);
189
190extern HOST_WIDE_INT estimated_stack_frame_size (void);
191
192#endif /* GCC_TREE_INLINE_H */
193