gcc/tree-inline.h

   1 /* Tree inlining hooks and declarations.
   2    Copyright 2001, 2003, 2004, 2005 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 2, 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 COPYING.  If not, write to
  19 the Free Software Foundation, 51 Franklin Street, Fifth Floor,
  20 Boston, MA 02110-1301, USA.  */
  21
  22 #ifndef GCC_TREE_INLINE_H
  23 #define GCC_TREE_INLINE_H
  24
  25 #include "varray.h"
  26 #include "pointer-set.h"
  27
  28
  29 /* Data required for function body duplication.  */
  30
  31 typedef struct copy_body_data
  32 {
  33   /* FUNCTION_DECL for function being inlined, or in general the
  34      source function providing the original trees.  */
  35   tree src_fn;
  36   /* FUNCTION_DECL for function being inlined into, or in general
  37      the destination function receiving the new trees.  */
  38   tree dst_fn;
  39   /* Callgraph node of the source function.  */
  40   struct cgraph_node *src_node;
  41   /* Callgraph node of the destination function.  */
  42   struct cgraph_node *dst_node;
  43   /* struct function for function being inlined.  Usually this is the same
  44      as DECL_STRUCT_FUNCTION (src_fn), but can be different if saved_cfg
  45      and saved_eh are in use.  */
  46   struct function *src_cfun;
  47
  48   /* The VAR_DECL for the return value.  */
  49   tree retvar;
  50   /* The map from local declarations in the inlined function to
  51      equivalents in the function into which it is being inlined.  */
  52   struct pointer_map_t *decl_map;
  53
  54   /* Create a new decl to replace DECL in the destination function.  */
  55   tree (*copy_decl) (tree, struct copy_body_data *);
  56
  57   /* Current BLOCK.  */
  58   tree block;
  59
  60   /* Exception region the inlined call lie in.  */
  61   int eh_region;
  62   /* Take region number in the function being copied, add this value and
  63      get eh region number of the duplicate in the function we inline into.  */
  64   int eh_region_offset;
  65
  66   /* We use the same mechanism do all sorts of different things.  Rather
  67      than enumerating the different cases, we categorize the behavior
  68      in the various situations.  */
  69
  70   /* Indicate the desired behavior wrt call graph edges.  We can either
  71      duplicate the edge (inlining, cloning), move the edge (versioning,
  72      parallelization), or move the edges of the clones (saving).  */
  73   enum copy_body_cge_which {
  74     CB_CGE_DUPLICATE,
  75     CB_CGE_MOVE,
  76     CB_CGE_MOVE_CLONES
  77   } transform_call_graph_edges;
  78
  79   /* True if a new CFG should be created.  False for inlining, true for
  80      everything else.  */
  81   bool transform_new_cfg;
  82
  83   /* True if RETURN_EXPRs should be transformed to just the contained
  84      MODIFY_EXPR.  The branch semantics of the return will be handled
  85      by manipulating the CFG rather than a statement.  */
  86   bool transform_return_to_modify;
  87
  88   /* True if lang_hooks.decls.insert_block should be invoked when
  89      duplicating BLOCK nodes.  */
  90   bool transform_lang_insert_block;
  91
  92   /* Statements that might be possibly folded.  */
  93   struct pointer_set_t *statements_to_fold;
  94 } copy_body_data;
  95
  96 /* Weights of constructions for estimate_num_insns.  */
  97
  98 typedef struct eni_weights_d
  99 {
 100   /* Cost per call.  */
 101   unsigned call_cost;
 102
 103   /* Cost of "expensive" div and mod operations.  */
 104   unsigned div_mod_cost;
 105
 106   /* Cost of switch statement.  */
 107   unsigned switch_cost;
 108
 109   /* Cost for omp construct.  */
 110   unsigned omp_cost;
 111 } eni_weights;
 112
 113 /* Weights that estimate_num_insns uses for heuristics in inlining.  */
 114
 115 extern eni_weights eni_inlining_weights;
 116
 117 /* Weights that estimate_num_insns uses to estimate the size of the
 118    produced code.  */
 119
 120 extern eni_weights eni_size_weights;
 121
 122 /* Weights that estimate_num_insns uses to estimate the time necessary
 123    to execute the produced code.  */
 124
 125 extern eni_weights eni_time_weights;
 126
 127 /* Function prototypes.  */
 128
 129 extern tree copy_body_r (tree *, int *, void *);
 130 extern void insert_decl_map (copy_body_data *, tree, tree);
 131
 132 unsigned int optimize_inline_calls (tree);
 133 bool tree_inlinable_function_p (tree);
 134 tree copy_tree_r (tree *, int *, void *);
 135 void clone_body (tree, tree, void *);
 136 void save_body (tree, tree *, tree *);
 137 int estimate_move_cost (tree type);
 138 void push_cfun (struct function *new_cfun);
 139 void pop_cfun (void);
 140 int estimate_num_insns (tree expr, eni_weights *);
 141 bool tree_versionable_function_p (tree);
 142 void tree_function_versioning (tree, tree, varray_type, bool);
 143
 144 extern tree remap_decl (tree decl, copy_body_data *id);
 145 extern tree remap_type (tree type, copy_body_data *id);
 146
 147 extern HOST_WIDE_INT estimated_stack_frame_size (void);
 148
 149 /* 0 if we should not perform inlining.
 150    1 if we should expand functions calls inline at the tree level.
 151    2 if we should consider *all* functions to be inline
 152    candidates.  */
 153
 154 extern int flag_inline_trees;
 155
 156 #endif /* GCC_TREE_INLINE_H */