gcc/tree-inline.h

   1 /* Tree inlining hooks and declarations.
   2    Copyright (C) 2001-2015 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
  25 struct cgraph_edge;
  26
  27 /* Indicate the desired behavior wrt call graph edges.  We can either
  28    duplicate the edge (inlining, cloning), move the edge (versioning,
  29    parallelization), or move the edges of the clones (saving).  */
  30
  31 enum copy_body_cge_which
  32 {
  33   CB_CGE_DUPLICATE,
  34   CB_CGE_MOVE,
  35   CB_CGE_MOVE_CLONES
  36 };
  37
  38 typedef int_hash <unsigned short, 0> dependence_hash;
  39 typedef simple_hashmap_traits <dependence_hash> dependence_hasher;
  40
  41 /* Data required for function body duplication.  */
  42
  43 struct copy_body_data
  44 {
  45   /* FUNCTION_DECL for function being inlined, or in general the
  46      source function providing the original trees.  */
  47   tree src_fn;
  48
  49   /* FUNCTION_DECL for function being inlined into, or in general
  50      the destination function receiving the new trees.  */
  51   tree dst_fn;
  52
  53   /* Callgraph node of the source function.  */
  54   struct cgraph_node *src_node;
  55
  56   /* Callgraph node of the destination function.  */
  57   struct cgraph_node *dst_node;
  58
  59   /* struct function for function being inlined.  Usually this is the same
  60      as DECL_STRUCT_FUNCTION (src_fn), but can be different if saved_cfg
  61      and saved_eh are in use.  */
  62   struct function *src_cfun;
  63
  64   /* The VAR_DECL for the return value.  */
  65   tree retvar;
  66
  67   /* The VAR_DECL for the return bounds.  */
  68   tree retbnd;
  69
  70   /* Assign statements that need bounds copy.  */
  71   vec<gimple> assign_stmts;
  72
  73   /* The map from local declarations in the inlined function to
  74      equivalents in the function into which it is being inlined.  */
  75   hash_map<tree, tree> *decl_map;
  76
  77   /* Create a new decl to replace DECL in the destination function.  */
  78   tree (*copy_decl) (tree, struct copy_body_data *);
  79
  80   /* Current BLOCK.  */
  81   tree block;
  82
  83   /* GIMPLE_CALL if va arg parameter packs should be expanded or NULL
  84      is not.  */
  85   gimple call_stmt;
  86
  87   /* Exception landing pad the inlined call lies in.  */
  88   int eh_lp_nr;
  89
  90   /* Maps region and landing pad structures from the function being copied
  91      to duplicates created within the function we inline into.  */
  92   hash_map<void *, void *> *eh_map;
  93
  94   /* We use the same mechanism do all sorts of different things.  Rather
  95      than enumerating the different cases, we categorize the behavior
  96      in the various situations.  */
  97
  98   /* What to do with call graph edges.  */
  99   enum copy_body_cge_which transform_call_graph_edges;
 100
 101   /* True if a new CFG should be created.  False for inlining, true for
 102      everything else.  */
 103   bool transform_new_cfg;
 104
 105   /* True if RETURN_EXPRs should be transformed to just the contained
 106      MODIFY_EXPR.  The branch semantics of the return will be handled
 107      by manipulating the CFG rather than a statement.  */
 108   bool transform_return_to_modify;
 109
 110   /* True if the parameters of the source function are transformed.
 111      Only true for inlining.  */
 112   bool transform_parameter;
 113
 114   /* True if this statement will need to be regimplified.  */
 115   bool regimplify;
 116
 117   /* True if trees should not be unshared.  */
 118   bool do_not_unshare;
 119
 120   /* > 0 if we are remapping a type currently.  */
 121   int remapping_type_depth;
 122
 123   /* A function to be called when duplicating BLOCK nodes.  */
 124   void (*transform_lang_insert_block) (tree);
 125
 126   /* Statements that might be possibly folded.  */
 127   hash_set<gimple> *statements_to_fold;
 128
 129   /* Entry basic block to currently copied body.  */
 130   basic_block entry_bb;
 131
 132   /* For partial function versioning, bitmap of bbs to be copied,
 133      otherwise NULL.  */
 134   bitmap blocks_to_copy;
 135
 136   /* Debug statements that need processing.  */
 137   vec<gdebug *> debug_stmts;
 138
 139   /* A map from local declarations in the inlined function to
 140      equivalents in the function into which it is being inlined, where
 141      the originals have been mapped to a value rather than to a
 142      variable.  */
 143   hash_map<tree, tree> *debug_map;
 144
 145   /* Cilk keywords currently need to replace some variables that
 146      ordinary nested functions do not.  */
 147   bool remap_var_for_cilk;
 148
 149   /* A map from the inlined functions dependence info cliques to
 150      equivalents in the function into which it is being inlined.  */
 151   hash_map<unsigned short, unsigned short, dependence_hasher> *dependence_map;
 152 };
 153
 154 /* Weights of constructions for estimate_num_insns.  */
 155
 156 typedef struct eni_weights_d
 157 {
 158   /* Cost per call.  */
 159   unsigned call_cost;
 160
 161   /* Cost per indirect call.  */
 162   unsigned indirect_call_cost;
 163
 164   /* Cost per call to a target specific builtin */
 165   unsigned target_builtin_call_cost;
 166
 167   /* Cost of "expensive" div and mod operations.  */
 168   unsigned div_mod_cost;
 169
 170   /* Cost for omp construct.  */
 171   unsigned omp_cost;
 172
 173   /* Cost for tm transaction.  */
 174   unsigned tm_cost;
 175
 176   /* Cost of return.  */
 177   unsigned return_cost;
 178
 179   /* True when time of statement should be estimated.  Thus, the
 180      cost of a switch statement is logarithmic rather than linear in number
 181      of cases.  */
 182   bool time_based;
 183 } eni_weights;
 184
 185 /* Weights that estimate_num_insns uses for heuristics in inlining.  */
 186
 187 extern eni_weights eni_inlining_weights;
 188
 189 /* Weights that estimate_num_insns uses to estimate the size of the
 190    produced code.  */
 191
 192 extern eni_weights eni_size_weights;
 193
 194 /* Weights that estimate_num_insns uses to estimate the time necessary
 195    to execute the produced code.  */
 196
 197 extern eni_weights eni_time_weights;
 198
 199 /* Function prototypes.  */
 200 void init_inline_once (void);
 201 extern tree copy_tree_body_r (tree *, int *, void *);
 202 extern void insert_decl_map (copy_body_data *, tree, tree);
 203 unsigned int optimize_inline_calls (tree);
 204 tree maybe_inline_call_in_expr (tree);
 205 bool tree_inlinable_function_p (tree);
 206 tree copy_tree_r (tree *, int *, void *);
 207 tree copy_decl_no_change (tree decl, copy_body_data *id);
 208 int estimate_move_cost (tree type, bool);
 209 int estimate_num_insns (gimple, eni_weights *);
 210 int estimate_num_insns_fn (tree, eni_weights *);
 211 int count_insns_seq (gimple_seq, eni_weights *);
 212 bool tree_versionable_function_p (tree);
 213 extern tree remap_decl (tree decl, copy_body_data *id);
 214 extern tree remap_type (tree type, copy_body_data *id);
 215 extern gimple_seq copy_gimple_seq_and_replace_locals (gimple_seq seq);
 216 extern bool debug_find_tree (tree, tree);
 217 extern tree copy_fn (tree, tree&, tree&);
 218 extern const char *copy_forbidden (struct function *fun, tree fndecl);
 219
 220 /* This is in tree-inline.c since the routine uses
 221    data structures from the inliner.  */
 222 extern tree build_duplicate_type (tree);
 223
 224 #endif /* GCC_TREE_INLINE_H */