gcc/tree-inline.h

   1 /* Tree inlining hooks and declarations.
   2    Copyright (C) 2001-2019 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
  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   gcall *call_stmt;
  79
  80   /* > 0 if we are remapping a type currently.  */
  81   int remapping_type_depth;
  82
  83   /* Exception landing pad the inlined call lies in.  */
  84   int eh_lp_nr;
  85
  86   /* Maps region and landing pad structures from the function being copied
  87      to duplicates created within the function we inline into.  */
  88   hash_map<void *, void *> *eh_map;
  89
  90   /* We use the same mechanism do all sorts of different things.  Rather
  91      than enumerating the different cases, we categorize the behavior
  92      in the various situations.  */
  93
  94   /* What to do with call graph edges.  */
  95   enum copy_body_cge_which transform_call_graph_edges;
  96
  97   /* True if a new CFG should be created.  False for inlining, true for
  98      everything else.  */
  99   bool transform_new_cfg;
 100
 101   /* True if RETURN_EXPRs should be transformed to just the contained
 102      MODIFY_EXPR.  The branch semantics of the return will be handled
 103      by manipulating the CFG rather than a statement.  */
 104   bool transform_return_to_modify;
 105
 106   /* True if the parameters of the source function are transformed.
 107      Only true for inlining.  */
 108   bool transform_parameter;
 109
 110   /* True if this statement will need to be regimplified.  */
 111   bool regimplify;
 112
 113   /* True if trees may not be unshared.  */
 114   bool do_not_unshare;
 115
 116   /* True if new declarations may not be created during type remapping.  */
 117   bool prevent_decl_creation_for_types;
 118
 119   /* True if the location information will need to be reset.  */
 120   bool reset_location;
 121
 122   /* Replace error_mark_node as upper bound of array types with
 123      an uninitialized VAR_DECL temporary.  */
 124   bool adjust_array_error_bounds;
 125
 126   /* A function to be called when duplicating BLOCK nodes.  */
 127   void (*transform_lang_insert_block) (tree);
 128
 129   /* Statements that might be possibly folded.  */
 130   hash_set<gimple *> *statements_to_fold;
 131
 132   /* Entry basic block to currently copied body.  */
 133   basic_block entry_bb;
 134
 135   /* For partial function versioning, bitmap of bbs to be copied,
 136      otherwise NULL.  */
 137   bitmap blocks_to_copy;
 138
 139   /* Debug statements that need processing.  */
 140   vec<gdebug *> debug_stmts;
 141
 142   /* A map from local declarations in the inlined function to
 143      equivalents in the function into which it is being inlined, where
 144      the originals have been mapped to a value rather than to a
 145      variable.  */
 146   hash_map<tree, tree> *debug_map;
 147
 148   /* A map from the inlined functions dependence info cliques to
 149      equivalents in the function into which it is being inlined.  */
 150   hash_map<dependence_hash, unsigned short> *dependence_map;
 151
 152   /* A list of addressable local variables remapped into the caller
 153      when inlining a call within an OpenMP SIMD-on-SIMT loop.  */
 154   vec<tree> *dst_simt_vars;
 155
 156   /* If clobbers for local variables from the inline function
 157      that need to live in memory should be added to EH landing pads
 158      outside of the inlined function, this should be the number
 159      of basic blocks in the caller before inlining.  Zero otherwise.  */
 160   int add_clobbers_to_eh_landing_pads;
 161 };
 162
 163 /* Weights of constructions for estimate_num_insns.  */
 164
 165 struct eni_weights
 166 {
 167   /* Cost per call.  */
 168   unsigned call_cost;
 169
 170   /* Cost per indirect call.  */
 171   unsigned indirect_call_cost;
 172
 173   /* Cost per call to a target specific builtin */
 174   unsigned target_builtin_call_cost;
 175
 176   /* Cost of "expensive" div and mod operations.  */
 177   unsigned div_mod_cost;
 178
 179   /* Cost for omp construct.  */
 180   unsigned omp_cost;
 181
 182   /* Cost for tm transaction.  */
 183   unsigned tm_cost;
 184
 185   /* Cost of return.  */
 186   unsigned return_cost;
 187
 188   /* True when time of statement should be estimated.  Thus, the
 189      cost of a switch statement is logarithmic rather than linear in number
 190      of cases.  */
 191   bool time_based;
 192 };
 193
 194 /* Weights that estimate_num_insns uses for heuristics in inlining.  */
 195
 196 extern eni_weights eni_inlining_weights;
 197
 198 /* Weights that estimate_num_insns uses to estimate the size of the
 199    produced code.  */
 200
 201 extern eni_weights eni_size_weights;
 202
 203 /* Weights that estimate_num_insns uses to estimate the time necessary
 204    to execute the produced code.  */
 205
 206 extern eni_weights eni_time_weights;
 207
 208 /* Function prototypes.  */
 209 void init_inline_once (void);
 210 extern tree copy_tree_body_r (tree *, int *, void *);
 211 extern void insert_decl_map (copy_body_data *, tree, tree);
 212 unsigned int optimize_inline_calls (tree);
 213 tree maybe_inline_call_in_expr (tree);
 214 bool tree_inlinable_function_p (tree);
 215 tree copy_tree_r (tree *, int *, void *);
 216 tree copy_decl_no_change (tree decl, copy_body_data *id);
 217 int estimate_move_cost (tree type, bool);
 218 int estimate_num_insns (gimple *, eni_weights *);
 219 int estimate_num_insns_fn (tree, eni_weights *);
 220 int estimate_num_insns_seq (gimple_seq, eni_weights *);
 221 bool tree_versionable_function_p (tree);
 222 extern tree remap_decl (tree decl, copy_body_data *id);
 223 extern tree remap_type (tree type, copy_body_data *id);
 224 extern gimple_seq copy_gimple_seq_and_replace_locals (gimple_seq seq);
 225 extern bool debug_find_tree (tree, tree);
 226 extern tree copy_fn (tree, tree&, tree&);
 227 extern const char *copy_forbidden (struct function *fun);
 228 extern tree copy_decl_for_dup_finish (copy_body_data *id, tree decl, tree copy);
 229
 230 /* This is in tree-inline.c since the routine uses
 231    data structures from the inliner.  */
 232 extern tree build_duplicate_type (tree);
 233
 234 #endif /* GCC_TREE_INLINE_H */