gcc/ipa-utils.h

   1 /* Utilities for ipa analysis.
   2    Copyright (C) 2004-2023 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   void *aux;
  34 };
  35
  36
  37 /* In ipa-utils.cc  */
  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 bool stmt_may_terminate_function_p (function *fun, gimple *stmt, bool assume_return_or_eh);
  50 bitmap find_always_executed_bbs (function *fun, bool assume_return_or_eh);
  51
  52 /* In ipa-pure-const.cc  */
  53 bool finite_function_p ();
  54 bool builtin_safe_for_const_function_p (bool *, tree);
  55 bool ipa_make_function_const (cgraph_node *, bool, bool);
  56 bool ipa_make_function_pure (cgraph_node *, bool, bool);
  57
  58 /* In ipa-profile.cc  */
  59 bool ipa_propagate_frequency (struct cgraph_node *node);
  60
  61 /* In ipa-devirt.cc  */
  62
  63 struct odr_type_d;
  64 typedef odr_type_d *odr_type;
  65 extern bool thunk_expansion;
  66 void build_type_inheritance_graph (void);
  67 void rebuild_type_inheritance_graph (void);
  68 void update_type_inheritance_graph (void);
  69 vec <cgraph_node *>
  70 possible_polymorphic_call_targets (tree, HOST_WIDE_INT,
  71                                    ipa_polymorphic_call_context,
  72                                    bool *copletep = NULL,
  73                                    void **cache_token = NULL,
  74                                    bool speuclative = false);
  75 odr_type get_odr_type (tree, bool insert = false);
  76 bool odr_type_p (const_tree);
  77 bool possible_polymorphic_call_target_p (tree ref, gimple *stmt, struct cgraph_node *n);
  78 void dump_possible_polymorphic_call_targets (FILE *, tree, HOST_WIDE_INT,
  79                                              const ipa_polymorphic_call_context &,
  80                                              bool verbose = true);
  81 bool possible_polymorphic_call_target_p (tree, HOST_WIDE_INT,
  82                                          const ipa_polymorphic_call_context &,
  83                                          struct cgraph_node *);
  84 tree polymorphic_ctor_dtor_p (tree, bool);
  85 tree inlined_polymorphic_ctor_dtor_block_p (tree, bool);
  86 bool decl_maybe_in_construction_p (tree, tree, gimple *, tree);
  87 tree vtable_pointer_value_to_binfo (const_tree);
  88 bool vtable_pointer_value_to_vtable (const_tree, tree *, unsigned HOST_WIDE_INT *);
  89 tree subbinfo_with_vtable_at_offset (tree, unsigned HOST_WIDE_INT, tree);
  90 void compare_virtual_tables (varpool_node *, varpool_node *);
  91 bool type_all_derivations_known_p (const_tree);
  92 bool type_known_to_have_no_derivations_p (tree);
  93 bool contains_polymorphic_type_p (const_tree);
  94 void register_odr_type (tree);
  95 bool types_must_be_same_for_odr (tree, tree);
  96 bool types_odr_comparable (tree, tree);
  97 cgraph_node *try_speculative_devirtualization (tree, HOST_WIDE_INT,
  98                                                ipa_polymorphic_call_context);
  99 void warn_types_mismatch (tree t1, tree t2, location_t loc1 = UNKNOWN_LOCATION,
 100                           location_t loc2 = UNKNOWN_LOCATION);
 101 bool odr_or_derived_type_p (const_tree t);
 102 bool odr_types_equivalent_p (tree type1, tree type2);
 103 bool odr_type_violation_reported_p (tree type);
 104 tree prevailing_odr_type (tree type);
 105 void enable_odr_based_tbaa (tree type);
 106 bool odr_based_tbaa_p (const_tree type);
 107 void set_type_canonical_for_odr_type (tree type, tree canonical);
 108
 109 void register_odr_enum (tree type);
 110
 111 /* Return vector containing possible targets of polymorphic call E.
 112    If COMPLETEP is non-NULL, store true if the list is complete.
 113    CACHE_TOKEN (if non-NULL) will get stored to an unique ID of entry
 114    in the target cache.  If user needs to visit every target list
 115    just once, it can memoize them.
 116
 117    Returned vector is placed into cache.  It is NOT caller's responsibility
 118    to free it.  The vector can be freed on cgraph_remove_node call if
 119    the particular node is a virtual function present in the cache.  */
 120
 121 inline vec <cgraph_node *>
 122 possible_polymorphic_call_targets (struct cgraph_edge *e,
 123                                    bool *completep = NULL,
 124                                    void **cache_token = NULL,
 125                                    bool speculative = false)
 126 {
 127   ipa_polymorphic_call_context context(e);
 128
 129   return possible_polymorphic_call_targets (e->indirect_info->otr_type,
 130                                             e->indirect_info->otr_token,
 131                                             context,
 132                                             completep, cache_token,
 133                                             speculative);
 134 }
 135
 136 /* Same as above but taking OBJ_TYPE_REF as an parameter.  */
 137
 138 inline vec <cgraph_node *>
 139 possible_polymorphic_call_targets (tree ref,
 140                                    gimple *call,
 141                                    bool *completep = NULL,
 142                                    void **cache_token = NULL)
 143 {
 144   ipa_polymorphic_call_context context (current_function_decl, ref, call);
 145
 146   return possible_polymorphic_call_targets (obj_type_ref_class (ref),
 147                                             tree_to_uhwi
 148                                               (OBJ_TYPE_REF_TOKEN (ref)),
 149                                             context,
 150                                             completep, cache_token);
 151 }
 152
 153 /* Dump possible targets of a polymorphic call E into F.  */
 154
 155 inline void
 156 dump_possible_polymorphic_call_targets (FILE *f, struct cgraph_edge *e,
 157                                         bool verbose = true)
 158 {
 159   ipa_polymorphic_call_context context(e);
 160
 161   dump_possible_polymorphic_call_targets (f, e->indirect_info->otr_type,
 162                                           e->indirect_info->otr_token,
 163                                           context, verbose);
 164 }
 165
 166 /* Return true if N can be possibly target of a polymorphic call of
 167    E.  */
 168
 169 inline bool
 170 possible_polymorphic_call_target_p (struct cgraph_edge *e,
 171                                     struct cgraph_node *n)
 172 {
 173   ipa_polymorphic_call_context context(e);
 174
 175   return possible_polymorphic_call_target_p (e->indirect_info->otr_type,
 176                                              e->indirect_info->otr_token,
 177                                              context, n);
 178 }
 179
 180 /* Return true if BINFO corresponds to a type with virtual methods.
 181
 182    Every type has several BINFOs.  One is the BINFO associated by the type
 183    while other represents bases of derived types.  The BINFOs representing
 184    bases do not have BINFO_VTABLE pointer set when this is the single
 185    inheritance (because vtables are shared).  Look up the BINFO of type
 186    and check presence of its vtable.  */
 187
 188 inline bool
 189 polymorphic_type_binfo_p (const_tree binfo)
 190 {
 191   return (BINFO_TYPE (binfo) && TYPE_BINFO (BINFO_TYPE (binfo))
 192           && BINFO_VTABLE (TYPE_BINFO (BINFO_TYPE (binfo))));
 193 }
 194
 195 /* Return true if T is a type with linkage defined.  */
 196
 197 inline bool
 198 type_with_linkage_p (const_tree t)
 199 {
 200   gcc_checking_assert (TYPE_MAIN_VARIANT (t) == t);
 201   if (!TYPE_NAME (t) || TREE_CODE (TYPE_NAME (t)) != TYPE_DECL)
 202     return false;
 203
 204   /* After free_lang_data was run we can recongize
 205      types with linkage by presence of mangled name.  */
 206   if (DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t)))
 207     return true;
 208
 209   if (in_lto_p)
 210     return false;
 211
 212   /* We used to check for TYPE_STUB_DECL but that is set to NULL for forward
 213      declarations.  */
 214
 215   if (!RECORD_OR_UNION_TYPE_P (t) && TREE_CODE (t) != ENUMERAL_TYPE)
 216     return false;
 217
 218   /* Builtin types do not define linkage, their TYPE_CONTEXT is NULL.  */
 219   if (!TYPE_CONTEXT (t))
 220     return false;
 221
 222   return true;
 223 }
 224
 225 /* Return true if T is in anonymous namespace.
 226    This works only on those C++ types with linkage defined.  */
 227
 228 inline bool
 229 type_in_anonymous_namespace_p (const_tree t)
 230 {
 231   gcc_checking_assert (type_with_linkage_p (t));
 232
 233   /* free_lang_data clears TYPE_STUB_DECL but sets assembler name to
 234      "<anon>"  */
 235   if (DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t)))
 236     return !strcmp ("<anon>",
 237                     IDENTIFIER_POINTER
 238                     (DECL_ASSEMBLER_NAME (TYPE_NAME (t))));
 239   else if (!TYPE_STUB_DECL (t))
 240     return false;
 241   else
 242     return !TREE_PUBLIC (TYPE_STUB_DECL (t));
 243 }
 244
 245 /* Return true of T is type with One Definition Rule info attached.
 246    It means that either it is anonymous type or it has assembler name
 247    set.  */
 248
 249 inline bool
 250 odr_type_p (const_tree t)
 251 {
 252   /* We do not have this information when not in LTO, but we do not need
 253      to care, since it is used only for type merging.  */
 254   gcc_checking_assert (in_lto_p || flag_lto || flag_generate_offload);
 255   return TYPE_NAME (t) && TREE_CODE (TYPE_NAME (t)) == TYPE_DECL
 256          && DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t));
 257 }
 258
 259 /* If TYPE has mangled ODR name, return it.  Otherwise return NULL.
 260    The function works only when free_lang_data is run.  */
 261
 262 inline const char *
 263 get_odr_name_for_type (tree type)
 264 {
 265   tree type_name = TYPE_NAME (type);
 266   if (type_name == NULL_TREE
 267       || TREE_CODE (type_name) != TYPE_DECL
 268       || !DECL_ASSEMBLER_NAME_SET_P (type_name))
 269     return NULL;
 270
 271   return IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (type_name));
 272 }
 273
 274 /* Return true if we are going to do LTO streaming.  */
 275
 276 inline bool
 277 lto_streaming_expected_p ()
 278 {
 279   /* Compilation before LTO stremaing.  */
 280   if (flag_lto && !in_lto_p && symtab->state < IPA_SSA_AFTER_INLINING)
 281     return true;
 282   /* WPA or incremental link.  */
 283   return (flag_wpa || flag_incremental_link == INCREMENTAL_LINK_LTO);
 284 }
 285
 286 #endif  /* GCC_IPA_UTILS_H  */