1 /* Utilities for ipa analysis.
2 Copyright (C) 2004-2021 Free Software Foundation, Inc.
3 Contributed by Kenneth Zadeck <zadeck@naturalbridge.com>
5 This file is part of GCC.
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
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
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/>. */
21 #ifndef GCC_IPA_UTILS_H
22 #define GCC_IPA_UTILS_H
27 /* This field will have the samy value for any two nodes in the same strongly
28 connected component. */
32 struct cgraph_node
* next_cycle
;
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
);
50 /* In ipa-profile.c */
51 bool ipa_propagate_frequency (struct cgraph_node
*node
);
56 typedef odr_type_d
*odr_type
;
57 extern bool thunk_expansion
;
58 void build_type_inheritance_graph (void);
59 void rebuild_type_inheritance_graph (void);
60 void update_type_inheritance_graph (void);
62 possible_polymorphic_call_targets (tree
, HOST_WIDE_INT
,
63 ipa_polymorphic_call_context
,
64 bool *copletep
= NULL
,
65 void **cache_token
= NULL
,
66 bool speuclative
= false);
67 odr_type
get_odr_type (tree
, bool insert
= false);
68 bool odr_type_p (const_tree
);
69 bool possible_polymorphic_call_target_p (tree ref
, gimple
*stmt
, struct cgraph_node
*n
);
70 void dump_possible_polymorphic_call_targets (FILE *, tree
, HOST_WIDE_INT
,
71 const ipa_polymorphic_call_context
&,
73 bool possible_polymorphic_call_target_p (tree
, HOST_WIDE_INT
,
74 const ipa_polymorphic_call_context
&,
75 struct cgraph_node
*);
76 tree
polymorphic_ctor_dtor_p (tree
, bool);
77 tree
inlined_polymorphic_ctor_dtor_block_p (tree
, bool);
78 bool decl_maybe_in_construction_p (tree
, tree
, gimple
*, tree
);
79 tree
vtable_pointer_value_to_binfo (const_tree
);
80 bool vtable_pointer_value_to_vtable (const_tree
, tree
*, unsigned HOST_WIDE_INT
*);
81 tree
subbinfo_with_vtable_at_offset (tree
, unsigned HOST_WIDE_INT
, tree
);
82 void compare_virtual_tables (varpool_node
*, varpool_node
*);
83 bool type_all_derivations_known_p (const_tree
);
84 bool type_known_to_have_no_derivations_p (tree
);
85 bool contains_polymorphic_type_p (const_tree
);
86 void register_odr_type (tree
);
87 bool types_must_be_same_for_odr (tree
, tree
);
88 bool types_odr_comparable (tree
, tree
);
89 cgraph_node
*try_speculative_devirtualization (tree
, HOST_WIDE_INT
,
90 ipa_polymorphic_call_context
);
91 void warn_types_mismatch (tree t1
, tree t2
, location_t loc1
= UNKNOWN_LOCATION
,
92 location_t loc2
= UNKNOWN_LOCATION
);
93 bool odr_or_derived_type_p (const_tree t
);
94 bool odr_types_equivalent_p (tree type1
, tree type2
);
95 bool odr_type_violation_reported_p (tree type
);
96 tree
prevailing_odr_type (tree type
);
97 void enable_odr_based_tbaa (tree type
);
98 bool odr_based_tbaa_p (const_tree type
);
99 void set_type_canonical_for_odr_type (tree type
, tree canonical
);
101 void register_odr_enum (tree type
);
103 /* Return vector containing possible targets of polymorphic call E.
104 If COMPLETEP is non-NULL, store true if the list is complete.
105 CACHE_TOKEN (if non-NULL) will get stored to an unique ID of entry
106 in the target cache. If user needs to visit every target list
107 just once, it can memoize them.
109 Returned vector is placed into cache. It is NOT caller's responsibility
110 to free it. The vector can be freed on cgraph_remove_node call if
111 the particular node is a virtual function present in the cache. */
113 inline vec
<cgraph_node
*>
114 possible_polymorphic_call_targets (struct cgraph_edge
*e
,
115 bool *completep
= NULL
,
116 void **cache_token
= NULL
,
117 bool speculative
= false)
119 ipa_polymorphic_call_context
context(e
);
121 return possible_polymorphic_call_targets (e
->indirect_info
->otr_type
,
122 e
->indirect_info
->otr_token
,
124 completep
, cache_token
,
128 /* Same as above but taking OBJ_TYPE_REF as an parameter. */
130 inline vec
<cgraph_node
*>
131 possible_polymorphic_call_targets (tree ref
,
133 bool *completep
= NULL
,
134 void **cache_token
= NULL
)
136 ipa_polymorphic_call_context
context (current_function_decl
, ref
, call
);
138 return possible_polymorphic_call_targets (obj_type_ref_class (ref
),
140 (OBJ_TYPE_REF_TOKEN (ref
)),
142 completep
, cache_token
);
145 /* Dump possible targets of a polymorphic call E into F. */
148 dump_possible_polymorphic_call_targets (FILE *f
, struct cgraph_edge
*e
,
151 ipa_polymorphic_call_context
context(e
);
153 dump_possible_polymorphic_call_targets (f
, e
->indirect_info
->otr_type
,
154 e
->indirect_info
->otr_token
,
158 /* Return true if N can be possibly target of a polymorphic call of
162 possible_polymorphic_call_target_p (struct cgraph_edge
*e
,
163 struct cgraph_node
*n
)
165 ipa_polymorphic_call_context
context(e
);
167 return possible_polymorphic_call_target_p (e
->indirect_info
->otr_type
,
168 e
->indirect_info
->otr_token
,
172 /* Return true if BINFO corresponds to a type with virtual methods.
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. */
181 polymorphic_type_binfo_p (const_tree binfo
)
183 return (BINFO_TYPE (binfo
) && TYPE_BINFO (BINFO_TYPE (binfo
))
184 && BINFO_VTABLE (TYPE_BINFO (BINFO_TYPE (binfo
))));
187 /* Return true if T is a type with linkage defined. */
190 type_with_linkage_p (const_tree t
)
192 gcc_checking_assert (TYPE_MAIN_VARIANT (t
) == t
);
193 if (!TYPE_NAME (t
) || TREE_CODE (TYPE_NAME (t
)) != TYPE_DECL
)
196 /* After free_lang_data was run we can recongize
197 types with linkage by presence of mangled name. */
198 if (DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t
)))
204 /* We used to check for TYPE_STUB_DECL but that is set to NULL for forward
207 if (!RECORD_OR_UNION_TYPE_P (t
) && TREE_CODE (t
) != ENUMERAL_TYPE
)
210 /* Builtin types do not define linkage, their TYPE_CONTEXT is NULL. */
211 if (!TYPE_CONTEXT (t
))
217 /* Return true if T is in anonymous namespace.
218 This works only on those C++ types with linkage defined. */
221 type_in_anonymous_namespace_p (const_tree t
)
223 gcc_checking_assert (type_with_linkage_p (t
));
225 /* free_lang_data clears TYPE_STUB_DECL but sets assembler name to
227 if (DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t
)))
228 return !strcmp ("<anon>",
230 (DECL_ASSEMBLER_NAME (TYPE_NAME (t
))));
231 else if (!TYPE_STUB_DECL (t
))
234 return !TREE_PUBLIC (TYPE_STUB_DECL (t
));
237 /* Return true of T is type with One Definition Rule info attached.
238 It means that either it is anonymous type or it has assembler name
242 odr_type_p (const_tree t
)
244 /* We do not have this information when not in LTO, but we do not need
245 to care, since it is used only for type merging. */
246 gcc_checking_assert (in_lto_p
|| flag_lto
|| flag_generate_offload
);
247 return TYPE_NAME (t
) && TREE_CODE (TYPE_NAME (t
)) == TYPE_DECL
248 && DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t
));
251 /* If TYPE has mangled ODR name, return it. Otherwise return NULL.
252 The function works only when free_lang_data is run. */
255 get_odr_name_for_type (tree type
)
257 tree type_name
= TYPE_NAME (type
);
258 if (type_name
== NULL_TREE
259 || TREE_CODE (type_name
) != TYPE_DECL
260 || !DECL_ASSEMBLER_NAME_SET_P (type_name
))
263 return IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (type_name
));
266 /* Return true if we are going to do LTO streaming. */
269 lto_streaming_expected_p ()
271 /* Compilation before LTO stremaing. */
272 if (flag_lto
&& !in_lto_p
&& symtab
->state
< IPA_SSA_AFTER_INLINING
)
274 /* WPA or incremental link. */
275 return (flag_wpa
|| flag_incremental_link
== INCREMENTAL_LINK_LTO
);
278 #endif /* GCC_IPA_UTILS_H */