1 /* Utilities for ipa analysis.
2 Copyright (C) 2004-2016 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, bool preserve_body = false);
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 odr_type_p (const_tree);
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 polymorphic_ctor_dtor_p (tree, bool);
74 tree inlined_polymorphic_ctor_dtor_block_p (tree, bool);
75 bool decl_maybe_in_construction_p (tree, tree, gimple *, tree);
76 tree vtable_pointer_value_to_binfo (const_tree);
77 bool vtable_pointer_value_to_vtable (const_tree, tree *, unsigned HOST_WIDE_INT *);
78 tree subbinfo_with_vtable_at_offset (tree, unsigned HOST_WIDE_INT, tree);
79 void compare_virtual_tables (varpool_node *, varpool_node *);
80 bool type_all_derivations_known_p (const_tree);
81 bool type_known_to_have_no_derivations_p (tree);
82 bool contains_polymorphic_type_p (const_tree);
83 void register_odr_type (tree);
84 bool types_must_be_same_for_odr (tree, tree);
85 bool types_odr_comparable (tree, tree, bool strict = false);
86 cgraph_node *try_speculative_devirtualization (tree, HOST_WIDE_INT,
87 ipa_polymorphic_call_context);
88 void warn_types_mismatch (tree t1, tree t2, location_t loc1 = UNKNOWN_LOCATION,
89 location_t loc2 = UNKNOWN_LOCATION);
90 bool odr_or_derived_type_p (const_tree t);
91 bool 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
103 inline vec <cgraph_node *>
104 possible_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
120 inline vec <cgraph_node *>
121 possible_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
137 inline void
dump_possible_polymorphic_call_targets(FILE * f,struct cgraph_edge * e)138 dump_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
150 inline bool
possible_polymorphic_call_target_p(struct cgraph_edge * e,struct cgraph_node * n)151 possible_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
169 inline bool
polymorphic_type_binfo_p(const_tree binfo)170 polymorphic_type_binfo_p (const_tree binfo)
171 {
172 /* See if BINFO's type has an virtual table associtated with it.
173 Check is defensive because of Java FE produces BINFOs
174 without BINFO_TYPE set. */
175 return (BINFO_TYPE (binfo) && TYPE_BINFO (BINFO_TYPE (binfo))
176 && BINFO_VTABLE (TYPE_BINFO (BINFO_TYPE (binfo))));
177 }
178
179 /* Return true if T is a type with linkage defined. */
180
181 inline bool
type_with_linkage_p(const_tree t)182 type_with_linkage_p (const_tree t)
183 {
184 if (!TYPE_NAME (t) || TREE_CODE (TYPE_NAME (t)) != TYPE_DECL
185 || !TYPE_STUB_DECL (t))
186 return false;
187 /* In LTO do not get confused by non-C++ produced types or types built
188 with -fno-lto-odr-type-merigng. */
189 if (in_lto_p)
190 {
191 /* To support -fno-lto-odr-type-merigng recognize types with vtables
192 to have linkage. */
193 if (RECORD_OR_UNION_TYPE_P (t)
194 && TYPE_BINFO (t) && BINFO_VTABLE (TYPE_BINFO (t)))
195 return true;
196 /* With -flto-odr-type-merging C++ FE specify mangled names
197 for all types with the linkage. */
198 return DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t));
199 }
200
201 if (!RECORD_OR_UNION_TYPE_P (t) && TREE_CODE (t) != ENUMERAL_TYPE)
202 return false;
203
204 /* Builtin types do not define linkage, their TYPE_CONTEXT is NULL. */
205 if (!TYPE_CONTEXT (t))
206 return false;
207
208 return true;
209 }
210
211 /* Return true if T is in anonymous namespace.
212 This works only on those C++ types with linkage defined. */
213
214 inline bool
type_in_anonymous_namespace_p(const_tree t)215 type_in_anonymous_namespace_p (const_tree t)
216 {
217 gcc_checking_assert (type_with_linkage_p (t));
218
219 if (!TREE_PUBLIC (TYPE_STUB_DECL (t)))
220 {
221 /* C++ FE uses magic <anon> as assembler names of anonymous types.
222 verify that this match with type_in_anonymous_namespace_p. */
223 gcc_checking_assert (!in_lto_p || !DECL_ASSEMBLER_NAME_SET_P (t)
224 || !strcmp
225 ("<anon>",
226 IDENTIFIER_POINTER
227 (DECL_ASSEMBLER_NAME (TYPE_NAME (t)))));
228 return true;
229 }
230 return false;
231 }
232
233 /* Return true of T is type with One Definition Rule info attached.
234 It means that either it is anonymous type or it has assembler name
235 set. */
236
237 inline bool
odr_type_p(const_tree t)238 odr_type_p (const_tree t)
239 {
240 /* We do not have this information when not in LTO, but we do not need
241 to care, since it is used only for type merging. */
242 gcc_checking_assert (in_lto_p || flag_lto);
243
244 if (!type_with_linkage_p (t))
245 return false;
246
247 /* To support -fno-lto-odr-type-merging consider types with vtables ODR. */
248 if (type_in_anonymous_namespace_p (t))
249 return true;
250
251 if (TYPE_NAME (t) && TREE_CODE (TYPE_NAME (t)) == TYPE_DECL
252 && DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t)))
253 {
254 /* C++ FE uses magic <anon> as assembler names of anonymous types.
255 verify that this match with type_in_anonymous_namespace_p. */
256 gcc_checking_assert (strcmp ("<anon>",
257 IDENTIFIER_POINTER
258 (DECL_ASSEMBLER_NAME (TYPE_NAME (t)))));
259 return true;
260 }
261 return false;
262 }
263
264 #endif /* GCC_IPA_UTILS_H */
265
266
267