Update concepts branch to revision 131834
[official-gcc.git] / gcc / tree-inline.h
bloba69afd00f99b7dacc96f2282e79bdfbb6c916867
1 /* Tree inlining hooks and declarations.
2 Copyright 2001, 2003, 2004, 2005, 2007 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 #include "varray.h"
25 #include "pointer-set.h"
28 /* Data required for function body duplication. */
30 typedef struct copy_body_data
32 /* FUNCTION_DECL for function being inlined, or in general the
33 source function providing the original trees. */
34 tree src_fn;
35 /* FUNCTION_DECL for function being inlined into, or in general
36 the destination function receiving the new trees. */
37 tree dst_fn;
38 /* Callgraph node of the source function. */
39 struct cgraph_node *src_node;
40 /* Callgraph node of the destination function. */
41 struct cgraph_node *dst_node;
42 /* struct function for function being inlined. Usually this is the same
43 as DECL_STRUCT_FUNCTION (src_fn), but can be different if saved_cfg
44 and saved_eh are in use. */
45 struct function *src_cfun;
47 /* The VAR_DECL for the return value. */
48 tree retvar;
49 /* The map from local declarations in the inlined function to
50 equivalents in the function into which it is being inlined. */
51 struct pointer_map_t *decl_map;
53 /* Create a new decl to replace DECL in the destination function. */
54 tree (*copy_decl) (tree, struct copy_body_data *);
56 /* Current BLOCK. */
57 tree block;
59 /* CALL_EXPR if va arg parameter packs should be expanded or NULL
60 is not. */
61 tree call_expr;
63 /* Exception region the inlined call lie in. */
64 int eh_region;
65 /* Take region number in the function being copied, add this value and
66 get eh region number of the duplicate in the function we inline into. */
67 int eh_region_offset;
69 /* We use the same mechanism do all sorts of different things. Rather
70 than enumerating the different cases, we categorize the behavior
71 in the various situations. */
73 /* Indicate the desired behavior wrt call graph edges. We can either
74 duplicate the edge (inlining, cloning), move the edge (versioning,
75 parallelization), or move the edges of the clones (saving). */
76 enum copy_body_cge_which {
77 CB_CGE_DUPLICATE,
78 CB_CGE_MOVE,
79 CB_CGE_MOVE_CLONES
80 } transform_call_graph_edges;
82 /* True if a new CFG should be created. False for inlining, true for
83 everything else. */
84 bool transform_new_cfg;
86 /* True if RETURN_EXPRs should be transformed to just the contained
87 MODIFY_EXPR. The branch semantics of the return will be handled
88 by manipulating the CFG rather than a statement. */
89 bool transform_return_to_modify;
91 /* True if this statement will need to be regimplified. */
92 bool regimplify;
94 /* > 0 if we are remapping a type currently. */
95 int remapping_type_depth;
97 /* A function to be called when duplicating BLOCK nodes. */
98 void (*transform_lang_insert_block) (tree);
100 /* Statements that might be possibly folded. */
101 struct pointer_set_t *statements_to_fold;
103 /* Entry basic block to currently copied body. */
104 struct basic_block_def *entry_bb;
105 } copy_body_data;
107 /* Weights of constructions for estimate_num_insns. */
109 typedef struct eni_weights_d
111 /* Cost per call. */
112 unsigned call_cost;
114 /* Cost per call to a target specific builtin */
115 unsigned target_builtin_call_cost;
117 /* Cost of "expensive" div and mod operations. */
118 unsigned div_mod_cost;
120 /* Cost for omp construct. */
121 unsigned omp_cost;
122 } eni_weights;
124 /* Weights that estimate_num_insns uses for heuristics in inlining. */
126 extern eni_weights eni_inlining_weights;
128 /* Weights that estimate_num_insns uses to estimate the size of the
129 produced code. */
131 extern eni_weights eni_size_weights;
133 /* Weights that estimate_num_insns uses to estimate the time necessary
134 to execute the produced code. */
136 extern eni_weights eni_time_weights;
138 /* Function prototypes. */
140 extern tree copy_body_r (tree *, int *, void *);
141 extern void insert_decl_map (copy_body_data *, tree, tree);
143 unsigned int optimize_inline_calls (tree);
144 bool tree_inlinable_function_p (tree);
145 tree copy_tree_r (tree *, int *, void *);
146 tree copy_generic_body (copy_body_data *id);
147 tree copy_decl_no_change (tree decl, copy_body_data *id);
148 void save_body (tree, tree *, tree *);
149 int estimate_move_cost (tree type);
150 int estimate_num_insns (tree expr, eni_weights *);
151 bool tree_versionable_function_p (tree);
152 void tree_function_versioning (tree, tree, varray_type, bool);
154 extern tree remap_decl (tree decl, copy_body_data *id);
155 extern tree remap_type (tree type, copy_body_data *id);
157 extern HOST_WIDE_INT estimated_stack_frame_size (void);
159 /* 0 if we should not perform inlining.
160 1 if we should expand functions calls inline at the tree level.
161 2 if we should consider *all* functions to be inline
162 candidates. */
164 extern int flag_inline_trees;
166 #endif /* GCC_TREE_INLINE_H */