gcc/tree-inline.h

   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
   6 This file is part of GCC.
   7
   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.
  12
  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.
  17
  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/>.  */
  21
  22 #ifndef GCC_TREE_INLINE_H
  23 #define GCC_TREE_INLINE_H
  24
  25 #include "pointer-set.h"
  26
  27 struct 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
  33 enum 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
  42 typedef 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 region the inlined call lie in.  */
  81   int eh_region;
  82
  83   /* Take region number in the function being copied, add this value and
  84      get eh region number of the duplicate in the function we inline into.  */
  85   int eh_region_offset;
  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 } copy_body_data;
 121
 122 /* Weights of constructions for estimate_num_insns.  */
 123
 124 typedef struct eni_weights_d
 125 {
 126   /* Cost per call.  */
 127   unsigned call_cost;
 128
 129   /* Cost per call to a target specific builtin */
 130   unsigned target_builtin_call_cost;
 131
 132   /* Cost of "expensive" div and mod operations.  */
 133   unsigned div_mod_cost;
 134
 135   /* Cost for omp construct.  */
 136   unsigned omp_cost;
 137
 138   /* True when time of statemnt should be estimated.  Thus i.e
 139      cost of switch statement is logarithmic rather than linear in number
 140      of cases.  */
 141   bool time_based;
 142 } eni_weights;
 143
 144 /* Weights that estimate_num_insns uses for heuristics in inlining.  */
 145
 146 extern eni_weights eni_inlining_weights;
 147
 148 /* Weights that estimate_num_insns uses to estimate the size of the
 149    produced code.  */
 150
 151 extern eni_weights eni_size_weights;
 152
 153 /* Weights that estimate_num_insns uses to estimate the time necessary
 154    to execute the produced code.  */
 155
 156 extern eni_weights eni_time_weights;
 157
 158 /* Function prototypes.  */
 159
 160 extern tree copy_tree_body_r (tree *, int *, void *);
 161 extern void insert_decl_map (copy_body_data *, tree, tree);
 162
 163 unsigned int optimize_inline_calls (tree);
 164 tree maybe_inline_call_in_expr (tree);
 165 bool tree_inlinable_function_p (tree);
 166 tree copy_tree_r (tree *, int *, void *);
 167 tree copy_decl_no_change (tree decl, copy_body_data *id);
 168 void save_body (tree, tree *, tree *);
 169 int estimate_move_cost (tree type);
 170 int estimate_num_insns (gimple, eni_weights *);
 171 int estimate_num_insns_fn (tree, eni_weights *);
 172 int count_insns_seq (gimple_seq, eni_weights *);
 173 bool tree_versionable_function_p (tree);
 174 bool tree_can_inline_p (struct cgraph_edge *e);
 175
 176 extern gimple_seq remap_gimple_seq (gimple_seq, copy_body_data *);
 177 extern tree remap_decl (tree decl, copy_body_data *id);
 178 extern tree remap_type (tree type, copy_body_data *id);
 179 extern gimple_seq copy_gimple_seq_and_replace_locals (gimple_seq seq);
 180
 181 extern HOST_WIDE_INT estimated_stack_frame_size (void);
 182
 183 #endif /* GCC_TREE_INLINE_H */