gcc/ipa-utils.h

   1 /* Utilities for ipa analysis.
   2    Copyright (C) 2004-2014 Free Software Foundation, Inc.
   3    Contributed by Kenneth Zadeck <zadeck@naturalbridge.com>
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 3, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 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_IPA_UTILS_H
  22 #define GCC_IPA_UTILS_H
  23 #include "cgraph.h"
  24
  25 struct ipa_dfs_info {
  26   int dfn_number;
  27   int low_link;
  28   /* This field will have the samy value for any two nodes in the same strongly
  29      connected component.  */
  30   int scc_no;
  31   bool new_node;
  32   bool on_stack;
  33   struct cgraph_node* next_cycle;
  34   PTR aux;
  35 };
  36
  37 /* Context of polymorphic call.  This is used by ipa-devirt walkers of the
  38    type inheritance graph.  */
  39 struct ipa_polymorphic_call_context {
  40   /* The called object appears in an object of type OUTER_TYPE
  41      at offset OFFSET.  When information is not 100% reliable, we
  42      use SPECULATIVE_OUTER_TYPE and SPECULATIVE_OFFSET. */
  43   HOST_WIDE_INT offset;
  44   HOST_WIDE_INT speculative_offset;
  45   tree outer_type;
  46   tree speculative_outer_type;
  47   /* True if outer object may be in construction or destruction.  */
  48   bool maybe_in_construction;
  49   /* True if outer object may be of derived type.  */
  50   bool maybe_derived_type;
  51   /* True if speculative outer object may be of derived type.  We always
  52      speculate that construction does not happen.  */
  53   bool speculative_maybe_derived_type;
  54 };
  55
  56 /* Context representing "I know nothing".  */
  57 extern const ipa_polymorphic_call_context ipa_dummy_polymorphic_call_context;
  58
  59 /* In ipa-utils.c  */
  60 void ipa_print_order (FILE*, const char *, struct cgraph_node**, int);
  61 int ipa_reduced_postorder (struct cgraph_node **, bool, bool,
  62                           bool (*ignore_edge) (struct cgraph_edge *));
  63 void ipa_free_postorder_info (void);
  64 vec<cgraph_node *> ipa_get_nodes_in_cycle (struct cgraph_node *);
  65 bool ipa_edge_within_scc (struct cgraph_edge *);
  66 int ipa_reverse_postorder (struct cgraph_node **);
  67 tree get_base_var (tree);
  68 void ipa_merge_profiles (struct cgraph_node *dst,
  69                          struct cgraph_node *src);
  70 bool recursive_call_p (tree, tree);
  71
  72 /* In ipa-profile.c  */
  73 bool ipa_propagate_frequency (struct cgraph_node *node);
  74
  75 /* In ipa-devirt.c  */
  76
  77 struct odr_type_d;
  78 typedef odr_type_d *odr_type;
  79 void build_type_inheritance_graph (void);
  80 void update_type_inheritance_graph (void);
  81 vec <cgraph_node *>
  82 possible_polymorphic_call_targets (tree, HOST_WIDE_INT,
  83                                    ipa_polymorphic_call_context,
  84                                    bool *final = NULL,
  85                                    void **cache_token = NULL,
  86                                    int *nonconstruction_targets = NULL);
  87 odr_type get_odr_type (tree, bool insert = false);
  88 void dump_possible_polymorphic_call_targets (FILE *, tree, HOST_WIDE_INT,
  89                                              const ipa_polymorphic_call_context &);
  90 bool possible_polymorphic_call_target_p (tree, HOST_WIDE_INT,
  91                                          const ipa_polymorphic_call_context &,
  92                                          struct cgraph_node *);
  93 tree method_class_type (const_tree);
  94 tree get_polymorphic_call_info (tree, tree, tree *,
  95                                 HOST_WIDE_INT *,
  96                                 ipa_polymorphic_call_context *,
  97                                 gimple call = NULL);
  98 bool get_dynamic_type (tree, ipa_polymorphic_call_context *, tree, gimple);
  99 bool get_polymorphic_call_info_from_invariant (ipa_polymorphic_call_context *,
 100                                                tree, tree, HOST_WIDE_INT);
 101 bool decl_maybe_in_construction_p (tree, tree, gimple, tree);
 102 tree vtable_pointer_value_to_binfo (const_tree);
 103 bool vtable_pointer_value_to_vtable (const_tree, tree *, unsigned HOST_WIDE_INT *);
 104 bool contains_polymorphic_type_p (const_tree);
 105
 106 /* Return vector containing possible targets of polymorphic call E.
 107    If FINALP is non-NULL, store true if the list is complette.
 108    CACHE_TOKEN (if non-NULL) will get stored to an unique ID of entry
 109    in the target cache.  If user needs to visit every target list
 110    just once, it can memoize them.
 111
 112    Returned vector is placed into cache.  It is NOT caller's responsibility
 113    to free it.  The vector can be freed on cgraph_remove_node call if
 114    the particular node is a virtual function present in the cache.  */
 115
 116 inline vec <cgraph_node *>
 117 possible_polymorphic_call_targets (struct cgraph_edge *e,
 118                                    bool *final = NULL,
 119                                    void **cache_token = NULL,
 120                                    int *nonconstruction_targets = NULL)
 121 {
 122   gcc_checking_assert (e->indirect_info->polymorphic);
 123   ipa_polymorphic_call_context context = {e->indirect_info->offset,
 124                                           e->indirect_info->speculative_offset,
 125                                           e->indirect_info->outer_type,
 126                                           e->indirect_info->speculative_outer_type,
 127                                           e->indirect_info->maybe_in_construction,
 128                                           e->indirect_info->maybe_derived_type,
 129                                           e->indirect_info->speculative_maybe_derived_type};
 130   return possible_polymorphic_call_targets (e->indirect_info->otr_type,
 131                                             e->indirect_info->otr_token,
 132                                             context,
 133                                             final, cache_token,
 134                                             nonconstruction_targets);
 135 }
 136
 137 /* Same as above but taking OBJ_TYPE_REF as an parameter.  */
 138
 139 inline vec <cgraph_node *>
 140 possible_polymorphic_call_targets (tree ref,
 141                                    gimple call,
 142                                    bool *final = NULL,
 143                                    void **cache_token = NULL)
 144 {
 145   tree otr_type;
 146   HOST_WIDE_INT otr_token;
 147   ipa_polymorphic_call_context context;
 148
 149   get_polymorphic_call_info (current_function_decl,
 150                              ref,
 151                              &otr_type, &otr_token, &context, call);
 152   return possible_polymorphic_call_targets (obj_type_ref_class (ref),
 153                                             tree_to_uhwi
 154                                               (OBJ_TYPE_REF_TOKEN (ref)),
 155                                             context,
 156                                             final, cache_token);
 157 }
 158
 159 /* Dump possible targets of a polymorphic call E into F.  */
 160
 161 inline void
 162 dump_possible_polymorphic_call_targets (FILE *f, struct cgraph_edge *e)
 163 {
 164   gcc_checking_assert (e->indirect_info->polymorphic);
 165   ipa_polymorphic_call_context context = {e->indirect_info->offset,
 166                                           e->indirect_info->speculative_offset,
 167                                           e->indirect_info->outer_type,
 168                                           e->indirect_info->speculative_outer_type,
 169                                           e->indirect_info->maybe_in_construction,
 170                                           e->indirect_info->maybe_derived_type,
 171                                           e->indirect_info->speculative_maybe_derived_type};
 172   dump_possible_polymorphic_call_targets (f, e->indirect_info->otr_type,
 173                                           e->indirect_info->otr_token,
 174                                           context);
 175 }
 176
 177 /* Return true if N can be possibly target of a polymorphic call of
 178    E.  */
 179
 180 inline bool
 181 possible_polymorphic_call_target_p (struct cgraph_edge *e,
 182                                     struct cgraph_node *n)
 183 {
 184   ipa_polymorphic_call_context context = {e->indirect_info->offset, 0,
 185                                           e->indirect_info->outer_type, NULL,
 186                                           e->indirect_info->maybe_in_construction,
 187                                           e->indirect_info->maybe_derived_type,
 188                                           false};
 189   return possible_polymorphic_call_target_p (e->indirect_info->otr_type,
 190                                              e->indirect_info->otr_token,
 191                                              context, n);
 192 }
 193
 194 /* Return true if N can be possibly target of a polymorphic call of
 195    OBJ_TYPE_REF expression CALL.  */
 196
 197 inline bool
 198 possible_polymorphic_call_target_p (tree call,
 199                                     struct cgraph_node *n)
 200 {
 201   return possible_polymorphic_call_target_p (obj_type_ref_class (call),
 202                                              tree_to_uhwi
 203                                                (OBJ_TYPE_REF_TOKEN (call)),
 204                                              ipa_dummy_polymorphic_call_context,
 205                                              n);
 206 }
 207 #endif  /* GCC_IPA_UTILS_H  */
 208
 209