gcc/tree-inline.h

   1 /* Tree inlining hooks and declarations.
   2    Copyright (C) 2001-2014 Free Software Foundation, Inc.
   3    Contributed by Alexandre Oliva  <aoliva@redhat.com>
   4
   5 This file is part of GCC.
   6
   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.
  11
  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.
  16
  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/>.  */
  20
  21 #ifndef GCC_TREE_INLINE_H
  22 #define GCC_TREE_INLINE_H
  23
  24 #include "hash-map.h"
  25 #include "hash-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 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   hash_map<tree, tree> *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   hash_map<void *, void *> *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 the parameters of the source function are transformed.
 104      Only true for inlining.  */
 105   bool transform_parameter;
 106
 107   /* True if this statement will need to be regimplified.  */
 108   bool regimplify;
 109
 110   /* True if trees should not be unshared.  */
 111   bool do_not_unshare;
 112
 113   /* > 0 if we are remapping a type currently.  */
 114   int remapping_type_depth;
 115
 116   /* A function to be called when duplicating BLOCK nodes.  */
 117   void (*transform_lang_insert_block) (tree);
 118
 119   /* Statements that might be possibly folded.  */
 120   hash_set<gimple> *statements_to_fold;
 121
 122   /* Entry basic block to currently copied body.  */
 123   basic_block entry_bb;
 124
 125   /* For partial function versioning, bitmap of bbs to be copied,
 126      otherwise NULL.  */
 127   bitmap blocks_to_copy;
 128
 129   /* Debug statements that need processing.  */
 130   vec<gimple> debug_stmts;
 131
 132   /* A map from local declarations in the inlined function to
 133      equivalents in the function into which it is being inlined, where
 134      the originals have been mapped to a value rather than to a
 135      variable.  */
 136   hash_map<tree, tree> *debug_map;
 137
 138   /* Cilk keywords currently need to replace some variables that
 139      ordinary nested functions do not.  */
 140   bool remap_var_for_cilk;
 141 };
 142
 143 /* Weights of constructions for estimate_num_insns.  */
 144
 145 typedef struct eni_weights_d
 146 {
 147   /* Cost per call.  */
 148   unsigned call_cost;
 149
 150   /* Cost per indirect call.  */
 151   unsigned indirect_call_cost;
 152
 153   /* Cost per call to a target specific builtin */
 154   unsigned target_builtin_call_cost;
 155
 156   /* Cost of "expensive" div and mod operations.  */
 157   unsigned div_mod_cost;
 158
 159   /* Cost for omp construct.  */
 160   unsigned omp_cost;
 161
 162   /* Cost for tm transaction.  */
 163   unsigned tm_cost;
 164
 165   /* Cost of return.  */
 166   unsigned return_cost;
 167
 168   /* True when time of statement should be estimated.  Thus, the
 169      cost of a switch statement is logarithmic rather than linear in number
 170      of cases.  */
 171   bool time_based;
 172 } eni_weights;
 173
 174 /* Weights that estimate_num_insns uses for heuristics in inlining.  */
 175
 176 extern eni_weights eni_inlining_weights;
 177
 178 /* Weights that estimate_num_insns uses to estimate the size of the
 179    produced code.  */
 180
 181 extern eni_weights eni_size_weights;
 182
 183 /* Weights that estimate_num_insns uses to estimate the time necessary
 184    to execute the produced code.  */
 185
 186 extern eni_weights eni_time_weights;
 187
 188 /* Function prototypes.  */
 189 void init_inline_once (void);
 190 extern tree copy_tree_body_r (tree *, int *, void *);
 191 extern void insert_decl_map (copy_body_data *, tree, tree);
 192 unsigned int optimize_inline_calls (tree);
 193 tree maybe_inline_call_in_expr (tree);
 194 bool tree_inlinable_function_p (tree);
 195 tree copy_tree_r (tree *, int *, void *);
 196 tree copy_decl_no_change (tree decl, copy_body_data *id);
 197 int estimate_move_cost (tree type, bool);
 198 int estimate_num_insns (gimple, eni_weights *);
 199 int estimate_num_insns_fn (tree, eni_weights *);
 200 int count_insns_seq (gimple_seq, eni_weights *);
 201 bool tree_versionable_function_p (tree);
 202 extern tree remap_decl (tree decl, copy_body_data *id);
 203 extern tree remap_type (tree type, copy_body_data *id);
 204 extern gimple_seq copy_gimple_seq_and_replace_locals (gimple_seq seq);
 205 extern bool debug_find_tree (tree, tree);
 206
 207 /* This is in tree-inline.c since the routine uses
 208    data structures from the inliner.  */
 209 extern tree build_duplicate_type (tree);
 210
 211 #endif /* GCC_TREE_INLINE_H */