gcc/ipa-utils.h

   1 /* Utilities for ipa analysis.
   2    Copyright (C) 2004-2016 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, 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 update_type_inheritance_graph (void);
  59 vec <cgraph_node *>
  60 possible_polymorphic_call_targets (tree, HOST_WIDE_INT,
  61                                    ipa_polymorphic_call_context,
  62                                    bool *copletep = NULL,
  63                                    void **cache_token = NULL,
  64                                    bool speuclative = false);
  65 odr_type get_odr_type (tree, bool insert = false);
  66 bool odr_type_p (const_tree);
  67 bool possible_polymorphic_call_target_p (tree ref, gimple *stmt, struct cgraph_node *n);
  68 void dump_possible_polymorphic_call_targets (FILE *, tree, HOST_WIDE_INT,
  69                                              const ipa_polymorphic_call_context &);
  70 bool possible_polymorphic_call_target_p (tree, HOST_WIDE_INT,
  71                                          const ipa_polymorphic_call_context &,
  72                                          struct cgraph_node *);
  73 tree inlined_polymorphic_ctor_dtor_block_p (tree, bool);
  74 bool decl_maybe_in_construction_p (tree, tree, gimple *, tree);
  75 tree vtable_pointer_value_to_binfo (const_tree);
  76 bool vtable_pointer_value_to_vtable (const_tree, tree *, unsigned HOST_WIDE_INT *);
  77 tree subbinfo_with_vtable_at_offset (tree, unsigned HOST_WIDE_INT, tree);
  78 void compare_virtual_tables (varpool_node *, varpool_node *);
  79 bool type_all_derivations_known_p (const_tree);
  80 bool type_known_to_have_no_derivations_p (tree);
  81 bool contains_polymorphic_type_p (const_tree);
  82 void register_odr_type (tree);
  83 bool types_must_be_same_for_odr (tree, tree);
  84 bool types_odr_comparable (tree, tree, bool strict = false);
  85 cgraph_node *try_speculative_devirtualization (tree, HOST_WIDE_INT,
  86                                                ipa_polymorphic_call_context);
  87 void warn_types_mismatch (tree t1, tree t2, location_t loc1 = UNKNOWN_LOCATION,
  88                           location_t loc2 = UNKNOWN_LOCATION);
  89 bool odr_or_derived_type_p (const_tree t);
  90 bool odr_types_equivalent_p (tree type1, tree type2);
  91
  92 /* Return vector containing possible targets of polymorphic call E.
  93    If COMPLETEP is non-NULL, store true if the list is complete.
  94    CACHE_TOKEN (if non-NULL) will get stored to an unique ID of entry
  95    in the target cache.  If user needs to visit every target list
  96    just once, it can memoize them.
  97
  98    Returned vector is placed into cache.  It is NOT caller's responsibility
  99    to free it.  The vector can be freed on cgraph_remove_node call if
 100    the particular node is a virtual function present in the cache.  */
 101
 102 inline vec <cgraph_node *>
 103 possible_polymorphic_call_targets (struct cgraph_edge *e,
 104                                    bool *completep = NULL,
 105                                    void **cache_token = NULL,
 106                                    bool speculative = false)
 107 {
 108   ipa_polymorphic_call_context context(e);
 109
 110   return possible_polymorphic_call_targets (e->indirect_info->otr_type,
 111                                             e->indirect_info->otr_token,
 112                                             context,
 113                                             completep, cache_token,
 114                                             speculative);
 115 }
 116
 117 /* Same as above but taking OBJ_TYPE_REF as an parameter.  */
 118
 119 inline vec <cgraph_node *>
 120 possible_polymorphic_call_targets (tree ref,
 121                                    gimple *call,
 122                                    bool *completep = NULL,
 123                                    void **cache_token = NULL)
 124 {
 125   ipa_polymorphic_call_context context (current_function_decl, ref, call);
 126
 127   return possible_polymorphic_call_targets (obj_type_ref_class (ref),
 128                                             tree_to_uhwi
 129                                               (OBJ_TYPE_REF_TOKEN (ref)),
 130                                             context,
 131                                             completep, cache_token);
 132 }
 133
 134 /* Dump possible targets of a polymorphic call E into F.  */
 135
 136 inline void
 137 dump_possible_polymorphic_call_targets (FILE *f, struct cgraph_edge *e)
 138 {
 139   ipa_polymorphic_call_context context(e);
 140
 141   dump_possible_polymorphic_call_targets (f, e->indirect_info->otr_type,
 142                                           e->indirect_info->otr_token,
 143                                           context);
 144 }
 145
 146 /* Return true if N can be possibly target of a polymorphic call of
 147    E.  */
 148
 149 inline bool
 150 possible_polymorphic_call_target_p (struct cgraph_edge *e,
 151                                     struct cgraph_node *n)
 152 {
 153   ipa_polymorphic_call_context context(e);
 154
 155   return possible_polymorphic_call_target_p (e->indirect_info->otr_type,
 156                                              e->indirect_info->otr_token,
 157                                              context, n);
 158 }
 159
 160 /* Return true if BINFO corresponds to a type with virtual methods.
 161
 162    Every type has several BINFOs.  One is the BINFO associated by the type
 163    while other represents bases of derived types.  The BINFOs representing
 164    bases do not have BINFO_VTABLE pointer set when this is the single
 165    inheritance (because vtables are shared).  Look up the BINFO of type
 166    and check presence of its vtable.  */
 167
 168 inline bool
 169 polymorphic_type_binfo_p (const_tree binfo)
 170 {
 171   /* See if BINFO's type has an virtual table associtated with it.
 172      Check is defensive because of Java FE produces BINFOs
 173      without BINFO_TYPE set.   */
 174   return (BINFO_TYPE (binfo) && TYPE_BINFO (BINFO_TYPE (binfo))
 175           && BINFO_VTABLE (TYPE_BINFO (BINFO_TYPE (binfo))));
 176 }
 177
 178 /* Return true if T is a type with linkage defined.  */
 179
 180 inline bool
 181 type_with_linkage_p (const_tree t)
 182 {
 183   if (!TYPE_NAME (t) || TREE_CODE (TYPE_NAME (t)) != TYPE_DECL
 184       || !TYPE_STUB_DECL (t))
 185     return false;
 186   /* In LTO do not get confused by non-C++ produced types or types built
 187      with -fno-lto-odr-type-merigng.  */
 188   if (in_lto_p)
 189     {
 190       /* To support -fno-lto-odr-type-merigng recognize types with vtables
 191          to have linkage.  */
 192       if (RECORD_OR_UNION_TYPE_P (t)
 193           && TYPE_BINFO (t) && BINFO_VTABLE (TYPE_BINFO (t)))
 194         return true;
 195       /* With -flto-odr-type-merging C++ FE specify mangled names
 196          for all types with the linkage.  */
 197       return DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t));
 198     }
 199
 200   if (!RECORD_OR_UNION_TYPE_P (t) && TREE_CODE (t) != ENUMERAL_TYPE)
 201     return false;
 202
 203   /* Builtin types do not define linkage, their TYPE_CONTEXT is NULL.  */
 204   if (!TYPE_CONTEXT (t))
 205     return false;
 206
 207   return true;
 208 }
 209
 210 /* Return true if T is in anonymous namespace.
 211    This works only on those C++ types with linkage defined.  */
 212
 213 inline bool
 214 type_in_anonymous_namespace_p (const_tree t)
 215 {
 216   gcc_checking_assert (type_with_linkage_p (t));
 217
 218   if (!TREE_PUBLIC (TYPE_STUB_DECL (t)))
 219     {
 220       /* C++ FE uses magic <anon> as assembler names of anonymous types.
 221          verify that this match with type_in_anonymous_namespace_p.  */
 222       gcc_checking_assert (!in_lto_p || !DECL_ASSEMBLER_NAME_SET_P (t)
 223                            || !strcmp
 224                                  ("<anon>",
 225                                   IDENTIFIER_POINTER
 226                                      (DECL_ASSEMBLER_NAME (TYPE_NAME (t)))));
 227       return true;
 228     }
 229   return false;
 230 }
 231
 232 /* Return true of T is type with One Definition Rule info attached.
 233    It means that either it is anonymous type or it has assembler name
 234    set.  */
 235
 236 inline bool
 237 odr_type_p (const_tree t)
 238 {
 239   /* We do not have this information when not in LTO, but we do not need
 240      to care, since it is used only for type merging.  */
 241   gcc_checking_assert (in_lto_p || flag_lto);
 242
 243   if (!type_with_linkage_p (t))
 244     return false;
 245
 246   /* To support -fno-lto-odr-type-merging consider types with vtables ODR.  */
 247   if (type_in_anonymous_namespace_p (t))
 248     return true;
 249
 250   if (TYPE_NAME (t) && TREE_CODE (TYPE_NAME (t)) == TYPE_DECL
 251       && DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t)))
 252     {
 253       /* C++ FE uses magic <anon> as assembler names of anonymous types.
 254          verify that this match with type_in_anonymous_namespace_p.  */
 255       gcc_checking_assert (strcmp ("<anon>",
 256                                       IDENTIFIER_POINTER
 257                                         (DECL_ASSEMBLER_NAME (TYPE_NAME (t)))));
 258       return true;
 259     }
 260   return false;
 261 }
 262
 263 #endif  /* GCC_IPA_UTILS_H  */
 264
 265