1/* Tree inlining hooks and declarations.
2   Copyright 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
3   Contributed by Alexandre Oliva  <aoliva@redhat.com>
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
9the Free Software Foundation; either version 2, or (at your option)
10any later version.
11
12GCC is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING.  If not, write to
19the Free Software Foundation, 51 Franklin Street, Fifth Floor,
20Boston, MA 02110-1301, USA.  */
21
22#ifndef GCC_TREE_INLINE_H
23#define GCC_TREE_INLINE_H
24
25#include "varray.h"
26#include "splay-tree.h"
27
28
29/* Data required for function body duplication.  */
30
31typedef struct copy_body_data
32{
33  /* FUNCTION_DECL for function being inlined, or in general the
34     source function providing the original trees.  */
35  tree src_fn;
36  /* FUNCTION_DECL for function being inlined into, or in general
37     the destination function receiving the new trees.  */
38  tree dst_fn;
39  /* Callgraph node of the source function.  */
40  struct cgraph_node *src_node;
41  /* Callgraph node of the destination function.  */
42  struct cgraph_node *dst_node;
43  /* struct function for function being inlined.  Usually this is the same
44     as DECL_STRUCT_FUNCTION (src_fn), but can be different if saved_cfg
45     and saved_eh are in use.  */
46  struct function *src_cfun;
47
48  /* The VAR_DECL for the return value.  */
49  tree retvar;
50  /* The map from local declarations in the inlined function to
51     equivalents in the function into which it is being inlined.  */
52  splay_tree decl_map;
53
54  /* Create a new decl to replace DECL in the destination function.  */
55  tree (*copy_decl) (tree, struct copy_body_data *);
56
57  /* Current BLOCK.  */
58  tree block;
59
60  /* Exception region the inlined call lie in.  */
61  int eh_region;
62  /* Take region number in the function being copied, add this value and
63     get eh region number of the duplicate in the function we inline into.  */
64  int eh_region_offset;
65
66  /* We use the same mechanism do all sorts of different things.  Rather
67     than enumerating the different cases, we categorize the behavior
68     in the various situations.  */
69
70  /* Indicate the desired behavior wrt call graph edges.  We can either
71     duplicate the edge (inlining, cloning), move the edge (versioning,
72     parallelization), or move the edges of the clones (saving).  */
73  enum copy_body_cge_which {
74    CB_CGE_DUPLICATE,
75    CB_CGE_MOVE,
76    CB_CGE_MOVE_CLONES
77  } transform_call_graph_edges;
78
79  /* True if a new CFG should be created.  False for inlining, true for
80     everything else.  */
81  bool transform_new_cfg;
82
83  /* True if RETURN_EXPRs should be transformed to just the contained
84     MODIFY_EXPR.  The branch semantics of the return will be handled
85     by manipulating the CFG rather than a statement.  */
86  bool transform_return_to_modify;
87
88  /* True if lang_hooks.decls.insert_block should be invoked when
89     duplicating BLOCK nodes.  */
90  bool transform_lang_insert_block;
91} copy_body_data;
92
93/* Function prototypes.  */
94
95extern tree copy_body_r (tree *, int *, void *);
96extern void insert_decl_map (copy_body_data *, tree, tree);
97
98void optimize_inline_calls (tree);
99bool tree_inlinable_function_p (tree);
100tree copy_tree_r (tree *, int *, void *);
101void clone_body (tree, tree, void *);
102void save_body (tree, tree *, tree *);
103int estimate_move_cost (tree type);
104void push_cfun (struct function *new_cfun);
105void pop_cfun (void);
106int estimate_num_insns (tree expr);
107bool tree_versionable_function_p (tree);
108void tree_function_versioning (tree, tree, varray_type, bool);
109
110extern tree remap_decl (tree decl, copy_body_data *id);
111extern tree remap_type (tree type, copy_body_data *id);
112
113/* 0 if we should not perform inlining.
114   1 if we should expand functions calls inline at the tree level.
115   2 if we should consider *all* functions to be inline
116   candidates.  */
117
118extern int flag_inline_trees;
119
120#endif /* GCC_TREE_INLINE_H */
121