1/* Utilities for ipa analysis.
2 Copyright (C) 2004-2017 Free Software Foundation, Inc.
3 Contributed by Kenneth Zadeck <zadeck@naturalbridge.com>
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify it under
8the terms of the GNU General Public License as published by the Free
9Software Foundation; either version 3, or (at your option) any later
10version.
11
12GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or
14FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15for more details.
16
17You should have received a copy of the GNU General Public License
18along 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
24struct 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 */
38void ipa_print_order (FILE*, const char *, struct cgraph_node**, int);
39int ipa_reduced_postorder (struct cgraph_node **, bool, bool,
40 bool (*ignore_edge) (struct cgraph_edge *));
41void ipa_free_postorder_info (void);
42vec<cgraph_node *> ipa_get_nodes_in_cycle (struct cgraph_node *);
43bool ipa_edge_within_scc (struct cgraph_edge *);
44int ipa_reverse_postorder (struct cgraph_node **);
45tree get_base_var (tree);
46void ipa_merge_profiles (struct cgraph_node *dst,
47 struct cgraph_node *src, bool preserve_body = false);
48bool recursive_call_p (tree, tree);
49
50/* In ipa-profile.c */
51bool ipa_propagate_frequency (struct cgraph_node *node);
52
53/* In ipa-devirt.c */
54
55struct odr_type_d;
56typedef odr_type_d *odr_type;
57void build_type_inheritance_graph (void);
58void update_type_inheritance_graph (void);
59vec <cgraph_node *>
60possible_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);
65odr_type get_odr_type (tree, bool insert = false);
66bool odr_type_p (const_tree);
67bool possible_polymorphic_call_target_p (tree ref, gimple *stmt, struct cgraph_node *n);
68void dump_possible_polymorphic_call_targets (FILE *, tree, HOST_WIDE_INT,
69 const ipa_polymorphic_call_context &);
70bool possible_polymorphic_call_target_p (tree, HOST_WIDE_INT,
71 const ipa_polymorphic_call_context &,
72 struct cgraph_node *);
73tree polymorphic_ctor_dtor_p (tree, bool);
74tree inlined_polymorphic_ctor_dtor_block_p (tree, bool);
75bool decl_maybe_in_construction_p (tree, tree, gimple *, tree);
76tree vtable_pointer_value_to_binfo (const_tree);
77bool vtable_pointer_value_to_vtable (const_tree, tree *, unsigned HOST_WIDE_INT *);
78tree subbinfo_with_vtable_at_offset (tree, unsigned HOST_WIDE_INT, tree);
79void compare_virtual_tables (varpool_node *, varpool_node *);
80bool type_all_derivations_known_p (const_tree);
81bool type_known_to_have_no_derivations_p (tree);
82bool contains_polymorphic_type_p (const_tree);
83void register_odr_type (tree);
84bool types_must_be_same_for_odr (tree, tree);
85bool types_odr_comparable (tree, tree, bool strict = false);
86cgraph_node *try_speculative_devirtualization (tree, HOST_WIDE_INT,
87 ipa_polymorphic_call_context);
88void warn_types_mismatch (tree t1, tree t2, location_t loc1 = UNKNOWN_LOCATION,
89 location_t loc2 = UNKNOWN_LOCATION);
90bool odr_or_derived_type_p (const_tree t);
91bool odr_types_equivalent_p (tree type1, tree type2);
92
93/* Return vector containing possible targets of polymorphic call E.
94 If COMPLETEP is non-NULL, store true if the list is complete.
95 CACHE_TOKEN (if non-NULL) will get stored to an unique ID of entry
96 in the target cache. If user needs to visit every target list
97 just once, it can memoize them.
98
99 Returned vector is placed into cache. It is NOT caller's responsibility
100 to free it. The vector can be freed on cgraph_remove_node call if
101 the particular node is a virtual function present in the cache. */
102
103inline vec <cgraph_node *>
104possible_polymorphic_call_targets (struct cgraph_edge *e,
105 bool *completep = NULL,
106 void **cache_token = NULL,
107 bool speculative = false)
108{
109 ipa_polymorphic_call_context context(e);
110
111 return possible_polymorphic_call_targets (e->indirect_info->otr_type,
112 e->indirect_info->otr_token,
113 context,
114 completep, cache_token,
115 speculative);
116}
117
118/* Same as above but taking OBJ_TYPE_REF as an parameter. */
119
120inline vec <cgraph_node *>
121possible_polymorphic_call_targets (tree ref,
122 gimple *call,
123 bool *completep = NULL,
124 void **cache_token = NULL)
125{
126 ipa_polymorphic_call_context context (current_function_decl, ref, call);
127
128 return possible_polymorphic_call_targets (obj_type_ref_class (ref),
129 tree_to_uhwi
130 (OBJ_TYPE_REF_TOKEN (ref)),
131 context,
132 completep, cache_token);
133}
134
135/* Dump possible targets of a polymorphic call E into F. */
136
137inline void
138dump_possible_polymorphic_call_targets (FILE *f, struct cgraph_edge *e)
139{
140 ipa_polymorphic_call_context context(e);
141
142 dump_possible_polymorphic_call_targets (f, e->indirect_info->otr_type,
143 e->indirect_info->otr_token,
144 context);
145}
146
147/* Return true if N can be possibly target of a polymorphic call of
148 E. */
149
150inline bool
151possible_polymorphic_call_target_p (struct cgraph_edge *e,
152 struct cgraph_node *n)
153{
154 ipa_polymorphic_call_context context(e);
155
156 return possible_polymorphic_call_target_p (e->indirect_info->otr_type,
157 e->indirect_info->otr_token,
158 context, n);
159}
160
161/* Return true if BINFO corresponds to a type with virtual methods.
162
163 Every type has several BINFOs. One is the BINFO associated by the type
164 while other represents bases of derived types. The BINFOs representing
165 bases do not have BINFO_VTABLE pointer set when this is the single
166 inheritance (because vtables are shared). Look up the BINFO of type
167 and check presence of its vtable. */
168
169inline bool
170polymorphic_type_binfo_p (const_tree binfo)
171{
172 return (BINFO_TYPE (binfo) && TYPE_BINFO (BINFO_TYPE (binfo))
173 && BINFO_VTABLE (TYPE_BINFO (BINFO_TYPE (binfo))));
174}
175
176/* Return true if T is a type with linkage defined. */
177
178inline bool
179type_with_linkage_p (const_tree t)
180{
181 if (!TYPE_NAME (t) || TREE_CODE (TYPE_NAME (t)) != TYPE_DECL
182 || !TYPE_STUB_DECL (t))
183 return false;
184 /* In LTO do not get confused by non-C++ produced types or types built
185 with -fno-lto-odr-type-merigng. */
186 if (in_lto_p)
187 {
188 /* To support -fno-lto-odr-type-merigng recognize types with vtables
189 to have linkage. */
190 if (RECORD_OR_UNION_TYPE_P (t)
191 && TYPE_BINFO (t) && BINFO_VTABLE (TYPE_BINFO (t)))
192 return true;
193 /* With -flto-odr-type-merging C++ FE specify mangled names
194 for all types with the linkage. */
195 return DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t));
196 }
197
198 if (!RECORD_OR_UNION_TYPE_P (t) && TREE_CODE (t) != ENUMERAL_TYPE)
199 return false;
200
201 /* Builtin types do not define linkage, their TYPE_CONTEXT is NULL. */
202 if (!TYPE_CONTEXT (t))
203 return false;
204
205 return true;
206}
207
208/* Return true if T is in anonymous namespace.
209 This works only on those C++ types with linkage defined. */
210
211inline bool
212type_in_anonymous_namespace_p (const_tree t)
213{
214 gcc_checking_assert (type_with_linkage_p (t));
215
216 if (!TREE_PUBLIC (TYPE_STUB_DECL (t)))
217 {
218 /* C++ FE uses magic <anon> as assembler names of anonymous types.
219 verify that this match with type_in_anonymous_namespace_p. */
220 gcc_checking_assert (!in_lto_p
221 || !DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t))
222 || !strcmp ("<anon>",
223 IDENTIFIER_POINTER
224 (DECL_ASSEMBLER_NAME (TYPE_NAME (t)))));
225 return true;
226 }
227 return false;
228}
229
230/* Return true of T is type with One Definition Rule info attached.
231 It means that either it is anonymous type or it has assembler name
232 set. */
233
234inline bool
235odr_type_p (const_tree t)
236{
237 /* We do not have this information when not in LTO, but we do not need
238 to care, since it is used only for type merging. */
239 gcc_checking_assert (in_lto_p || flag_lto);
240
241 if (!type_with_linkage_p (t))
242 return false;
243
244 /* To support -fno-lto-odr-type-merging consider types with vtables ODR. */
245 if (type_in_anonymous_namespace_p (t))
246 return true;
247
248 if (TYPE_NAME (t) && DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t)))
249 {
250 /* C++ FE uses magic <anon> as assembler names of anonymous types.
251 verify that this match with type_in_anonymous_namespace_p. */
252 gcc_checking_assert (strcmp ("<anon>",
253 IDENTIFIER_POINTER
254 (DECL_ASSEMBLER_NAME (TYPE_NAME (t)))));
255 return true;
256 }
257 return false;
258}
259
260#endif /* GCC_IPA_UTILS_H */
261
262
263