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
  28 /* Indicate the desired behavior wrt call graph edges.  We can either
  29    duplicate the edge (inlining, cloning), move the edge (versioning,
  30    parallelization), or move the edges of the clones (saving).  */
  31
  32 enum copy_body_cge_which
  33 {
  34   CB_CGE_DUPLICATE,
  35   CB_CGE_MOVE,
  36   CB_CGE_MOVE_CLONES
  37 };
  38
  39 /* Data required for function body duplication.  */
  40
  41 typedef struct copy_body_data
  42 {
  43   /* FUNCTION_DECL for function being inlined, or in general the
  44      source function providing the original trees.  */
  45   tree src_fn;
  46
  47   /* FUNCTION_DECL for function being inlined into, or in general
  48      the destination function receiving the new trees.  */
  49   tree dst_fn;
  50
  51   /* Callgraph node of the source function.  */
  52   struct cgraph_node *src_node;
  53
  54   /* Callgraph node of the destination function.  */
  55   struct cgraph_node *dst_node;
  56
  57   /* struct function for function being inlined.  Usually this is the same
  58      as DECL_STRUCT_FUNCTION (src_fn), but can be different if saved_cfg
  59      and saved_eh are in use.  */
  60   struct function *src_cfun;
  61
  62   /* The VAR_DECL for the return value.  */
  63   tree retvar;
  64
  65   /* The map from local declarations in the inlined function to
  66      equivalents in the function into which it is being inlined.  */
  67   struct pointer_map_t *decl_map;
  68
  69   /* Create a new decl to replace DECL in the destination function.  */
  70   tree (*copy_decl) (tree, struct copy_body_data *);
  71
  72   /* Current BLOCK.  */
  73   tree block;
  74
  75   /* GIMPLE_CALL if va arg parameter packs should be expanded or NULL
  76      is not.  */
  77   gimple gimple_call;
  78
  79   /* Exception region the inlined call lie in.  */
  80   int eh_region;
  81
  82   /* Take region number in the function being copied, add this value and
  83      get eh region number of the duplicate in the function we inline into.  */
  84   int eh_region_offset;
  85
  86   /* We use the same mechanism do all sorts of different things.  Rather
  87      than enumerating the different cases, we categorize the behavior
  88      in the various situations.  */
  89
  90   /* What to do with call graph edges.  */
  91   enum copy_body_cge_which transform_call_graph_edges;
  92
  93   /* True if a new CFG should be created.  False for inlining, true for
  94      everything else.  */
  95   bool transform_new_cfg;
  96
  97   /* True if RETURN_EXPRs should be transformed to just the contained
  98      MODIFY_EXPR.  The branch semantics of the return will be handled
  99      by manipulating the CFG rather than a statement.  */
 100   bool transform_return_to_modify;
 101
 102   /* True if this statement will need to be regimplified.  */
 103   bool regimplify;
 104
 105   /* True if trees should not be unshared.  */
 106   bool do_not_unshare;
 107
 108   /* > 0 if we are remapping a type currently.  */
 109   int remapping_type_depth;
 110
 111   /* A function to be called when duplicating BLOCK nodes.  */
 112   void (*transform_lang_insert_block) (tree);
 113
 114   /* Statements that might be possibly folded.  */
 115   struct pointer_set_t *statements_to_fold;
 116
 117   /* Entry basic block to currently copied body.  */
 118   struct basic_block_def *entry_bb;
 119 } copy_body_data;
 120
 121 /* Weights of constructions for estimate_num_insns.  */
 122
 123 typedef struct eni_weights_d
 124 {
 125   /* Cost per call.  */
 126   unsigned call_cost;
 127
 128   /* Cost per call to a target specific builtin */
 129   unsigned target_builtin_call_cost;
 130
 131   /* Cost of "expensive" div and mod operations.  */
 132   unsigned div_mod_cost;
 133
 134   /* Cost for omp construct.  */
 135   unsigned omp_cost;
 136
 137   /* True when time of statemnt should be estimated.  Thus i.e
 138      cost of switch statement is logarithmic rather than linear in number
 139      of cases.  */
 140   bool time_based;
 141 } eni_weights;
 142
 143 /* Weights that estimate_num_insns uses for heuristics in inlining.  */
 144
 145 extern eni_weights eni_inlining_weights;
 146
 147 /* Weights that estimate_num_insns uses to estimate the size of the
 148    produced code.  */
 149
 150 extern eni_weights eni_size_weights;
 151
 152 /* Weights that estimate_num_insns uses to estimate the time necessary
 153    to execute the produced code.  */
 154
 155 extern eni_weights eni_time_weights;
 156
 157 /* Function prototypes.  */
 158
 159 extern tree copy_tree_body_r (tree *, int *, void *);
 160 extern void insert_decl_map (copy_body_data *, tree, tree);
 161
 162 unsigned int optimize_inline_calls (tree);
 163 tree maybe_inline_call_in_expr (tree);
 164 bool tree_inlinable_function_p (tree);
 165 tree copy_tree_r (tree *, int *, void *);
 166 tree copy_decl_no_change (tree decl, copy_body_data *id);
 167 void save_body (tree, tree *, tree *);
 168 int estimate_move_cost (tree type);
 169 int estimate_num_insns (gimple, eni_weights *);
 170 int estimate_num_insns_fn (tree, eni_weights *);
 171 int count_insns_seq (gimple_seq, eni_weights *);
 172 bool tree_versionable_function_p (tree);
 173 bool tree_can_inline_p (tree, tree);
 174
 175 extern gimple_seq remap_gimple_seq (gimple_seq, copy_body_data *);
 176 extern tree remap_decl (tree decl, copy_body_data *id);
 177 extern tree remap_type (tree type, copy_body_data *id);
 178 extern gimple_seq copy_gimple_seq_and_replace_locals (gimple_seq seq);
 179
 180 extern HOST_WIDE_INT estimated_stack_frame_size (void);
 181
 182 #endif /* GCC_TREE_INLINE_H */