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
  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);
  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 possible_polymorphic_call_target_p (tree ref, gimple stmt, struct cgraph_node *n);
  67 void dump_possible_polymorphic_call_targets (FILE *, tree, HOST_WIDE_INT,
  68                                              const ipa_polymorphic_call_context &);
  69 bool possible_polymorphic_call_target_p (tree, HOST_WIDE_INT,
  70                                          const ipa_polymorphic_call_context &,
  71                                          struct cgraph_node *);
  72 tree method_class_type (const_tree);
  73 bool decl_maybe_in_construction_p (tree, tree, gimple, tree);
  74 tree vtable_pointer_value_to_binfo (const_tree);
  75 bool vtable_pointer_value_to_vtable (const_tree, tree *, unsigned HOST_WIDE_INT *);
  76 tree subbinfo_with_vtable_at_offset (tree, unsigned HOST_WIDE_INT, tree);
  77 void compare_virtual_tables (varpool_node *, varpool_node *);
  78 bool type_all_derivations_known_p (const_tree);
  79 bool type_known_to_have_no_deriavations_p (tree);
  80 bool contains_polymorphic_type_p (const_tree);
  81 void register_odr_type (tree);
  82 bool types_must_be_same_for_odr (tree, tree);
  83 bool types_odr_comparable (tree, tree);
  84 cgraph_node *try_speculative_devirtualization (tree, HOST_WIDE_INT,
  85                                                ipa_polymorphic_call_context);
  86
  87 /* Return vector containing possible targets of polymorphic call E.
  88    If COMPLETEP is non-NULL, store true if the list is complete.
  89    CACHE_TOKEN (if non-NULL) will get stored to an unique ID of entry
  90    in the target cache.  If user needs to visit every target list
  91    just once, it can memoize them.
  92
  93    Returned vector is placed into cache.  It is NOT caller's responsibility
  94    to free it.  The vector can be freed on cgraph_remove_node call if
  95    the particular node is a virtual function present in the cache.  */
  96
  97 inline vec <cgraph_node *>
  98 possible_polymorphic_call_targets (struct cgraph_edge *e,
  99                                    bool *completep = NULL,
 100                                    void **cache_token = NULL,
 101                                    bool speculative = false)
 102 {
 103   ipa_polymorphic_call_context context(e);
 104
 105   return possible_polymorphic_call_targets (e->indirect_info->otr_type,
 106                                             e->indirect_info->otr_token,
 107                                             context,
 108                                             completep, cache_token,
 109                                             speculative);
 110 }
 111
 112 /* Same as above but taking OBJ_TYPE_REF as an parameter.  */
 113
 114 inline vec <cgraph_node *>
 115 possible_polymorphic_call_targets (tree ref,
 116                                    gimple call,
 117                                    bool *completep = NULL,
 118                                    void **cache_token = NULL)
 119 {
 120   ipa_polymorphic_call_context context (current_function_decl, ref, call);
 121
 122   return possible_polymorphic_call_targets (obj_type_ref_class (ref),
 123                                             tree_to_uhwi
 124                                               (OBJ_TYPE_REF_TOKEN (ref)),
 125                                             context,
 126                                             completep, cache_token);
 127 }
 128
 129 /* Dump possible targets of a polymorphic call E into F.  */
 130
 131 inline void
 132 dump_possible_polymorphic_call_targets (FILE *f, struct cgraph_edge *e)
 133 {
 134   ipa_polymorphic_call_context context(e);
 135
 136   dump_possible_polymorphic_call_targets (f, e->indirect_info->otr_type,
 137                                           e->indirect_info->otr_token,
 138                                           context);
 139 }
 140
 141 /* Return true if N can be possibly target of a polymorphic call of
 142    E.  */
 143
 144 inline bool
 145 possible_polymorphic_call_target_p (struct cgraph_edge *e,
 146                                     struct cgraph_node *n)
 147 {
 148   ipa_polymorphic_call_context context(e);
 149
 150   return possible_polymorphic_call_target_p (e->indirect_info->otr_type,
 151                                              e->indirect_info->otr_token,
 152                                              context, n);
 153 }
 154
 155 /* Return true of T is type with One Definition Rule info attached.
 156    It means that either it is anonymous type or it has assembler name
 157    set.  */
 158
 159 static inline bool
 160 odr_type_p (const_tree t)
 161 {
 162   if (type_in_anonymous_namespace_p (t))
 163     return true;
 164   /* We do not have this information when not in LTO, but we do not need
 165      to care, since it is used only for type merging.  */
 166   gcc_assert (in_lto_p || flag_lto);
 167
 168   return (TYPE_NAME (t)
 169           && (DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t))));
 170 }
 171
 172 /* Return true if BINFO corresponds to a type with virtual methods.
 173
 174    Every type has several BINFOs.  One is the BINFO associated by the type
 175    while other represents bases of derived types.  The BINFOs representing
 176    bases do not have BINFO_VTABLE pointer set when this is the single
 177    inheritance (because vtables are shared).  Look up the BINFO of type
 178    and check presence of its vtable.  */
 179
 180 inline bool
 181 polymorphic_type_binfo_p (const_tree binfo)
 182 {
 183   /* See if BINFO's type has an virtual table associtated with it.
 184      Check is defensive because of Java FE produces BINFOs
 185      without BINFO_TYPE set.   */
 186   return (BINFO_TYPE (binfo) && TYPE_BINFO (BINFO_TYPE (binfo))
 187           && BINFO_VTABLE (TYPE_BINFO (BINFO_TYPE (binfo))));
 188 }
 189 #endif  /* GCC_IPA_UTILS_H  */
 190
 191