gcc/ipa-utils.h

   1 /* Utilities for ipa analysis.
   2    Copyright (C) 2004-2019 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
  24 struct ipa_dfs_info {
  25   int dfn_number;
  26   int low_link;
  27   /* This field will have the samy value for any two nodes in the same strongly
  28      connected component.  */
  29   int scc_no;
  30   bool new_node;
  31   bool on_stack;
  32   struct cgraph_node* next_cycle;
  33   PTR aux;
  34 };
  35
  36
  37 /* In ipa-utils.c  */
  38 void ipa_print_order (FILE*, const char *, struct cgraph_node**, int);
  39 int ipa_reduced_postorder (struct cgraph_node **, bool,
  40                           bool (*ignore_edge) (struct cgraph_edge *));
  41 void ipa_free_postorder_info (void);
  42 vec<cgraph_node *> ipa_get_nodes_in_cycle (struct cgraph_node *);
  43 bool ipa_edge_within_scc (struct cgraph_edge *);
  44 int ipa_reverse_postorder (struct cgraph_node **);
  45 tree get_base_var (tree);
  46 void ipa_merge_profiles (struct cgraph_node *dst,
  47                          struct cgraph_node *src, bool preserve_body = false);
  48 bool recursive_call_p (tree, tree);
  49
  50 /* In ipa-profile.c  */
  51 bool ipa_propagate_frequency (struct cgraph_node *node);
  52
  53 /* In ipa-devirt.c  */
  54
  55 struct odr_type_d;
  56 typedef odr_type_d *odr_type;
  57 void build_type_inheritance_graph (void);
  58 void rebuild_type_inheritance_graph (void);
  59 void update_type_inheritance_graph (void);
  60 vec <cgraph_node *>
  61 possible_polymorphic_call_targets (tree, HOST_WIDE_INT,
  62                                    ipa_polymorphic_call_context,
  63                                    bool *copletep = NULL,
  64                                    void **cache_token = NULL,
  65                                    bool speuclative = false);
  66 odr_type get_odr_type (tree, bool insert = false);
  67 bool odr_type_p (const_tree);
  68 bool possible_polymorphic_call_target_p (tree ref, gimple *stmt, struct cgraph_node *n);
  69 void dump_possible_polymorphic_call_targets (FILE *, tree, HOST_WIDE_INT,
  70                                              const ipa_polymorphic_call_context &,
  71                                              bool verbose = true);
  72 bool possible_polymorphic_call_target_p (tree, HOST_WIDE_INT,
  73                                          const ipa_polymorphic_call_context &,
  74                                          struct cgraph_node *);
  75 tree polymorphic_ctor_dtor_p (tree, bool);
  76 tree inlined_polymorphic_ctor_dtor_block_p (tree, bool);
  77 bool decl_maybe_in_construction_p (tree, tree, gimple *, tree);
  78 tree vtable_pointer_value_to_binfo (const_tree);
  79 bool vtable_pointer_value_to_vtable (const_tree, tree *, unsigned HOST_WIDE_INT *);
  80 tree subbinfo_with_vtable_at_offset (tree, unsigned HOST_WIDE_INT, tree);
  81 void compare_virtual_tables (varpool_node *, varpool_node *);
  82 bool type_all_derivations_known_p (const_tree);
  83 bool type_known_to_have_no_derivations_p (tree);
  84 bool contains_polymorphic_type_p (const_tree);
  85 void register_odr_type (tree);
  86 bool types_must_be_same_for_odr (tree, tree);
  87 bool types_odr_comparable (tree, tree);
  88 cgraph_node *try_speculative_devirtualization (tree, HOST_WIDE_INT,
  89                                                ipa_polymorphic_call_context);
  90 void warn_types_mismatch (tree t1, tree t2, location_t loc1 = UNKNOWN_LOCATION,
  91                           location_t loc2 = UNKNOWN_LOCATION);
  92 bool odr_or_derived_type_p (const_tree t);
  93 bool odr_types_equivalent_p (tree type1, tree type2);
  94 bool odr_type_violation_reported_p (tree type);
  95 tree prevailing_odr_type (tree type);
  96 void enable_odr_based_tbaa (tree type);
  97 bool odr_based_tbaa_p (const_tree type);
  98 void set_type_canonical_for_odr_type (tree type, tree canonical);
  99
 100 /* Return vector containing possible targets of polymorphic call E.
 101    If COMPLETEP is non-NULL, store true if the list is complete.
 102    CACHE_TOKEN (if non-NULL) will get stored to an unique ID of entry
 103    in the target cache.  If user needs to visit every target list
 104    just once, it can memoize them.
 105
 106    Returned vector is placed into cache.  It is NOT caller's responsibility
 107    to free it.  The vector can be freed on cgraph_remove_node call if
 108    the particular node is a virtual function present in the cache.  */
 109
 110 inline vec <cgraph_node *>
 111 possible_polymorphic_call_targets (struct cgraph_edge *e,
 112                                    bool *completep = NULL,
 113                                    void **cache_token = NULL,
 114                                    bool speculative = false)
 115 {
 116   ipa_polymorphic_call_context context(e);
 117
 118   return possible_polymorphic_call_targets (e->indirect_info->otr_type,
 119                                             e->indirect_info->otr_token,
 120                                             context,
 121                                             completep, cache_token,
 122                                             speculative);
 123 }
 124
 125 /* Same as above but taking OBJ_TYPE_REF as an parameter.  */
 126
 127 inline vec <cgraph_node *>
 128 possible_polymorphic_call_targets (tree ref,
 129                                    gimple *call,
 130                                    bool *completep = NULL,
 131                                    void **cache_token = NULL)
 132 {
 133   ipa_polymorphic_call_context context (current_function_decl, ref, call);
 134
 135   return possible_polymorphic_call_targets (obj_type_ref_class (ref),
 136                                             tree_to_uhwi
 137                                               (OBJ_TYPE_REF_TOKEN (ref)),
 138                                             context,
 139                                             completep, cache_token);
 140 }
 141
 142 /* Dump possible targets of a polymorphic call E into F.  */
 143
 144 inline void
 145 dump_possible_polymorphic_call_targets (FILE *f, struct cgraph_edge *e,
 146                                         bool verbose = true)
 147 {
 148   ipa_polymorphic_call_context context(e);
 149
 150   dump_possible_polymorphic_call_targets (f, e->indirect_info->otr_type,
 151                                           e->indirect_info->otr_token,
 152                                           context, verbose);
 153 }
 154
 155 /* Return true if N can be possibly target of a polymorphic call of
 156    E.  */
 157
 158 inline bool
 159 possible_polymorphic_call_target_p (struct cgraph_edge *e,
 160                                     struct cgraph_node *n)
 161 {
 162   ipa_polymorphic_call_context context(e);
 163
 164   return possible_polymorphic_call_target_p (e->indirect_info->otr_type,
 165                                              e->indirect_info->otr_token,
 166                                              context, n);
 167 }
 168
 169 /* Return true if BINFO corresponds to a type with virtual methods.
 170
 171    Every type has several BINFOs.  One is the BINFO associated by the type
 172    while other represents bases of derived types.  The BINFOs representing
 173    bases do not have BINFO_VTABLE pointer set when this is the single
 174    inheritance (because vtables are shared).  Look up the BINFO of type
 175    and check presence of its vtable.  */
 176
 177 inline bool
 178 polymorphic_type_binfo_p (const_tree binfo)
 179 {
 180   return (BINFO_TYPE (binfo) && TYPE_BINFO (BINFO_TYPE (binfo))
 181           && BINFO_VTABLE (TYPE_BINFO (BINFO_TYPE (binfo))));
 182 }
 183
 184 /* Return true if T is a type with linkage defined.  */
 185
 186 inline bool
 187 type_with_linkage_p (const_tree t)
 188 {
 189   gcc_checking_assert (TYPE_MAIN_VARIANT (t) == t);
 190   if (!TYPE_NAME (t) || TREE_CODE (TYPE_NAME (t)) != TYPE_DECL)
 191     return false;
 192
 193   /* After free_lang_data was run we can recongize
 194      types with linkage by presence of mangled name.  */
 195   if (DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t)))
 196     return true;
 197
 198   if (in_lto_p)
 199     return false;
 200
 201   /* We used to check for TYPE_STUB_DECL but that is set to NULL for forward
 202      declarations.  */
 203
 204   if (!RECORD_OR_UNION_TYPE_P (t) && TREE_CODE (t) != ENUMERAL_TYPE)
 205     return false;
 206
 207   /* Builtin types do not define linkage, their TYPE_CONTEXT is NULL.  */
 208   if (!TYPE_CONTEXT (t))
 209     return false;
 210
 211   gcc_checking_assert (TREE_CODE (t) == ENUMERAL_TYPE || TYPE_CXX_ODR_P (t));
 212
 213   return true;
 214 }
 215
 216 /* Return true if T is in anonymous namespace.
 217    This works only on those C++ types with linkage defined.  */
 218
 219 inline bool
 220 type_in_anonymous_namespace_p (const_tree t)
 221 {
 222   gcc_checking_assert (type_with_linkage_p (t));
 223
 224   /* free_lang_data clears TYPE_STUB_DECL but sets assembler name to
 225      "<anon>"  */
 226   if (DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t)))
 227     return !strcmp ("<anon>",
 228                     IDENTIFIER_POINTER
 229                     (DECL_ASSEMBLER_NAME (TYPE_NAME (t))));
 230   else if (!TYPE_STUB_DECL (t))
 231     return false;
 232   else
 233     return !TREE_PUBLIC (TYPE_STUB_DECL (t));
 234 }
 235
 236 /* Return true of T is type with One Definition Rule info attached.
 237    It means that either it is anonymous type or it has assembler name
 238    set.  */
 239
 240 inline bool
 241 odr_type_p (const_tree t)
 242 {
 243   /* We do not have this information when not in LTO, but we do not need
 244      to care, since it is used only for type merging.  */
 245   gcc_checking_assert (in_lto_p || flag_lto);
 246   return TYPE_NAME (t) && TREE_CODE (TYPE_NAME (t)) == TYPE_DECL
 247          && DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t));
 248 }
 249
 250 #endif  /* GCC_IPA_UTILS_H  */