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
  38 /* In ipa-utils.c  */
  39 void ipa_print_order (FILE*, const char *, struct cgraph_node**, int);
  40 int ipa_reduced_postorder (struct cgraph_node **, bool, bool,
  41                           bool (*ignore_edge) (struct cgraph_edge *));
  42 void ipa_free_postorder_info (void);
  43 vec<cgraph_node *> ipa_get_nodes_in_cycle (struct cgraph_node *);
  44 bool ipa_edge_within_scc (struct cgraph_edge *);
  45 int ipa_reverse_postorder (struct cgraph_node **);
  46 tree get_base_var (tree);
  47 void ipa_merge_profiles (struct cgraph_node *dst,
  48                          struct cgraph_node *src);
  49 bool recursive_call_p (tree, tree);
  50
  51 /* In ipa-profile.c  */
  52 bool ipa_propagate_frequency (struct cgraph_node *node);
  53
  54 /* In ipa-devirt.c  */
  55
  56 struct odr_type_d;
  57 typedef odr_type_d *odr_type;
  58 void build_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 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 method_class_type (const_tree);
  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_deriavations_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);
  85
  86 /* Return vector containing possible targets of polymorphic call E.
  87    If COMPLETEP is non-NULL, store true if the list is complette.
  88    CACHE_TOKEN (if non-NULL) will get stored to an unique ID of entry
  89    in the target cache.  If user needs to visit every target list
  90    just once, it can memoize them.
  91
  92    Returned vector is placed into cache.  It is NOT caller's responsibility
  93    to free it.  The vector can be freed on cgraph_remove_node call if
  94    the particular node is a virtual function present in the cache.  */
  95
  96 inline vec <cgraph_node *>
  97 possible_polymorphic_call_targets (struct cgraph_edge *e,
  98                                    bool *completep = NULL,
  99                                    void **cache_token = NULL,
 100                                    bool speculative = false)
 101 {
 102   ipa_polymorphic_call_context context(e);
 103
 104   return possible_polymorphic_call_targets (e->indirect_info->otr_type,
 105                                             e->indirect_info->otr_token,
 106                                             context,
 107                                             completep, cache_token,
 108                                             speculative);
 109 }
 110
 111 /* Same as above but taking OBJ_TYPE_REF as an parameter.  */
 112
 113 inline vec <cgraph_node *>
 114 possible_polymorphic_call_targets (tree ref,
 115                                    gimple call,
 116                                    bool *completep = NULL,
 117                                    void **cache_token = NULL)
 118 {
 119   ipa_polymorphic_call_context context (current_function_decl, ref, call);
 120
 121   return possible_polymorphic_call_targets (obj_type_ref_class (ref),
 122                                             tree_to_uhwi
 123                                               (OBJ_TYPE_REF_TOKEN (ref)),
 124                                             context,
 125                                             completep, cache_token);
 126 }
 127
 128 /* Dump possible targets of a polymorphic call E into F.  */
 129
 130 inline void
 131 dump_possible_polymorphic_call_targets (FILE *f, struct cgraph_edge *e)
 132 {
 133   ipa_polymorphic_call_context context(e);
 134
 135   dump_possible_polymorphic_call_targets (f, e->indirect_info->otr_type,
 136                                           e->indirect_info->otr_token,
 137                                           context);
 138 }
 139
 140 /* Return true if N can be possibly target of a polymorphic call of
 141    E.  */
 142
 143 inline bool
 144 possible_polymorphic_call_target_p (struct cgraph_edge *e,
 145                                     struct cgraph_node *n)
 146 {
 147   ipa_polymorphic_call_context context(e);
 148
 149   return possible_polymorphic_call_target_p (e->indirect_info->otr_type,
 150                                              e->indirect_info->otr_token,
 151                                              context, n);
 152 }
 153
 154 /* Return true of T is type with One Definition Rule info attached.
 155    It means that either it is anonymous type or it has assembler name
 156    set.  */
 157
 158 static inline bool
 159 odr_type_p (const_tree t)
 160 {
 161   if (type_in_anonymous_namespace_p (t))
 162     return true;
 163   /* We do not have this information when not in LTO, but we do not need
 164      to care, since it is used only for type merging.  */
 165   gcc_assert (in_lto_p || flag_lto);
 166
 167   return (TYPE_NAME (t)
 168           && (DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t))));
 169 }
 170
 171 /* Return true if BINFO corresponds to a type with virtual methods.
 172
 173    Every type has several BINFOs.  One is the BINFO associated by the type
 174    while other represents bases of derived types.  The BINFOs representing
 175    bases do not have BINFO_VTABLE pointer set when this is the single
 176    inheritance (because vtables are shared).  Look up the BINFO of type
 177    and check presence of its vtable.  */
 178
 179 inline bool
 180 polymorphic_type_binfo_p (const_tree binfo)
 181 {
 182   /* See if BINFO's type has an virtual table associtated with it.
 183      Check is defensive because of Java FE produces BINFOs
 184      without BINFO_TYPE set.   */
 185   return BINFO_TYPE (binfo) && BINFO_VTABLE (TYPE_BINFO (BINFO_TYPE (binfo)));
 186 }
 187 #endif  /* GCC_IPA_UTILS_H  */
 188
 189