PR jit/63854: Introduce xstrdup_for_dump
[official-gcc.git] / gcc / ipa-devirt.c
blob41d4554784d3bfa239da63880e5c6fc53add1a0e
1 /* Basic IPA utilities for type inheritance graph construction and
2 devirtualization.
3 Copyright (C) 2013-2014 Free Software Foundation, Inc.
4 Contributed by Jan Hubicka
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 3, or (at your option) any later
11 version.
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 for more details.
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
22 /* Brief vocalburary:
23 ODR = One Definition Rule
24 In short, the ODR states that:
25 1 In any translation unit, a template, type, function, or object can
26 have no more than one definition. Some of these can have any number
27 of declarations. A definition provides an instance.
28 2 In the entire program, an object or non-inline function cannot have
29 more than one definition; if an object or function is used, it must
30 have exactly one definition. You can declare an object or function
31 that is never used, in which case you don't have to provide
32 a definition. In no event can there be more than one definition.
33 3 Some things, like types, templates, and extern inline functions, can
34 be defined in more than one translation unit. For a given entity,
35 each definition must be the same. Non-extern objects and functions
36 in different translation units are different entities, even if their
37 names and types are the same.
39 OTR = OBJ_TYPE_REF
40 This is the Gimple representation of type information of a polymorphic call.
41 It contains two parameters:
42 otr_type is a type of class whose method is called.
43 otr_token is the index into virtual table where address is taken.
45 BINFO
46 This is the type inheritance information attached to each tree
47 RECORD_TYPE by the C++ frotend. It provides information about base
48 types and virtual tables.
50 BINFO is linked to the RECORD_TYPE by TYPE_BINFO.
51 BINFO also links to its type by BINFO_TYPE and to the virtual table by
52 BINFO_VTABLE.
54 Base types of a given type are enumerated by BINFO_BASE_BINFO
55 vector. Members of this vectors are not BINFOs associated
56 with a base type. Rather they are new copies of BINFOs
57 (base BINFOs). Their virtual tables may differ from
58 virtual table of the base type. Also BINFO_OFFSET specifies
59 offset of the base within the type.
61 In the case of single inheritance, the virtual table is shared
62 and BINFO_VTABLE of base BINFO is NULL. In the case of multiple
63 inheritance the individual virtual tables are pointer to by
64 BINFO_VTABLE of base binfos (that differs of BINFO_VTABLE of
65 binfo associated to the base type).
67 BINFO lookup for a given base type and offset can be done by
68 get_binfo_at_offset. It returns proper BINFO whose virtual table
69 can be used for lookup of virtual methods associated with the
70 base type.
72 token
73 This is an index of virtual method in virtual table associated
74 to the type defining it. Token can be looked up from OBJ_TYPE_REF
75 or from DECL_VINDEX of a given virtual table.
77 polymorphic (indirect) call
78 This is callgraph represention of virtual method call. Every
79 polymorphic call contains otr_type and otr_token taken from
80 original OBJ_TYPE_REF at callgraph construction time.
82 What we do here:
84 build_type_inheritance_graph triggers a construction of the type inheritance
85 graph.
87 We reconstruct it based on types of methods we see in the unit.
88 This means that the graph is not complete. Types with no methods are not
89 inserted into the graph. Also types without virtual methods are not
90 represented at all, though it may be easy to add this.
92 The inheritance graph is represented as follows:
94 Vertices are structures odr_type. Every odr_type may correspond
95 to one or more tree type nodes that are equivalent by ODR rule.
96 (the multiple type nodes appear only with linktime optimization)
98 Edges are represented by odr_type->base and odr_type->derived_types.
99 At the moment we do not track offsets of types for multiple inheritance.
100 Adding this is easy.
102 possible_polymorphic_call_targets returns, given an parameters found in
103 indirect polymorphic edge all possible polymorphic call targets of the call.
105 pass_ipa_devirt performs simple speculative devirtualization.
108 #include "config.h"
109 #include "system.h"
110 #include "coretypes.h"
111 #include "tm.h"
112 #include "tree.h"
113 #include "print-tree.h"
114 #include "calls.h"
115 #include "predict.h"
116 #include "basic-block.h"
117 #include "hash-map.h"
118 #include "is-a.h"
119 #include "plugin-api.h"
120 #include "vec.h"
121 #include "hashtab.h"
122 #include "hash-set.h"
123 #include "machmode.h"
124 #include "hard-reg-set.h"
125 #include "input.h"
126 #include "function.h"
127 #include "ipa-ref.h"
128 #include "cgraph.h"
129 #include "expr.h"
130 #include "tree-pass.h"
131 #include "target.h"
132 #include "hash-table.h"
133 #include "inchash.h"
134 #include "tree-pretty-print.h"
135 #include "ipa-utils.h"
136 #include "tree-ssa-alias.h"
137 #include "internal-fn.h"
138 #include "gimple-fold.h"
139 #include "gimple-expr.h"
140 #include "gimple.h"
141 #include "alloc-pool.h"
142 #include "ipa-prop.h"
143 #include "ipa-inline.h"
144 #include "diagnostic.h"
145 #include "tree-dfa.h"
146 #include "demangle.h"
147 #include "dbgcnt.h"
148 #include "gimple-pretty-print.h"
149 #include "stor-layout.h"
150 #include "intl.h"
152 /* Hash based set of pairs of types. */
153 typedef struct
155 tree first;
156 tree second;
157 } type_pair;
159 struct pair_traits : default_hashset_traits
161 static hashval_t
162 hash (type_pair p)
164 return TYPE_UID (p.first) ^ TYPE_UID (p.second);
166 static bool
167 is_empty (type_pair p)
169 return p.first == NULL;
171 static bool
172 is_deleted (type_pair p ATTRIBUTE_UNUSED)
174 return false;
176 static bool
177 equal (const type_pair &a, const type_pair &b)
179 return a.first==b.first && a.second == b.second;
181 static void
182 mark_empty (type_pair &e)
184 e.first = NULL;
188 static bool odr_types_equivalent_p (tree, tree, bool, bool *,
189 hash_set<type_pair,pair_traits> *);
191 static bool odr_violation_reported = false;
194 /* Pointer set of all call targets appearing in the cache. */
195 static hash_set<cgraph_node *> *cached_polymorphic_call_targets;
197 /* The node of type inheritance graph. For each type unique in
198 One Defintion Rule (ODR) sense, we produce one node linking all
199 main variants of types equivalent to it, bases and derived types. */
201 struct GTY(()) odr_type_d
203 /* leader type. */
204 tree type;
205 /* All bases; built only for main variants of types */
206 vec<odr_type> GTY((skip)) bases;
207 /* All derrived types with virtual methods seen in unit;
208 built only for main variants oftypes */
209 vec<odr_type> GTY((skip)) derived_types;
211 /* All equivalent types, if more than one. */
212 vec<tree, va_gc> *types;
213 /* Set of all equivalent types, if NON-NULL. */
214 hash_set<tree> * GTY((skip)) types_set;
216 /* Unique ID indexing the type in odr_types array. */
217 int id;
218 /* Is it in anonymous namespace? */
219 bool anonymous_namespace;
220 /* Do we know about all derivations of given type? */
221 bool all_derivations_known;
222 /* Did we report ODR violation here? */
223 bool odr_violated;
226 /* Return TRUE if all derived types of T are known and thus
227 we may consider the walk of derived type complete.
229 This is typically true only for final anonymous namespace types and types
230 defined within functions (that may be COMDAT and thus shared across units,
231 but with the same set of derived types). */
233 bool
234 type_all_derivations_known_p (const_tree t)
236 if (TYPE_FINAL_P (t))
237 return true;
238 if (flag_ltrans)
239 return false;
240 /* Non-C++ types may have IDENTIFIER_NODE here, do not crash. */
241 if (!TYPE_NAME (t) || TREE_CODE (TYPE_NAME (t)) != TYPE_DECL)
242 return true;
243 if (type_in_anonymous_namespace_p (t))
244 return true;
245 return (decl_function_context (TYPE_NAME (t)) != NULL);
248 /* Return TURE if type's constructors are all visible. */
250 static bool
251 type_all_ctors_visible_p (tree t)
253 return !flag_ltrans
254 && symtab->state >= CONSTRUCTION
255 /* We can not always use type_all_derivations_known_p.
256 For function local types we must assume case where
257 the function is COMDAT and shared in between units.
259 TODO: These cases are quite easy to get, but we need
260 to keep track of C++ privatizing via -Wno-weak
261 as well as the IPA privatizing. */
262 && type_in_anonymous_namespace_p (t);
265 /* Return TRUE if type may have instance. */
267 static bool
268 type_possibly_instantiated_p (tree t)
270 tree vtable;
271 varpool_node *vnode;
273 /* TODO: Add abstract types here. */
274 if (!type_all_ctors_visible_p (t))
275 return true;
277 vtable = BINFO_VTABLE (TYPE_BINFO (t));
278 if (TREE_CODE (vtable) == POINTER_PLUS_EXPR)
279 vtable = TREE_OPERAND (TREE_OPERAND (vtable, 0), 0);
280 vnode = varpool_node::get (vtable);
281 return vnode && vnode->definition;
284 /* One Definition Rule hashtable helpers. */
286 struct odr_hasher
288 typedef odr_type_d value_type;
289 typedef union tree_node compare_type;
290 static inline hashval_t hash (const value_type *);
291 static inline bool equal (const value_type *, const compare_type *);
292 static inline void remove (value_type *);
295 /* Return type that was declared with T's name so that T is an
296 qualified variant of it. */
298 static inline tree
299 main_odr_variant (const_tree t)
301 if (TYPE_NAME (t) && TREE_CODE (TYPE_NAME (t)) == TYPE_DECL)
302 return TREE_TYPE (TYPE_NAME (t));
303 /* Unnamed types and non-C++ produced types can be compared by variants. */
304 else
305 return TYPE_MAIN_VARIANT (t);
308 /* Produce hash based on type name. */
310 static hashval_t
311 hash_type_name (tree t)
313 gcc_checking_assert (main_odr_variant (t) == t);
315 /* If not in LTO, all main variants are unique, so we can do
316 pointer hash. */
317 if (!in_lto_p)
318 return htab_hash_pointer (t);
320 /* Anonymous types are unique. */
321 if (type_in_anonymous_namespace_p (t))
322 return htab_hash_pointer (t);
324 /* ODR types have name specified. */
325 if (TYPE_NAME (t)
326 && DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t)))
327 return IDENTIFIER_HASH_VALUE (DECL_ASSEMBLER_NAME (TYPE_NAME (t)));
329 /* For polymorphic types that was compiled with -fno-lto-odr-type-merging
330 we can simply hash the virtual table. */
331 if (TREE_CODE (t) == RECORD_TYPE
332 && TYPE_BINFO (t) && BINFO_VTABLE (TYPE_BINFO (t)))
334 tree v = BINFO_VTABLE (TYPE_BINFO (t));
335 hashval_t hash = 0;
337 if (TREE_CODE (v) == POINTER_PLUS_EXPR)
339 hash = TREE_INT_CST_LOW (TREE_OPERAND (v, 1));
340 v = TREE_OPERAND (TREE_OPERAND (v, 0), 0);
343 v = DECL_ASSEMBLER_NAME (v);
344 hash = iterative_hash_hashval_t (hash, htab_hash_pointer (v));
345 return hash;
348 /* Builtin types may appear as main variants of ODR types and are unique.
349 Sanity check we do not get anything that looks non-builtin. */
350 gcc_checking_assert (TREE_CODE (t) == INTEGER_TYPE
351 || TREE_CODE (t) == VOID_TYPE
352 || TREE_CODE (t) == COMPLEX_TYPE
353 || TREE_CODE (t) == REAL_TYPE
354 || TREE_CODE (t) == POINTER_TYPE);
355 return htab_hash_pointer (t);
358 /* Return the computed hashcode for ODR_TYPE. */
360 inline hashval_t
361 odr_hasher::hash (const value_type *odr_type)
363 return hash_type_name (odr_type->type);
366 /* For languages with One Definition Rule, work out if
367 types are the same based on their name.
369 This is non-trivial for LTO where minnor differences in
370 the type representation may have prevented type merging
371 to merge two copies of otherwise equivalent type.
373 Until we start streaming mangled type names, this function works
374 only for polymorphic types. */
376 bool
377 types_same_for_odr (const_tree type1, const_tree type2)
379 gcc_checking_assert (TYPE_P (type1) && TYPE_P (type2));
381 type1 = main_odr_variant (type1);
382 type2 = main_odr_variant (type2);
384 if (type1 == type2)
385 return true;
387 if (!in_lto_p)
388 return false;
390 /* Check for anonymous namespaces. Those have !TREE_PUBLIC
391 on the corresponding TYPE_STUB_DECL. */
392 if (type_in_anonymous_namespace_p (type1)
393 || type_in_anonymous_namespace_p (type2))
394 return false;
397 /* ODR name of the type is set in DECL_ASSEMBLER_NAME of its TYPE_NAME.
399 Ideally we should never meed types without ODR names here. It can however
400 happen in two cases:
402 1) for builtin types that are not streamed but rebuilt in lto/lto-lang.c
403 Here testing for equivalence is safe, since their MAIN_VARIANTs are
404 unique.
405 2) for units streamed with -fno-lto-odr-type-merging. Here we can't
406 establish precise ODR equivalency, but for correctness we care only
407 about equivalency on complete polymorphic types. For these we can
408 compare assembler names of their virtual tables. */
409 if ((!TYPE_NAME (type1) || !DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (type1)))
410 || (!TYPE_NAME (type2) || !DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (type2))))
412 /* See if types are obvoiusly different (i.e. different codes
413 or polymorphis wrt non-polymorphic). This is not strictly correct
414 for ODR violating programs, but we can't do better without streaming
415 ODR names. */
416 if (TREE_CODE (type1) != TREE_CODE (type2))
417 return false;
418 if (TREE_CODE (type1) == RECORD_TYPE
419 && (TYPE_BINFO (type1) == NULL_TREE) != (TYPE_BINFO (type1) == NULL_TREE))
420 return false;
421 if (TREE_CODE (type1) == RECORD_TYPE && TYPE_BINFO (type1)
422 && (BINFO_VTABLE (TYPE_BINFO (type1)) == NULL_TREE)
423 != (BINFO_VTABLE (TYPE_BINFO (type2)) == NULL_TREE))
424 return false;
426 /* At the moment we have no way to establish ODR equivlaence at LTO
427 other than comparing virtual table pointrs of polymorphic types.
428 Eventually we should start saving mangled names in TYPE_NAME.
429 Then this condition will become non-trivial. */
431 if (TREE_CODE (type1) == RECORD_TYPE
432 && TYPE_BINFO (type1) && TYPE_BINFO (type2)
433 && BINFO_VTABLE (TYPE_BINFO (type1))
434 && BINFO_VTABLE (TYPE_BINFO (type2)))
436 tree v1 = BINFO_VTABLE (TYPE_BINFO (type1));
437 tree v2 = BINFO_VTABLE (TYPE_BINFO (type2));
438 gcc_assert (TREE_CODE (v1) == POINTER_PLUS_EXPR
439 && TREE_CODE (v2) == POINTER_PLUS_EXPR);
440 return (operand_equal_p (TREE_OPERAND (v1, 1),
441 TREE_OPERAND (v2, 1), 0)
442 && DECL_ASSEMBLER_NAME
443 (TREE_OPERAND (TREE_OPERAND (v1, 0), 0))
444 == DECL_ASSEMBLER_NAME
445 (TREE_OPERAND (TREE_OPERAND (v2, 0), 0)));
447 gcc_unreachable ();
449 return (DECL_ASSEMBLER_NAME (TYPE_NAME (type1))
450 == DECL_ASSEMBLER_NAME (TYPE_NAME (type2)));
453 /* Return true if we can decide on ODR equivalency.
455 In non-LTO it is always decide, in LTO however it depends in the type has
456 ODR info attached. */
458 bool
459 types_odr_comparable (tree t1, tree t2)
461 return (!in_lto_p
462 || main_odr_variant (t1) == main_odr_variant (t2)
463 || (odr_type_p (t1) && odr_type_p (t2))
464 || (TREE_CODE (t1) == RECORD_TYPE && TREE_CODE (t2) == RECORD_TYPE
465 && TYPE_BINFO (t1) && TYPE_BINFO (t2)
466 && polymorphic_type_binfo_p (TYPE_BINFO (t1))
467 && polymorphic_type_binfo_p (TYPE_BINFO (t2))));
470 /* Return true if T1 and T2 are ODR equivalent. If ODR equivalency is not
471 known, be conservative and return false. */
473 bool
474 types_must_be_same_for_odr (tree t1, tree t2)
476 if (types_odr_comparable (t1, t2))
477 return types_same_for_odr (t1, t2);
478 else
479 return main_odr_variant (t1) == main_odr_variant (t2);
482 /* Compare types T1 and T2 and return true if they are
483 equivalent. */
485 inline bool
486 odr_hasher::equal (const value_type *t1, const compare_type *ct2)
488 tree t2 = const_cast <tree> (ct2);
490 gcc_checking_assert (main_odr_variant (t2) == t2);
491 if (t1->type == t2)
492 return true;
493 if (!in_lto_p)
494 return false;
495 return types_same_for_odr (t1->type, t2);
498 /* Free ODR type V. */
500 inline void
501 odr_hasher::remove (value_type *v)
503 v->bases.release ();
504 v->derived_types.release ();
505 if (v->types_set)
506 delete v->types_set;
507 ggc_free (v);
510 /* ODR type hash used to lookup ODR type based on tree type node. */
512 typedef hash_table<odr_hasher> odr_hash_type;
513 static odr_hash_type *odr_hash;
515 /* ODR types are also stored into ODR_TYPE vector to allow consistent
516 walking. Bases appear before derived types. Vector is garbage collected
517 so we won't end up visiting empty types. */
519 static GTY(()) vec <odr_type, va_gc> *odr_types_ptr;
520 #define odr_types (*odr_types_ptr)
522 /* Set TYPE_BINFO of TYPE and its variants to BINFO. */
523 void
524 set_type_binfo (tree type, tree binfo)
526 for (; type; type = TYPE_NEXT_VARIANT (type))
527 if (COMPLETE_TYPE_P (type))
528 TYPE_BINFO (type) = binfo;
529 else
530 gcc_assert (!TYPE_BINFO (type));
533 /* Compare T2 and T2 based on name or structure. */
535 static bool
536 odr_subtypes_equivalent_p (tree t1, tree t2, hash_set<type_pair,pair_traits> *visited)
538 bool an1, an2;
540 /* This can happen in incomplete types that should be handled earlier. */
541 gcc_assert (t1 && t2);
543 t1 = main_odr_variant (t1);
544 t2 = main_odr_variant (t2);
545 if (t1 == t2)
546 return true;
548 /* Anonymous namespace types must match exactly. */
549 an1 = type_in_anonymous_namespace_p (t1);
550 an2 = type_in_anonymous_namespace_p (t2);
551 if (an1 != an2 || an1)
552 return false;
554 /* For ODR types be sure to compare their names.
555 To support -wno-odr-type-merging we allow one type to be non-ODR
556 and other ODR even though it is a violation. */
557 if (types_odr_comparable (t1, t2))
559 if (!types_same_for_odr (t1, t2))
560 return false;
561 /* Limit recursion: If subtypes are ODR types and we know
562 that they are same, be happy. */
563 if (!get_odr_type (t1, true)->odr_violated)
564 return true;
567 /* Component types, builtins and possibly vioalting ODR types
568 have to be compared structurally. */
569 if (TREE_CODE (t1) != TREE_CODE (t2))
570 return false;
571 if ((TYPE_NAME (t1) == NULL_TREE) != (TYPE_NAME (t2) == NULL_TREE))
572 return false;
573 if (TYPE_NAME (t1) && DECL_NAME (TYPE_NAME (t1)) != DECL_NAME (TYPE_NAME (t2)))
574 return false;
576 type_pair pair={t1,t2};
577 if (TYPE_UID (t1) > TYPE_UID (t2))
579 pair.first = t2;
580 pair.second = t1;
582 if (visited->add (pair))
583 return true;
584 return odr_types_equivalent_p (t1, t2, false, NULL, visited);
587 /* Compare two virtual tables, PREVAILING and VTABLE and output ODR
588 violation warings. */
590 void
591 compare_virtual_tables (varpool_node *prevailing, varpool_node *vtable)
593 int n1, n2;
594 if (DECL_VIRTUAL_P (prevailing->decl) != DECL_VIRTUAL_P (vtable->decl))
596 odr_violation_reported = true;
597 if (DECL_VIRTUAL_P (prevailing->decl))
599 varpool_node *tmp = prevailing;
600 prevailing = vtable;
601 vtable = tmp;
603 if (warning_at (DECL_SOURCE_LOCATION (TYPE_NAME (DECL_CONTEXT (vtable->decl))),
604 OPT_Wodr,
605 "virtual table of type %qD violates one definition rule",
606 DECL_CONTEXT (vtable->decl)))
607 inform (DECL_SOURCE_LOCATION (prevailing->decl),
608 "variable of same assembler name as the virtual table is "
609 "defined in another translation unit");
610 return;
612 if (!prevailing->definition || !vtable->definition)
613 return;
614 for (n1 = 0, n2 = 0; true; n1++, n2++)
616 struct ipa_ref *ref1, *ref2;
617 bool end1, end2;
618 end1 = !prevailing->iterate_reference (n1, ref1);
619 end2 = !vtable->iterate_reference (n2, ref2);
620 if (end1 && end2)
621 return;
622 if (!end1 && !end2
623 && DECL_ASSEMBLER_NAME (ref1->referred->decl)
624 != DECL_ASSEMBLER_NAME (ref2->referred->decl)
625 && !n2
626 && !DECL_VIRTUAL_P (ref2->referred->decl)
627 && DECL_VIRTUAL_P (ref1->referred->decl))
629 if (warning_at (DECL_SOURCE_LOCATION (TYPE_NAME (DECL_CONTEXT (vtable->decl))), 0,
630 "virtual table of type %qD contains RTTI information",
631 DECL_CONTEXT (vtable->decl)))
633 inform (DECL_SOURCE_LOCATION (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
634 "but is prevailed by one without from other translation unit");
635 inform (DECL_SOURCE_LOCATION (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
636 "RTTI will not work on this type");
638 n2++;
639 end2 = !vtable->iterate_reference (n2, ref2);
641 if (!end1 && !end2
642 && DECL_ASSEMBLER_NAME (ref1->referred->decl)
643 != DECL_ASSEMBLER_NAME (ref2->referred->decl)
644 && !n1
645 && !DECL_VIRTUAL_P (ref1->referred->decl)
646 && DECL_VIRTUAL_P (ref2->referred->decl))
648 n1++;
649 end1 = !vtable->iterate_reference (n1, ref1);
651 if (end1 || end2)
653 if (end1)
655 varpool_node *tmp = prevailing;
656 prevailing = vtable;
657 vtable = tmp;
658 ref1 = ref2;
660 if (warning_at (DECL_SOURCE_LOCATION
661 (TYPE_NAME (DECL_CONTEXT (vtable->decl))), 0,
662 "virtual table of type %qD violates "
663 "one definition rule",
664 DECL_CONTEXT (vtable->decl)))
666 inform (DECL_SOURCE_LOCATION
667 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
668 "the conflicting type defined in another translation "
669 "unit");
670 inform (DECL_SOURCE_LOCATION
671 (TYPE_NAME (DECL_CONTEXT (ref1->referring->decl))),
672 "contains additional virtual method %qD",
673 ref1->referred->decl);
675 return;
677 if (DECL_ASSEMBLER_NAME (ref1->referred->decl)
678 != DECL_ASSEMBLER_NAME (ref2->referred->decl))
680 if (warning_at (DECL_SOURCE_LOCATION
681 (TYPE_NAME (DECL_CONTEXT (vtable->decl))), 0,
682 "virtual table of type %qD violates "
683 "one definition rule ",
684 DECL_CONTEXT (vtable->decl)))
686 inform (DECL_SOURCE_LOCATION
687 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
688 "the conflicting type defined in another translation "
689 "unit");
690 inform (DECL_SOURCE_LOCATION (ref1->referred->decl),
691 "virtual method %qD", ref1->referred->decl);
692 inform (DECL_SOURCE_LOCATION (ref2->referred->decl),
693 "ought to match virtual method %qD but does not",
694 ref2->referred->decl);
695 return;
701 /* Output ODR violation warning about T1 and T2 with REASON.
702 Display location of ST1 and ST2 if REASON speaks about field or
703 method of the type.
704 If WARN is false, do nothing. Set WARNED if warning was indeed
705 output. */
707 void
708 warn_odr (tree t1, tree t2, tree st1, tree st2,
709 bool warn, bool *warned, const char *reason)
711 tree decl2 = TYPE_NAME (t2);
713 if (!warn)
714 return;
715 if (!warning_at (DECL_SOURCE_LOCATION (TYPE_NAME (t1)), OPT_Wodr,
716 "type %qT violates one definition rule",
717 t1))
718 return;
719 if (!st1 && !st2)
721 /* For FIELD_DECL support also case where one of fields is
722 NULL - this is used when the structures have mismatching number of
723 elements. */
724 else if (!st1 || TREE_CODE (st1) == FIELD_DECL)
726 inform (DECL_SOURCE_LOCATION (decl2),
727 "a different type is defined in another translation unit");
728 if (!st1)
730 st1 = st2;
731 st2 = NULL;
733 inform (DECL_SOURCE_LOCATION (st1),
734 "the first difference of corresponding definitions is field %qD",
735 st1);
736 if (st2)
737 decl2 = st2;
739 else if (TREE_CODE (st1) == FUNCTION_DECL)
741 inform (DECL_SOURCE_LOCATION (decl2),
742 "a different type is defined in another translation unit");
743 inform (DECL_SOURCE_LOCATION (st1),
744 "the first difference of corresponding definitions is method %qD",
745 st1);
746 decl2 = st2;
748 else
749 return;
750 inform (DECL_SOURCE_LOCATION (decl2), reason);
752 if (warned)
753 *warned = true;
756 /* We already warned about ODR mismatch. T1 and T2 ought to be equivalent
757 because they are used on same place in ODR matching types.
758 They are not; inform the user. */
760 void
761 warn_types_mismatch (tree t1, tree t2)
763 if (!TYPE_NAME (t1) || !TYPE_NAME (t2))
764 return;
765 /* In Firefox it is a common bug to have same types but in
766 different namespaces. Be a bit more informative on
767 this. */
768 if (TYPE_CONTEXT (t1) && TYPE_CONTEXT (t2)
769 && (((TREE_CODE (TYPE_CONTEXT (t1)) == NAMESPACE_DECL)
770 != (TREE_CODE (TYPE_CONTEXT (t2)) == NAMESPACE_DECL))
771 || (TREE_CODE (TYPE_CONTEXT (t1)) == NAMESPACE_DECL
772 && (DECL_NAME (TYPE_CONTEXT (t1)) !=
773 DECL_NAME (TYPE_CONTEXT (t2))))))
774 inform (DECL_SOURCE_LOCATION (TYPE_NAME (t1)),
775 "type %qT should match type %qT but is defined "
776 "in different namespace ",
777 t1, t2);
778 else
779 inform (DECL_SOURCE_LOCATION (TYPE_NAME (t1)),
780 "type %qT should match type %qT",
781 t1, t2);
782 inform (DECL_SOURCE_LOCATION (TYPE_NAME (t2)),
783 "the incompatible type is defined here");
786 /* Compare T1 and T2, report ODR violations if WARN is true and set
787 WARNED to true if anything is reported. Return true if types match.
788 If true is returned, the types are also compatible in the sense of
789 gimple_canonical_types_compatible_p. */
791 static bool
792 odr_types_equivalent_p (tree t1, tree t2, bool warn, bool *warned, hash_set<type_pair,pair_traits> *visited)
794 /* Check first for the obvious case of pointer identity. */
795 if (t1 == t2)
796 return true;
797 gcc_assert (!type_in_anonymous_namespace_p (t1));
798 gcc_assert (!type_in_anonymous_namespace_p (t2));
800 /* Can't be the same type if the types don't have the same code. */
801 if (TREE_CODE (t1) != TREE_CODE (t2))
803 warn_odr (t1, t2, NULL, NULL, warn, warned,
804 G_("a different type is defined in another translation unit"));
805 return false;
808 if (TYPE_QUALS (t1) != TYPE_QUALS (t2))
810 warn_odr (t1, t2, NULL, NULL, warn, warned,
811 G_("a type with different qualifiers is defined in another "
812 "translation unit"));
813 return false;
816 if (comp_type_attributes (t1, t2) != 1)
818 warn_odr (t1, t2, NULL, NULL, warn, warned,
819 G_("a type with attributes "
820 "is defined in another translation unit"));
821 return false;
824 if (TREE_CODE (t1) == ENUMERAL_TYPE)
826 tree v1, v2;
827 for (v1 = TYPE_VALUES (t1), v2 = TYPE_VALUES (t2);
828 v1 && v2 ; v1 = TREE_CHAIN (v1), v2 = TREE_CHAIN (v2))
830 if (TREE_PURPOSE (v1) != TREE_PURPOSE (v2))
832 warn_odr (t1, t2, NULL, NULL, warn, warned,
833 G_("an enum with different value name"
834 " is defined in another translation unit"));
835 return false;
837 if (TREE_VALUE (v1) != TREE_VALUE (v2)
838 && !operand_equal_p (DECL_INITIAL (TREE_VALUE (v1)),
839 DECL_INITIAL (TREE_VALUE (v2)), 0))
841 warn_odr (t1, t2, NULL, NULL, warn, warned,
842 G_("an enum with different values is defined"
843 " in another translation unit"));
844 return false;
847 if (v1 || v2)
849 warn_odr (t1, t2, NULL, NULL, warn, warned,
850 G_("an enum with mismatching number of values "
851 "is defined in another translation unit"));
852 return false;
856 /* Non-aggregate types can be handled cheaply. */
857 if (INTEGRAL_TYPE_P (t1)
858 || SCALAR_FLOAT_TYPE_P (t1)
859 || FIXED_POINT_TYPE_P (t1)
860 || TREE_CODE (t1) == VECTOR_TYPE
861 || TREE_CODE (t1) == COMPLEX_TYPE
862 || TREE_CODE (t1) == OFFSET_TYPE
863 || POINTER_TYPE_P (t1))
865 if (TYPE_PRECISION (t1) != TYPE_PRECISION (t2))
867 warn_odr (t1, t2, NULL, NULL, warn, warned,
868 G_("a type with different precision is defined "
869 "in another translation unit"));
870 return false;
872 if (TYPE_UNSIGNED (t1) != TYPE_UNSIGNED (t2))
874 warn_odr (t1, t2, NULL, NULL, warn, warned,
875 G_("a type with different signedness is defined "
876 "in another translation unit"));
877 return false;
880 if (TREE_CODE (t1) == INTEGER_TYPE
881 && TYPE_STRING_FLAG (t1) != TYPE_STRING_FLAG (t2))
883 /* char WRT uint_8? */
884 warn_odr (t1, t2, NULL, NULL, warn, warned,
885 G_("a different type is defined in another "
886 "translation unit"));
887 return false;
890 /* For canonical type comparisons we do not want to build SCCs
891 so we cannot compare pointed-to types. But we can, for now,
892 require the same pointed-to type kind and match what
893 useless_type_conversion_p would do. */
894 if (POINTER_TYPE_P (t1))
896 if (TYPE_ADDR_SPACE (TREE_TYPE (t1))
897 != TYPE_ADDR_SPACE (TREE_TYPE (t2)))
899 warn_odr (t1, t2, NULL, NULL, warn, warned,
900 G_("it is defined as a pointer in different address "
901 "space in another translation unit"));
902 return false;
905 if (!odr_subtypes_equivalent_p (TREE_TYPE (t1), TREE_TYPE (t2), visited))
907 warn_odr (t1, t2, NULL, NULL, warn, warned,
908 G_("it is defined as a pointer to different type "
909 "in another translation unit"));
910 if (warn && warned)
911 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2));
912 return false;
916 if ((TREE_CODE (t1) == VECTOR_TYPE || TREE_CODE (t1) == COMPLEX_TYPE)
917 && !odr_subtypes_equivalent_p (TREE_TYPE (t1), TREE_TYPE (t2), visited))
919 /* Probably specific enough. */
920 warn_odr (t1, t2, NULL, NULL, warn, warned,
921 G_("a different type is defined "
922 "in another translation unit"));
923 if (warn && warned)
924 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2));
925 return false;
928 /* Do type-specific comparisons. */
929 else switch (TREE_CODE (t1))
931 case ARRAY_TYPE:
933 /* Array types are the same if the element types are the same and
934 the number of elements are the same. */
935 if (!odr_subtypes_equivalent_p (TREE_TYPE (t1), TREE_TYPE (t2), visited))
937 warn_odr (t1, t2, NULL, NULL, warn, warned,
938 G_("a different type is defined in another "
939 "translation unit"));
940 if (warn && warned)
941 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2));
943 gcc_assert (TYPE_STRING_FLAG (t1) == TYPE_STRING_FLAG (t2));
944 gcc_assert (TYPE_NONALIASED_COMPONENT (t1)
945 == TYPE_NONALIASED_COMPONENT (t2));
947 tree i1 = TYPE_DOMAIN (t1);
948 tree i2 = TYPE_DOMAIN (t2);
950 /* For an incomplete external array, the type domain can be
951 NULL_TREE. Check this condition also. */
952 if (i1 == NULL_TREE || i2 == NULL_TREE)
953 return true;
955 tree min1 = TYPE_MIN_VALUE (i1);
956 tree min2 = TYPE_MIN_VALUE (i2);
957 tree max1 = TYPE_MAX_VALUE (i1);
958 tree max2 = TYPE_MAX_VALUE (i2);
960 /* In C++, minimums should be always 0. */
961 gcc_assert (min1 == min2);
962 if (!operand_equal_p (max1, max2, 0))
964 warn_odr (t1, t2, NULL, NULL, warn, warned,
965 G_("an array of different size is defined "
966 "in another translation unit"));
967 return false;
970 break;
972 case METHOD_TYPE:
973 case FUNCTION_TYPE:
974 /* Function types are the same if the return type and arguments types
975 are the same. */
976 if (!odr_subtypes_equivalent_p (TREE_TYPE (t1), TREE_TYPE (t2), visited))
978 warn_odr (t1, t2, NULL, NULL, warn, warned,
979 G_("has different return value "
980 "in another translation unit"));
981 if (warn && warned)
982 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2));
983 return false;
986 if (TYPE_ARG_TYPES (t1) == TYPE_ARG_TYPES (t2))
987 return true;
988 else
990 tree parms1, parms2;
992 for (parms1 = TYPE_ARG_TYPES (t1), parms2 = TYPE_ARG_TYPES (t2);
993 parms1 && parms2;
994 parms1 = TREE_CHAIN (parms1), parms2 = TREE_CHAIN (parms2))
996 if (!odr_subtypes_equivalent_p
997 (TREE_VALUE (parms1), TREE_VALUE (parms2), visited))
999 warn_odr (t1, t2, NULL, NULL, warn, warned,
1000 G_("has different parameters in another "
1001 "translation unit"));
1002 if (warn && warned)
1003 warn_types_mismatch (TREE_VALUE (parms1),
1004 TREE_VALUE (parms2));
1005 return false;
1009 if (parms1 || parms2)
1011 warn_odr (t1, t2, NULL, NULL, warn, warned,
1012 G_("has different parameters "
1013 "in another translation unit"));
1014 return false;
1017 return true;
1020 case RECORD_TYPE:
1021 case UNION_TYPE:
1022 case QUAL_UNION_TYPE:
1024 tree f1, f2;
1026 /* For aggregate types, all the fields must be the same. */
1027 if (COMPLETE_TYPE_P (t1) && COMPLETE_TYPE_P (t2))
1029 for (f1 = TYPE_FIELDS (t1), f2 = TYPE_FIELDS (t2);
1030 f1 || f2;
1031 f1 = TREE_CHAIN (f1), f2 = TREE_CHAIN (f2))
1033 /* Skip non-fields. */
1034 while (f1 && TREE_CODE (f1) != FIELD_DECL)
1035 f1 = TREE_CHAIN (f1);
1036 while (f2 && TREE_CODE (f2) != FIELD_DECL)
1037 f2 = TREE_CHAIN (f2);
1038 if (!f1 || !f2)
1039 break;
1040 if (DECL_ARTIFICIAL (f1) != DECL_ARTIFICIAL (f2))
1041 break;
1042 if (DECL_NAME (f1) != DECL_NAME (f2)
1043 && !DECL_ARTIFICIAL (f1))
1045 warn_odr (t1, t2, f1, f2, warn, warned,
1046 G_("a field with different name is defined "
1047 "in another translation unit"));
1048 return false;
1050 if (!odr_subtypes_equivalent_p (TREE_TYPE (f1), TREE_TYPE (f2), visited))
1052 /* Do not warn about artificial fields and just go into generic
1053 field mismatch warning. */
1054 if (DECL_ARTIFICIAL (f1))
1055 break;
1057 warn_odr (t1, t2, f1, f2, warn, warned,
1058 G_("a field of same name but different type "
1059 "is defined in another translation unit"));
1060 if (warn && warned)
1061 warn_types_mismatch (TREE_TYPE (f1), TREE_TYPE (f2));
1062 return false;
1064 if (!gimple_compare_field_offset (f1, f2))
1066 /* Do not warn about artificial fields and just go into generic
1067 field mismatch warning. */
1068 if (DECL_ARTIFICIAL (f1))
1069 break;
1070 warn_odr (t1, t2, t1, t2, warn, warned,
1071 G_("fields has different layout "
1072 "in another translation unit"));
1073 return false;
1075 gcc_assert (DECL_NONADDRESSABLE_P (f1)
1076 == DECL_NONADDRESSABLE_P (f2));
1079 /* If one aggregate has more fields than the other, they
1080 are not the same. */
1081 if (f1 || f2)
1083 if (f1 && DECL_ARTIFICIAL (f1))
1084 f1 = NULL;
1085 if (f2 && DECL_ARTIFICIAL (f2))
1086 f2 = NULL;
1087 if (f1 || f2)
1088 warn_odr (t1, t2, f1, f2, warn, warned,
1089 G_("a type with different number of fields "
1090 "is defined in another translation unit"));
1091 /* Ideally we should never get this generic message. */
1092 else
1093 warn_odr (t1, t2, f1, f2, warn, warned,
1094 G_("a type with different memory representation "
1095 "is defined in another translation unit"));
1097 return false;
1099 if ((TYPE_MAIN_VARIANT (t1) == t1 || TYPE_MAIN_VARIANT (t2) == t2)
1100 && (TYPE_METHODS (TYPE_MAIN_VARIANT (t1))
1101 != TYPE_METHODS (TYPE_MAIN_VARIANT (t2))))
1103 for (f1 = TYPE_METHODS (TYPE_MAIN_VARIANT (t1)),
1104 f2 = TYPE_METHODS (TYPE_MAIN_VARIANT (t2));
1105 f1 && f2 ; f1 = DECL_CHAIN (f1), f2 = DECL_CHAIN (f2))
1107 if (DECL_ASSEMBLER_NAME (f1) != DECL_ASSEMBLER_NAME (f2))
1109 warn_odr (t1, t2, f1, f2, warn, warned,
1110 G_("a different method of same type "
1111 "is defined in another translation unit"));
1112 return false;
1114 if (DECL_VIRTUAL_P (f1) != DECL_VIRTUAL_P (f2))
1116 warn_odr (t1, t2, f1, f2, warn, warned,
1117 G_("s definition that differs by virtual "
1118 "keyword in another translation unit"));
1119 return false;
1121 if (DECL_VINDEX (f1) != DECL_VINDEX (f2))
1123 warn_odr (t1, t2, f1, f2, warn, warned,
1124 G_("virtual table layout differs in another "
1125 "translation unit"));
1126 return false;
1128 if (odr_subtypes_equivalent_p (TREE_TYPE (f1), TREE_TYPE (f2), visited))
1130 warn_odr (t1, t2, f1, f2, warn, warned,
1131 G_("method with incompatible type is defined "
1132 "in another translation unit"));
1133 return false;
1136 if (f1 || f2)
1138 warn_odr (t1, t2, NULL, NULL, warn, warned,
1139 G_("a type with different number of methods "
1140 "is defined in another translation unit"));
1141 return false;
1145 break;
1147 case VOID_TYPE:
1148 break;
1150 default:
1151 debug_tree (t1);
1152 gcc_unreachable ();
1155 /* Those are better to come last as they are utterly uninformative. */
1156 if (TYPE_SIZE (t1) && TYPE_SIZE (t2)
1157 && !operand_equal_p (TYPE_SIZE (t1), TYPE_SIZE (t2), 0))
1159 warn_odr (t1, t2, NULL, NULL, warn, warned,
1160 G_("a type with different size "
1161 "is defined in another translation unit"));
1162 return false;
1164 if (COMPLETE_TYPE_P (t1) && COMPLETE_TYPE_P (t2)
1165 && TYPE_ALIGN (t1) != TYPE_ALIGN (t2))
1167 warn_odr (t1, t2, NULL, NULL, warn, warned,
1168 G_("a type with different alignment "
1169 "is defined in another translation unit"));
1170 return false;
1172 gcc_assert (!TYPE_SIZE_UNIT (t1) || !TYPE_SIZE_UNIT (t2)
1173 || operand_equal_p (TYPE_SIZE_UNIT (t1),
1174 TYPE_SIZE_UNIT (t2), 0));
1175 return true;
1178 /* TYPE is equivalent to VAL by ODR, but its tree representation differs
1179 from VAL->type. This may happen in LTO where tree merging did not merge
1180 all variants of the same type. It may or may not mean the ODR violation.
1181 Add it to the list of duplicates and warn on some violations. */
1183 static bool
1184 add_type_duplicate (odr_type val, tree type)
1186 bool build_bases = false;
1187 if (!val->types_set)
1188 val->types_set = new hash_set<tree>;
1190 /* Always prefer complete type to be the leader. */
1191 if (!COMPLETE_TYPE_P (val->type)
1192 && COMPLETE_TYPE_P (type))
1194 tree tmp = type;
1196 build_bases = true;
1197 type = val->type;
1198 val->type = tmp;
1201 /* See if this duplicate is new. */
1202 if (!val->types_set->add (type))
1204 bool merge = true;
1205 bool base_mismatch = false;
1206 unsigned int i,j;
1207 bool warned = false;
1208 hash_set<type_pair,pair_traits> visited;
1210 gcc_assert (in_lto_p);
1211 vec_safe_push (val->types, type);
1213 /* First we compare memory layout. */
1214 if (!odr_types_equivalent_p (val->type, type, !flag_ltrans && !val->odr_violated,
1215 &warned, &visited))
1217 merge = false;
1218 odr_violation_reported = true;
1219 val->odr_violated = true;
1220 if (symtab->dump_file)
1222 fprintf (symtab->dump_file, "ODR violation\n");
1224 print_node (symtab->dump_file, "", val->type, 0);
1225 putc ('\n',symtab->dump_file);
1226 print_node (symtab->dump_file, "", type, 0);
1227 putc ('\n',symtab->dump_file);
1231 /* Next sanity check that bases are the same. If not, we will end
1232 up producing wrong answers. */
1233 if (COMPLETE_TYPE_P (type) && COMPLETE_TYPE_P (val->type)
1234 && TREE_CODE (val->type) == RECORD_TYPE
1235 && TREE_CODE (type) == RECORD_TYPE
1236 && TYPE_BINFO (val->type) && TYPE_BINFO (type))
1238 for (j = 0, i = 0; i < BINFO_N_BASE_BINFOS (TYPE_BINFO (type)); i++)
1239 if (polymorphic_type_binfo_p (BINFO_BASE_BINFO (TYPE_BINFO (type), i)))
1241 odr_type base = get_odr_type
1242 (BINFO_TYPE
1243 (BINFO_BASE_BINFO (TYPE_BINFO (type),
1244 i)),
1245 true);
1246 if (val->bases.length () <= j || val->bases[j] != base)
1247 base_mismatch = true;
1248 j++;
1250 if (base_mismatch)
1252 merge = false;
1253 odr_violation_reported = true;
1255 if (!warned && !val->odr_violated)
1256 warn_odr (type, val->type, NULL, NULL, !warned, &warned,
1257 "a type with the same name but different bases is "
1258 "defined in another translation unit");
1259 val->odr_violated = true;
1260 if (symtab->dump_file)
1262 fprintf (symtab->dump_file, "ODR bse violation or merging bug?\n");
1264 print_node (symtab->dump_file, "", val->type, 0);
1265 putc ('\n',symtab->dump_file);
1266 print_node (symtab->dump_file, "", type, 0);
1267 putc ('\n',symtab->dump_file);
1272 /* Regularize things a little. During LTO same types may come with
1273 different BINFOs. Either because their virtual table was
1274 not merged by tree merging and only later at decl merging or
1275 because one type comes with external vtable, while other
1276 with internal. We want to merge equivalent binfos to conserve
1277 memory and streaming overhead.
1279 The external vtables are more harmful: they contain references
1280 to external declarations of methods that may be defined in the
1281 merged LTO unit. For this reason we absolutely need to remove
1282 them and replace by internal variants. Not doing so will lead
1283 to incomplete answers from possible_polymorphic_call_targets.
1285 FIXME: disable for now; because ODR types are now build during
1286 streaming in, the variants do not need to be linked to the type,
1287 yet. We need to do the merging in cleanup pass to be implemented
1288 soon. */
1289 if (!flag_ltrans && merge
1290 && 0
1291 && TREE_CODE (val->type) == RECORD_TYPE
1292 && TREE_CODE (type) == RECORD_TYPE
1293 && TYPE_BINFO (val->type) && TYPE_BINFO (type)
1294 && TYPE_MAIN_VARIANT (type) == type
1295 && TYPE_MAIN_VARIANT (val->type) == val->type
1296 && BINFO_VTABLE (TYPE_BINFO (val->type))
1297 && BINFO_VTABLE (TYPE_BINFO (type)))
1299 tree master_binfo = TYPE_BINFO (val->type);
1300 tree v1 = BINFO_VTABLE (master_binfo);
1301 tree v2 = BINFO_VTABLE (TYPE_BINFO (type));
1303 if (TREE_CODE (v1) == POINTER_PLUS_EXPR)
1305 gcc_assert (TREE_CODE (v2) == POINTER_PLUS_EXPR
1306 && operand_equal_p (TREE_OPERAND (v1, 1),
1307 TREE_OPERAND (v2, 1), 0));
1308 v1 = TREE_OPERAND (TREE_OPERAND (v1, 0), 0);
1309 v2 = TREE_OPERAND (TREE_OPERAND (v2, 0), 0);
1311 gcc_assert (DECL_ASSEMBLER_NAME (v1)
1312 == DECL_ASSEMBLER_NAME (v2));
1314 if (DECL_EXTERNAL (v1) && !DECL_EXTERNAL (v2))
1316 unsigned int i;
1318 set_type_binfo (val->type, TYPE_BINFO (type));
1319 for (i = 0; i < val->types->length (); i++)
1321 if (TYPE_BINFO ((*val->types)[i])
1322 == master_binfo)
1323 set_type_binfo ((*val->types)[i], TYPE_BINFO (type));
1325 BINFO_TYPE (TYPE_BINFO (type)) = val->type;
1327 else
1328 set_type_binfo (type, master_binfo);
1331 return build_bases;
1334 /* Get ODR type hash entry for TYPE. If INSERT is true, create
1335 possibly new entry. */
1337 odr_type
1338 get_odr_type (tree type, bool insert)
1340 odr_type_d **slot;
1341 odr_type val;
1342 hashval_t hash;
1343 bool build_bases = false;
1344 bool insert_to_odr_array = false;
1345 int base_id = -1;
1347 type = main_odr_variant (type);
1349 hash = hash_type_name (type);
1350 slot = odr_hash->find_slot_with_hash (type, hash,
1351 insert ? INSERT : NO_INSERT);
1352 if (!slot)
1353 return NULL;
1355 /* See if we already have entry for type. */
1356 if (*slot)
1358 val = *slot;
1360 /* With LTO we need to support multiple tree representation of
1361 the same ODR type. */
1362 if (val->type != type)
1363 build_bases = add_type_duplicate (val, type);
1365 else
1367 val = ggc_cleared_alloc<odr_type_d> ();
1368 val->type = type;
1369 val->bases = vNULL;
1370 val->derived_types = vNULL;
1371 val->anonymous_namespace = type_in_anonymous_namespace_p (type);
1372 build_bases = COMPLETE_TYPE_P (val->type);
1373 insert_to_odr_array = true;
1376 if (build_bases && TREE_CODE (type) == RECORD_TYPE && TYPE_BINFO (type)
1377 && type == TYPE_MAIN_VARIANT (type))
1379 tree binfo = TYPE_BINFO (type);
1380 unsigned int i;
1382 gcc_assert (BINFO_TYPE (TYPE_BINFO (val->type)) = type);
1384 val->all_derivations_known = type_all_derivations_known_p (type);
1385 *slot = val;
1386 for (i = 0; i < BINFO_N_BASE_BINFOS (binfo); i++)
1387 /* For now record only polymorphic types. other are
1388 pointless for devirtualization and we can not precisely
1389 determine ODR equivalency of these during LTO. */
1390 if (polymorphic_type_binfo_p (BINFO_BASE_BINFO (binfo, i)))
1392 odr_type base = get_odr_type (BINFO_TYPE (BINFO_BASE_BINFO (binfo,
1393 i)),
1394 true);
1395 gcc_assert (TYPE_MAIN_VARIANT (base->type) == base->type);
1396 base->derived_types.safe_push (val);
1397 val->bases.safe_push (base);
1398 if (base->id > base_id)
1399 base_id = base->id;
1402 /* Ensure that type always appears after bases. */
1403 if (insert_to_odr_array)
1405 if (odr_types_ptr)
1406 val->id = odr_types.length ();
1407 vec_safe_push (odr_types_ptr, val);
1409 else if (base_id > val->id)
1411 odr_types[val->id] = 0;
1412 /* Be sure we did not recorded any derived types; these may need
1413 renumbering too. */
1414 gcc_assert (val->derived_types.length() == 0);
1415 if (odr_types_ptr)
1416 val->id = odr_types.length ();
1417 vec_safe_push (odr_types_ptr, val);
1419 return val;
1422 /* Add TYPE od ODR type hash. */
1424 void
1425 register_odr_type (tree type)
1427 if (!odr_hash)
1428 odr_hash = new odr_hash_type (23);
1429 /* Arrange things to be nicer and insert main variants first. */
1430 if (odr_type_p (TYPE_MAIN_VARIANT (type)))
1431 get_odr_type (TYPE_MAIN_VARIANT (type), true);
1432 if (TYPE_MAIN_VARIANT (type) != type)
1433 get_odr_type (type, true);
1436 /* Return true if type is known to have no derivations. */
1438 bool
1439 type_known_to_have_no_deriavations_p (tree t)
1441 return (type_all_derivations_known_p (t)
1442 && (TYPE_FINAL_P (t)
1443 || (odr_hash
1444 && !get_odr_type (t, true)->derived_types.length())));
1447 /* Dump ODR type T and all its derrived type. INDENT specify indentation for
1448 recusive printing. */
1450 static void
1451 dump_odr_type (FILE *f, odr_type t, int indent=0)
1453 unsigned int i;
1454 fprintf (f, "%*s type %i: ", indent * 2, "", t->id);
1455 print_generic_expr (f, t->type, TDF_SLIM);
1456 fprintf (f, "%s", t->anonymous_namespace ? " (anonymous namespace)":"");
1457 fprintf (f, "%s\n", t->all_derivations_known ? " (derivations known)":"");
1458 if (TYPE_NAME (t->type))
1460 fprintf (f, "%*s defined at: %s:%i\n", indent * 2, "",
1461 DECL_SOURCE_FILE (TYPE_NAME (t->type)),
1462 DECL_SOURCE_LINE (TYPE_NAME (t->type)));
1464 if (t->bases.length ())
1466 fprintf (f, "%*s base odr type ids: ", indent * 2, "");
1467 for (i = 0; i < t->bases.length (); i++)
1468 fprintf (f, " %i", t->bases[i]->id);
1469 fprintf (f, "\n");
1471 if (t->derived_types.length ())
1473 fprintf (f, "%*s derived types:\n", indent * 2, "");
1474 for (i = 0; i < t->derived_types.length (); i++)
1475 dump_odr_type (f, t->derived_types[i], indent + 1);
1477 fprintf (f, "\n");
1480 /* Dump the type inheritance graph. */
1482 static void
1483 dump_type_inheritance_graph (FILE *f)
1485 unsigned int i;
1486 if (!odr_types_ptr)
1487 return;
1488 fprintf (f, "\n\nType inheritance graph:\n");
1489 for (i = 0; i < odr_types.length (); i++)
1491 if (odr_types[i] && odr_types[i]->bases.length () == 0)
1492 dump_odr_type (f, odr_types[i]);
1494 for (i = 0; i < odr_types.length (); i++)
1496 if (odr_types[i] && odr_types[i]->types && odr_types[i]->types->length ())
1498 unsigned int j;
1499 fprintf (f, "Duplicate tree types for odr type %i\n", i);
1500 print_node (f, "", odr_types[i]->type, 0);
1501 for (j = 0; j < odr_types[i]->types->length (); j++)
1503 tree t;
1504 fprintf (f, "duplicate #%i\n", j);
1505 print_node (f, "", (*odr_types[i]->types)[j], 0);
1506 t = (*odr_types[i]->types)[j];
1507 while (TYPE_P (t) && TYPE_CONTEXT (t))
1509 t = TYPE_CONTEXT (t);
1510 print_node (f, "", t, 0);
1512 putc ('\n',f);
1518 /* Given method type T, return type of class it belongs to.
1519 Lookup this pointer and get its type. */
1521 tree
1522 method_class_type (const_tree t)
1524 tree first_parm_type = TREE_VALUE (TYPE_ARG_TYPES (t));
1525 gcc_assert (TREE_CODE (t) == METHOD_TYPE);
1527 return TREE_TYPE (first_parm_type);
1530 /* Initialize IPA devirt and build inheritance tree graph. */
1532 void
1533 build_type_inheritance_graph (void)
1535 struct symtab_node *n;
1536 FILE *inheritance_dump_file;
1537 int flags;
1539 if (odr_hash)
1540 return;
1541 timevar_push (TV_IPA_INHERITANCE);
1542 inheritance_dump_file = dump_begin (TDI_inheritance, &flags);
1543 odr_hash = new odr_hash_type (23);
1545 /* We reconstruct the graph starting of types of all methods seen in the
1546 the unit. */
1547 FOR_EACH_SYMBOL (n)
1548 if (is_a <cgraph_node *> (n)
1549 && DECL_VIRTUAL_P (n->decl)
1550 && n->real_symbol_p ())
1551 get_odr_type (TYPE_MAIN_VARIANT (method_class_type (TREE_TYPE (n->decl))),
1552 true);
1554 /* Look also for virtual tables of types that do not define any methods.
1556 We need it in a case where class B has virtual base of class A
1557 re-defining its virtual method and there is class C with no virtual
1558 methods with B as virtual base.
1560 Here we output B's virtual method in two variant - for non-virtual
1561 and virtual inheritance. B's virtual table has non-virtual version,
1562 while C's has virtual.
1564 For this reason we need to know about C in order to include both
1565 variants of B. More correctly, record_target_from_binfo should
1566 add both variants of the method when walking B, but we have no
1567 link in between them.
1569 We rely on fact that either the method is exported and thus we
1570 assume it is called externally or C is in anonymous namespace and
1571 thus we will see the vtable. */
1573 else if (is_a <varpool_node *> (n)
1574 && DECL_VIRTUAL_P (n->decl)
1575 && TREE_CODE (DECL_CONTEXT (n->decl)) == RECORD_TYPE
1576 && TYPE_BINFO (DECL_CONTEXT (n->decl))
1577 && polymorphic_type_binfo_p (TYPE_BINFO (DECL_CONTEXT (n->decl))))
1578 get_odr_type (TYPE_MAIN_VARIANT (DECL_CONTEXT (n->decl)), true);
1579 if (inheritance_dump_file)
1581 dump_type_inheritance_graph (inheritance_dump_file);
1582 dump_end (TDI_inheritance, inheritance_dump_file);
1584 timevar_pop (TV_IPA_INHERITANCE);
1587 /* Return true if N has reference from live virtual table
1588 (and thus can be a destination of polymorphic call).
1589 Be conservatively correct when callgraph is not built or
1590 if the method may be referred externally. */
1592 static bool
1593 referenced_from_vtable_p (struct cgraph_node *node)
1595 int i;
1596 struct ipa_ref *ref;
1597 bool found = false;
1599 if (node->externally_visible
1600 || DECL_EXTERNAL (node->decl)
1601 || node->used_from_other_partition)
1602 return true;
1604 /* Keep this test constant time.
1605 It is unlikely this can happen except for the case where speculative
1606 devirtualization introduced many speculative edges to this node.
1607 In this case the target is very likely alive anyway. */
1608 if (node->ref_list.referring.length () > 100)
1609 return true;
1611 /* We need references built. */
1612 if (symtab->state <= CONSTRUCTION)
1613 return true;
1615 for (i = 0; node->iterate_referring (i, ref); i++)
1617 if ((ref->use == IPA_REF_ALIAS
1618 && referenced_from_vtable_p (dyn_cast<cgraph_node *> (ref->referring)))
1619 || (ref->use == IPA_REF_ADDR
1620 && TREE_CODE (ref->referring->decl) == VAR_DECL
1621 && DECL_VIRTUAL_P (ref->referring->decl)))
1623 found = true;
1624 break;
1626 return found;
1629 /* If TARGET has associated node, record it in the NODES array.
1630 CAN_REFER specify if program can refer to the target directly.
1631 if TARGET is unknown (NULL) or it can not be inserted (for example because
1632 its body was already removed and there is no way to refer to it), clear
1633 COMPLETEP. */
1635 static void
1636 maybe_record_node (vec <cgraph_node *> &nodes,
1637 tree target, hash_set<tree> *inserted,
1638 bool can_refer,
1639 bool *completep)
1641 struct cgraph_node *target_node, *alias_target;
1642 enum availability avail;
1644 /* cxa_pure_virtual and __builtin_unreachable do not need to be added into
1645 list of targets; the runtime effect of calling them is undefined.
1646 Only "real" virtual methods should be accounted. */
1647 if (target && TREE_CODE (TREE_TYPE (target)) != METHOD_TYPE)
1648 return;
1650 if (!can_refer)
1652 /* The only case when method of anonymous namespace becomes unreferable
1653 is when we completely optimized it out. */
1654 if (flag_ltrans
1655 || !target
1656 || !type_in_anonymous_namespace_p (DECL_CONTEXT (target)))
1657 *completep = false;
1658 return;
1661 if (!target)
1662 return;
1664 target_node = cgraph_node::get (target);
1666 /* Preffer alias target over aliases, so we do not get confused by
1667 fake duplicates. */
1668 if (target_node)
1670 alias_target = target_node->ultimate_alias_target (&avail);
1671 if (target_node != alias_target
1672 && avail >= AVAIL_AVAILABLE
1673 && target_node->get_availability ())
1674 target_node = alias_target;
1677 /* Method can only be called by polymorphic call if any
1678 of vtables refering to it are alive.
1680 While this holds for non-anonymous functions, too, there are
1681 cases where we want to keep them in the list; for example
1682 inline functions with -fno-weak are static, but we still
1683 may devirtualize them when instance comes from other unit.
1684 The same holds for LTO.
1686 Currently we ignore these functions in speculative devirtualization.
1687 ??? Maybe it would make sense to be more aggressive for LTO even
1688 eslewhere. */
1689 if (!flag_ltrans
1690 && type_in_anonymous_namespace_p (DECL_CONTEXT (target))
1691 && (!target_node
1692 || !referenced_from_vtable_p (target_node)))
1694 /* See if TARGET is useful function we can deal with. */
1695 else if (target_node != NULL
1696 && (TREE_PUBLIC (target)
1697 || DECL_EXTERNAL (target)
1698 || target_node->definition)
1699 && target_node->real_symbol_p ())
1701 gcc_assert (!target_node->global.inlined_to);
1702 gcc_assert (target_node->real_symbol_p ());
1703 if (!inserted->add (target))
1705 cached_polymorphic_call_targets->add (target_node);
1706 nodes.safe_push (target_node);
1709 else if (completep
1710 && (!type_in_anonymous_namespace_p
1711 (DECL_CONTEXT (target))
1712 || flag_ltrans))
1713 *completep = false;
1716 /* See if BINFO's type match OUTER_TYPE. If so, lookup
1717 BINFO of subtype of OTR_TYPE at OFFSET and in that BINFO find
1718 method in vtable and insert method to NODES array
1719 or BASES_TO_CONSIDER if this array is non-NULL.
1720 Otherwise recurse to base BINFOs.
1721 This match what get_binfo_at_offset does, but with offset
1722 being unknown.
1724 TYPE_BINFOS is a stack of BINFOS of types with defined
1725 virtual table seen on way from class type to BINFO.
1727 MATCHED_VTABLES tracks virtual tables we already did lookup
1728 for virtual function in. INSERTED tracks nodes we already
1729 inserted.
1731 ANONYMOUS is true if BINFO is part of anonymous namespace.
1733 Clear COMPLETEP when we hit unreferable target.
1736 static void
1737 record_target_from_binfo (vec <cgraph_node *> &nodes,
1738 vec <tree> *bases_to_consider,
1739 tree binfo,
1740 tree otr_type,
1741 vec <tree> &type_binfos,
1742 HOST_WIDE_INT otr_token,
1743 tree outer_type,
1744 HOST_WIDE_INT offset,
1745 hash_set<tree> *inserted,
1746 hash_set<tree> *matched_vtables,
1747 bool anonymous,
1748 bool *completep)
1750 tree type = BINFO_TYPE (binfo);
1751 int i;
1752 tree base_binfo;
1755 if (BINFO_VTABLE (binfo))
1756 type_binfos.safe_push (binfo);
1757 if (types_same_for_odr (type, outer_type))
1759 int i;
1760 tree type_binfo = NULL;
1762 /* Lookup BINFO with virtual table. For normal types it is always last
1763 binfo on stack. */
1764 for (i = type_binfos.length () - 1; i >= 0; i--)
1765 if (BINFO_OFFSET (type_binfos[i]) == BINFO_OFFSET (binfo))
1767 type_binfo = type_binfos[i];
1768 break;
1770 if (BINFO_VTABLE (binfo))
1771 type_binfos.pop ();
1772 /* If this is duplicated BINFO for base shared by virtual inheritance,
1773 we may not have its associated vtable. This is not a problem, since
1774 we will walk it on the other path. */
1775 if (!type_binfo)
1776 return;
1777 tree inner_binfo = get_binfo_at_offset (type_binfo,
1778 offset, otr_type);
1779 if (!inner_binfo)
1781 gcc_assert (odr_violation_reported);
1782 return;
1784 /* For types in anonymous namespace first check if the respective vtable
1785 is alive. If not, we know the type can't be called. */
1786 if (!flag_ltrans && anonymous)
1788 tree vtable = BINFO_VTABLE (inner_binfo);
1789 varpool_node *vnode;
1791 if (TREE_CODE (vtable) == POINTER_PLUS_EXPR)
1792 vtable = TREE_OPERAND (TREE_OPERAND (vtable, 0), 0);
1793 vnode = varpool_node::get (vtable);
1794 if (!vnode || !vnode->definition)
1795 return;
1797 gcc_assert (inner_binfo);
1798 if (bases_to_consider
1799 ? !matched_vtables->contains (BINFO_VTABLE (inner_binfo))
1800 : !matched_vtables->add (BINFO_VTABLE (inner_binfo)))
1802 bool can_refer;
1803 tree target = gimple_get_virt_method_for_binfo (otr_token,
1804 inner_binfo,
1805 &can_refer);
1806 if (!bases_to_consider)
1807 maybe_record_node (nodes, target, inserted, can_refer, completep);
1808 /* Destructors are never called via construction vtables. */
1809 else if (!target || !DECL_CXX_DESTRUCTOR_P (target))
1810 bases_to_consider->safe_push (target);
1812 return;
1815 /* Walk bases. */
1816 for (i = 0; BINFO_BASE_ITERATE (binfo, i, base_binfo); i++)
1817 /* Walking bases that have no virtual method is pointless excercise. */
1818 if (polymorphic_type_binfo_p (base_binfo))
1819 record_target_from_binfo (nodes, bases_to_consider, base_binfo, otr_type,
1820 type_binfos,
1821 otr_token, outer_type, offset, inserted,
1822 matched_vtables, anonymous, completep);
1823 if (BINFO_VTABLE (binfo))
1824 type_binfos.pop ();
1827 /* Lookup virtual methods matching OTR_TYPE (with OFFSET and OTR_TOKEN)
1828 of TYPE, insert them to NODES, recurse into derived nodes.
1829 INSERTED is used to avoid duplicate insertions of methods into NODES.
1830 MATCHED_VTABLES are used to avoid duplicate walking vtables.
1831 Clear COMPLETEP if unreferable target is found.
1833 If CONSIDER_CONSTURCTION is true, record to BASES_TO_CONSDIER
1834 all cases where BASE_SKIPPED is true (because the base is abstract
1835 class). */
1837 static void
1838 possible_polymorphic_call_targets_1 (vec <cgraph_node *> &nodes,
1839 hash_set<tree> *inserted,
1840 hash_set<tree> *matched_vtables,
1841 tree otr_type,
1842 odr_type type,
1843 HOST_WIDE_INT otr_token,
1844 tree outer_type,
1845 HOST_WIDE_INT offset,
1846 bool *completep,
1847 vec <tree> &bases_to_consider,
1848 bool consider_construction)
1850 tree binfo = TYPE_BINFO (type->type);
1851 unsigned int i;
1852 auto_vec <tree, 8> type_binfos;
1853 bool possibly_instantiated = type_possibly_instantiated_p (type->type);
1855 /* We may need to consider types w/o instances because of possible derived
1856 types using their methods either directly or via construction vtables.
1857 We are safe to skip them when all derivations are known, since we will
1858 handle them later.
1859 This is done by recording them to BASES_TO_CONSIDER array. */
1860 if (possibly_instantiated || consider_construction)
1862 record_target_from_binfo (nodes,
1863 (!possibly_instantiated
1864 && type_all_derivations_known_p (type->type))
1865 ? &bases_to_consider : NULL,
1866 binfo, otr_type, type_binfos, otr_token,
1867 outer_type, offset,
1868 inserted, matched_vtables,
1869 type->anonymous_namespace, completep);
1871 for (i = 0; i < type->derived_types.length (); i++)
1872 possible_polymorphic_call_targets_1 (nodes, inserted,
1873 matched_vtables,
1874 otr_type,
1875 type->derived_types[i],
1876 otr_token, outer_type, offset, completep,
1877 bases_to_consider, consider_construction);
1880 /* Cache of queries for polymorphic call targets.
1882 Enumerating all call targets may get expensive when there are many
1883 polymorphic calls in the program, so we memoize all the previous
1884 queries and avoid duplicated work. */
1886 struct polymorphic_call_target_d
1888 HOST_WIDE_INT otr_token;
1889 ipa_polymorphic_call_context context;
1890 odr_type type;
1891 vec <cgraph_node *> targets;
1892 tree decl_warning;
1893 int type_warning;
1894 bool complete;
1895 bool speculative;
1898 /* Polymorphic call target cache helpers. */
1900 struct polymorphic_call_target_hasher
1902 typedef polymorphic_call_target_d value_type;
1903 typedef polymorphic_call_target_d compare_type;
1904 static inline hashval_t hash (const value_type *);
1905 static inline bool equal (const value_type *, const compare_type *);
1906 static inline void remove (value_type *);
1909 /* Return the computed hashcode for ODR_QUERY. */
1911 inline hashval_t
1912 polymorphic_call_target_hasher::hash (const value_type *odr_query)
1914 inchash::hash hstate (odr_query->otr_token);
1916 hstate.add_wide_int (odr_query->type->id);
1917 hstate.merge_hash (TYPE_UID (odr_query->context.outer_type));
1918 hstate.add_wide_int (odr_query->context.offset);
1920 if (odr_query->context.speculative_outer_type)
1922 hstate.merge_hash (TYPE_UID (odr_query->context.speculative_outer_type));
1923 hstate.add_wide_int (odr_query->context.speculative_offset);
1925 hstate.add_flag (odr_query->speculative);
1926 hstate.add_flag (odr_query->context.maybe_in_construction);
1927 hstate.add_flag (odr_query->context.maybe_derived_type);
1928 hstate.add_flag (odr_query->context.speculative_maybe_derived_type);
1929 hstate.commit_flag ();
1930 return hstate.end ();
1933 /* Compare cache entries T1 and T2. */
1935 inline bool
1936 polymorphic_call_target_hasher::equal (const value_type *t1,
1937 const compare_type *t2)
1939 return (t1->type == t2->type && t1->otr_token == t2->otr_token
1940 && t1->speculative == t2->speculative
1941 && t1->context.offset == t2->context.offset
1942 && t1->context.speculative_offset == t2->context.speculative_offset
1943 && t1->context.outer_type == t2->context.outer_type
1944 && t1->context.speculative_outer_type == t2->context.speculative_outer_type
1945 && t1->context.maybe_in_construction
1946 == t2->context.maybe_in_construction
1947 && t1->context.maybe_derived_type == t2->context.maybe_derived_type
1948 && (t1->context.speculative_maybe_derived_type
1949 == t2->context.speculative_maybe_derived_type));
1952 /* Remove entry in polymorphic call target cache hash. */
1954 inline void
1955 polymorphic_call_target_hasher::remove (value_type *v)
1957 v->targets.release ();
1958 free (v);
1961 /* Polymorphic call target query cache. */
1963 typedef hash_table<polymorphic_call_target_hasher>
1964 polymorphic_call_target_hash_type;
1965 static polymorphic_call_target_hash_type *polymorphic_call_target_hash;
1967 /* Destroy polymorphic call target query cache. */
1969 static void
1970 free_polymorphic_call_targets_hash ()
1972 if (cached_polymorphic_call_targets)
1974 delete polymorphic_call_target_hash;
1975 polymorphic_call_target_hash = NULL;
1976 delete cached_polymorphic_call_targets;
1977 cached_polymorphic_call_targets = NULL;
1981 /* When virtual function is removed, we may need to flush the cache. */
1983 static void
1984 devirt_node_removal_hook (struct cgraph_node *n, void *d ATTRIBUTE_UNUSED)
1986 if (cached_polymorphic_call_targets
1987 && cached_polymorphic_call_targets->contains (n))
1988 free_polymorphic_call_targets_hash ();
1991 /* Lookup base of BINFO that has virtual table VTABLE with OFFSET. */
1993 tree
1994 subbinfo_with_vtable_at_offset (tree binfo, unsigned HOST_WIDE_INT offset,
1995 tree vtable)
1997 tree v = BINFO_VTABLE (binfo);
1998 int i;
1999 tree base_binfo;
2000 unsigned HOST_WIDE_INT this_offset;
2002 if (v)
2004 if (!vtable_pointer_value_to_vtable (v, &v, &this_offset))
2005 gcc_unreachable ();
2007 if (offset == this_offset
2008 && DECL_ASSEMBLER_NAME (v) == DECL_ASSEMBLER_NAME (vtable))
2009 return binfo;
2012 for (i = 0; BINFO_BASE_ITERATE (binfo, i, base_binfo); i++)
2013 if (polymorphic_type_binfo_p (base_binfo))
2015 base_binfo = subbinfo_with_vtable_at_offset (base_binfo, offset, vtable);
2016 if (base_binfo)
2017 return base_binfo;
2019 return NULL;
2022 /* T is known constant value of virtual table pointer.
2023 Store virtual table to V and its offset to OFFSET.
2024 Return false if T does not look like virtual table reference. */
2026 bool
2027 vtable_pointer_value_to_vtable (const_tree t, tree *v,
2028 unsigned HOST_WIDE_INT *offset)
2030 /* We expect &MEM[(void *)&virtual_table + 16B].
2031 We obtain object's BINFO from the context of the virtual table.
2032 This one contains pointer to virtual table represented via
2033 POINTER_PLUS_EXPR. Verify that this pointer match to what
2034 we propagated through.
2036 In the case of virtual inheritance, the virtual tables may
2037 be nested, i.e. the offset may be different from 16 and we may
2038 need to dive into the type representation. */
2039 if (TREE_CODE (t) == ADDR_EXPR
2040 && TREE_CODE (TREE_OPERAND (t, 0)) == MEM_REF
2041 && TREE_CODE (TREE_OPERAND (TREE_OPERAND (t, 0), 0)) == ADDR_EXPR
2042 && TREE_CODE (TREE_OPERAND (TREE_OPERAND (t, 0), 1)) == INTEGER_CST
2043 && (TREE_CODE (TREE_OPERAND (TREE_OPERAND (TREE_OPERAND (t, 0), 0), 0))
2044 == VAR_DECL)
2045 && DECL_VIRTUAL_P (TREE_OPERAND (TREE_OPERAND
2046 (TREE_OPERAND (t, 0), 0), 0)))
2048 *v = TREE_OPERAND (TREE_OPERAND (TREE_OPERAND (t, 0), 0), 0);
2049 *offset = tree_to_uhwi (TREE_OPERAND (TREE_OPERAND (t, 0), 1));
2050 return true;
2053 /* Alternative representation, used by C++ frontend is POINTER_PLUS_EXPR.
2054 We need to handle it when T comes from static variable initializer or
2055 BINFO. */
2056 if (TREE_CODE (t) == POINTER_PLUS_EXPR)
2058 *offset = tree_to_uhwi (TREE_OPERAND (t, 1));
2059 t = TREE_OPERAND (t, 0);
2061 else
2062 *offset = 0;
2064 if (TREE_CODE (t) != ADDR_EXPR)
2065 return false;
2066 *v = TREE_OPERAND (t, 0);
2067 return true;
2070 /* T is known constant value of virtual table pointer. Return BINFO of the
2071 instance type. */
2073 tree
2074 vtable_pointer_value_to_binfo (const_tree t)
2076 tree vtable;
2077 unsigned HOST_WIDE_INT offset;
2079 if (!vtable_pointer_value_to_vtable (t, &vtable, &offset))
2080 return NULL_TREE;
2082 /* FIXME: for stores of construction vtables we return NULL,
2083 because we do not have BINFO for those. Eventually we should fix
2084 our representation to allow this case to be handled, too.
2085 In the case we see store of BINFO we however may assume
2086 that standard folding will be ale to cope with it. */
2087 return subbinfo_with_vtable_at_offset (TYPE_BINFO (DECL_CONTEXT (vtable)),
2088 offset, vtable);
2091 /* Walk bases of OUTER_TYPE that contain OTR_TYPE at OFFSET.
2092 Lookup their respecitve virtual methods for OTR_TOKEN and OTR_TYPE
2093 and insert them to NODES.
2095 MATCHED_VTABLES and INSERTED is used to avoid duplicated work. */
2097 static void
2098 record_targets_from_bases (tree otr_type,
2099 HOST_WIDE_INT otr_token,
2100 tree outer_type,
2101 HOST_WIDE_INT offset,
2102 vec <cgraph_node *> &nodes,
2103 hash_set<tree> *inserted,
2104 hash_set<tree> *matched_vtables,
2105 bool *completep)
2107 while (true)
2109 HOST_WIDE_INT pos, size;
2110 tree base_binfo;
2111 tree fld;
2113 if (types_same_for_odr (outer_type, otr_type))
2114 return;
2116 for (fld = TYPE_FIELDS (outer_type); fld; fld = DECL_CHAIN (fld))
2118 if (TREE_CODE (fld) != FIELD_DECL)
2119 continue;
2121 pos = int_bit_position (fld);
2122 size = tree_to_shwi (DECL_SIZE (fld));
2123 if (pos <= offset && (pos + size) > offset
2124 /* Do not get confused by zero sized bases. */
2125 && polymorphic_type_binfo_p (TYPE_BINFO (TREE_TYPE (fld))))
2126 break;
2128 /* Within a class type we should always find correcponding fields. */
2129 gcc_assert (fld && TREE_CODE (TREE_TYPE (fld)) == RECORD_TYPE);
2131 /* Nonbasetypes should have been stripped by outer_class_type. */
2132 gcc_assert (DECL_ARTIFICIAL (fld));
2134 outer_type = TREE_TYPE (fld);
2135 offset -= pos;
2137 base_binfo = get_binfo_at_offset (TYPE_BINFO (outer_type),
2138 offset, otr_type);
2139 if (!base_binfo)
2141 gcc_assert (odr_violation_reported);
2142 return;
2144 gcc_assert (base_binfo);
2145 if (!matched_vtables->add (BINFO_VTABLE (base_binfo)))
2147 bool can_refer;
2148 tree target = gimple_get_virt_method_for_binfo (otr_token,
2149 base_binfo,
2150 &can_refer);
2151 if (!target || ! DECL_CXX_DESTRUCTOR_P (target))
2152 maybe_record_node (nodes, target, inserted, can_refer, completep);
2153 matched_vtables->add (BINFO_VTABLE (base_binfo));
2158 /* When virtual table is removed, we may need to flush the cache. */
2160 static void
2161 devirt_variable_node_removal_hook (varpool_node *n,
2162 void *d ATTRIBUTE_UNUSED)
2164 if (cached_polymorphic_call_targets
2165 && DECL_VIRTUAL_P (n->decl)
2166 && type_in_anonymous_namespace_p (DECL_CONTEXT (n->decl)))
2167 free_polymorphic_call_targets_hash ();
2170 /* Record about how many calls would benefit from given type to be final. */
2172 struct odr_type_warn_count
2174 tree type;
2175 int count;
2176 gcov_type dyn_count;
2179 /* Record about how many calls would benefit from given method to be final. */
2181 struct decl_warn_count
2183 tree decl;
2184 int count;
2185 gcov_type dyn_count;
2188 /* Information about type and decl warnings. */
2190 struct final_warning_record
2192 gcov_type dyn_count;
2193 vec<odr_type_warn_count> type_warnings;
2194 hash_map<tree, decl_warn_count> decl_warnings;
2196 struct final_warning_record *final_warning_records;
2198 /* Return vector containing possible targets of polymorphic call of type
2199 OTR_TYPE caling method OTR_TOKEN within type of OTR_OUTER_TYPE and OFFSET.
2200 If INCLUDE_BASES is true, walk also base types of OUTER_TYPES containig
2201 OTR_TYPE and include their virtual method. This is useful for types
2202 possibly in construction or destruction where the virtual table may
2203 temporarily change to one of base types. INCLUDE_DERIVER_TYPES make
2204 us to walk the inheritance graph for all derivations.
2206 If COMPLETEP is non-NULL, store true if the list is complete.
2207 CACHE_TOKEN (if non-NULL) will get stored to an unique ID of entry
2208 in the target cache. If user needs to visit every target list
2209 just once, it can memoize them.
2211 If SPECULATIVE is set, the list will not contain targets that
2212 are not speculatively taken.
2214 Returned vector is placed into cache. It is NOT caller's responsibility
2215 to free it. The vector can be freed on cgraph_remove_node call if
2216 the particular node is a virtual function present in the cache. */
2218 vec <cgraph_node *>
2219 possible_polymorphic_call_targets (tree otr_type,
2220 HOST_WIDE_INT otr_token,
2221 ipa_polymorphic_call_context context,
2222 bool *completep,
2223 void **cache_token,
2224 bool speculative)
2226 static struct cgraph_node_hook_list *node_removal_hook_holder;
2227 vec <cgraph_node *> nodes = vNULL;
2228 auto_vec <tree, 8> bases_to_consider;
2229 odr_type type, outer_type;
2230 polymorphic_call_target_d key;
2231 polymorphic_call_target_d **slot;
2232 unsigned int i;
2233 tree binfo, target;
2234 bool complete;
2235 bool can_refer = false;
2236 bool skipped = false;
2238 otr_type = TYPE_MAIN_VARIANT (otr_type);
2240 /* If ODR is not initialized or the constext is invalid, return empty
2241 incomplete list. */
2242 if (!odr_hash || context.invalid)
2244 if (completep)
2245 *completep = context.invalid;
2246 if (cache_token)
2247 *cache_token = NULL;
2248 return nodes;
2251 /* Do not bother to compute speculative info when user do not asks for it. */
2252 if (!speculative || !context.speculative_outer_type)
2253 context.clear_speculation ();
2255 type = get_odr_type (otr_type, true);
2257 /* Recording type variants would wast results cache. */
2258 gcc_assert (!context.outer_type
2259 || TYPE_MAIN_VARIANT (context.outer_type) == context.outer_type);
2261 /* Lookup the outer class type we want to walk.
2262 If we fail to do so, the context is invalid. */
2263 if ((context.outer_type || context.speculative_outer_type)
2264 && !context.restrict_to_inner_class (otr_type))
2266 if (completep)
2267 *completep = true;
2268 if (cache_token)
2269 *cache_token = NULL;
2270 return nodes;
2272 gcc_assert (!context.invalid);
2274 /* Check that restrict_to_inner_class kept the main variant. */
2275 gcc_assert (!context.outer_type
2276 || TYPE_MAIN_VARIANT (context.outer_type) == context.outer_type);
2278 /* We canonicalize our query, so we do not need extra hashtable entries. */
2280 /* Without outer type, we have no use for offset. Just do the
2281 basic search from innter type */
2282 if (!context.outer_type)
2283 context.clear_outer_type (otr_type);
2284 /* We need to update our hiearchy if the type does not exist. */
2285 outer_type = get_odr_type (context.outer_type, true);
2286 /* If the type is complete, there are no derivations. */
2287 if (TYPE_FINAL_P (outer_type->type))
2288 context.maybe_derived_type = false;
2290 /* Initialize query cache. */
2291 if (!cached_polymorphic_call_targets)
2293 cached_polymorphic_call_targets = new hash_set<cgraph_node *>;
2294 polymorphic_call_target_hash
2295 = new polymorphic_call_target_hash_type (23);
2296 if (!node_removal_hook_holder)
2298 node_removal_hook_holder =
2299 symtab->add_cgraph_removal_hook (&devirt_node_removal_hook, NULL);
2300 symtab->add_varpool_removal_hook (&devirt_variable_node_removal_hook,
2301 NULL);
2305 if (in_lto_p)
2307 if (context.outer_type != otr_type)
2308 context.outer_type
2309 = get_odr_type (context.outer_type, true)->type;
2310 if (context.speculative_outer_type)
2311 context.speculative_outer_type
2312 = get_odr_type (context.speculative_outer_type, true)->type;
2315 /* Lookup cached answer. */
2316 key.type = type;
2317 key.otr_token = otr_token;
2318 key.speculative = speculative;
2319 key.context = context;
2320 slot = polymorphic_call_target_hash->find_slot (&key, INSERT);
2321 if (cache_token)
2322 *cache_token = (void *)*slot;
2323 if (*slot)
2325 if (completep)
2326 *completep = (*slot)->complete;
2327 if ((*slot)->type_warning && final_warning_records)
2329 final_warning_records->type_warnings[(*slot)->type_warning - 1].count++;
2330 final_warning_records->type_warnings[(*slot)->type_warning - 1].dyn_count
2331 += final_warning_records->dyn_count;
2333 if (!speculative && (*slot)->decl_warning && final_warning_records)
2335 struct decl_warn_count *c =
2336 final_warning_records->decl_warnings.get ((*slot)->decl_warning);
2337 c->count++;
2338 c->dyn_count += final_warning_records->dyn_count;
2340 return (*slot)->targets;
2343 complete = true;
2345 /* Do actual search. */
2346 timevar_push (TV_IPA_VIRTUAL_CALL);
2347 *slot = XCNEW (polymorphic_call_target_d);
2348 if (cache_token)
2349 *cache_token = (void *)*slot;
2350 (*slot)->type = type;
2351 (*slot)->otr_token = otr_token;
2352 (*slot)->context = context;
2353 (*slot)->speculative = speculative;
2355 hash_set<tree> inserted;
2356 hash_set<tree> matched_vtables;
2358 /* First insert targets we speculatively identified as likely. */
2359 if (context.speculative_outer_type)
2361 odr_type speculative_outer_type;
2362 bool speculation_complete = true;
2364 /* First insert target from type itself and check if it may have derived types. */
2365 speculative_outer_type = get_odr_type (context.speculative_outer_type, true);
2366 if (TYPE_FINAL_P (speculative_outer_type->type))
2367 context.speculative_maybe_derived_type = false;
2368 binfo = get_binfo_at_offset (TYPE_BINFO (speculative_outer_type->type),
2369 context.speculative_offset, otr_type);
2370 if (binfo)
2371 target = gimple_get_virt_method_for_binfo (otr_token, binfo,
2372 &can_refer);
2373 else
2374 target = NULL;
2376 /* In the case we get complete method, we don't need
2377 to walk derivations. */
2378 if (target && DECL_FINAL_P (target))
2379 context.speculative_maybe_derived_type = false;
2380 if (type_possibly_instantiated_p (speculative_outer_type->type))
2381 maybe_record_node (nodes, target, &inserted, can_refer, &speculation_complete);
2382 if (binfo)
2383 matched_vtables.add (BINFO_VTABLE (binfo));
2386 /* Next walk recursively all derived types. */
2387 if (context.speculative_maybe_derived_type)
2388 for (i = 0; i < speculative_outer_type->derived_types.length(); i++)
2389 possible_polymorphic_call_targets_1 (nodes, &inserted,
2390 &matched_vtables,
2391 otr_type,
2392 speculative_outer_type->derived_types[i],
2393 otr_token, speculative_outer_type->type,
2394 context.speculative_offset,
2395 &speculation_complete,
2396 bases_to_consider,
2397 false);
2400 if (!speculative || !nodes.length ())
2402 /* First see virtual method of type itself. */
2403 binfo = get_binfo_at_offset (TYPE_BINFO (outer_type->type),
2404 context.offset, otr_type);
2405 if (binfo)
2406 target = gimple_get_virt_method_for_binfo (otr_token, binfo,
2407 &can_refer);
2408 else
2410 gcc_assert (odr_violation_reported);
2411 target = NULL;
2414 /* Destructors are never called through construction virtual tables,
2415 because the type is always known. */
2416 if (target && DECL_CXX_DESTRUCTOR_P (target))
2417 context.maybe_in_construction = false;
2419 if (target)
2421 /* In the case we get complete method, we don't need
2422 to walk derivations. */
2423 if (DECL_FINAL_P (target))
2424 context.maybe_derived_type = false;
2427 /* If OUTER_TYPE is abstract, we know we are not seeing its instance. */
2428 if (type_possibly_instantiated_p (outer_type->type))
2429 maybe_record_node (nodes, target, &inserted, can_refer, &complete);
2430 else
2431 skipped = true;
2433 if (binfo)
2434 matched_vtables.add (BINFO_VTABLE (binfo));
2436 /* Next walk recursively all derived types. */
2437 if (context.maybe_derived_type)
2439 for (i = 0; i < outer_type->derived_types.length(); i++)
2440 possible_polymorphic_call_targets_1 (nodes, &inserted,
2441 &matched_vtables,
2442 otr_type,
2443 outer_type->derived_types[i],
2444 otr_token, outer_type->type,
2445 context.offset, &complete,
2446 bases_to_consider,
2447 context.maybe_in_construction);
2449 if (!outer_type->all_derivations_known)
2451 if (!speculative && final_warning_records)
2453 if (complete
2454 && nodes.length () == 1
2455 && warn_suggest_final_types
2456 && !outer_type->derived_types.length ())
2458 if (outer_type->id >= (int)final_warning_records->type_warnings.length ())
2459 final_warning_records->type_warnings.safe_grow_cleared
2460 (odr_types.length ());
2461 final_warning_records->type_warnings[outer_type->id].count++;
2462 final_warning_records->type_warnings[outer_type->id].dyn_count
2463 += final_warning_records->dyn_count;
2464 final_warning_records->type_warnings[outer_type->id].type
2465 = outer_type->type;
2466 (*slot)->type_warning = outer_type->id + 1;
2468 if (complete
2469 && warn_suggest_final_methods
2470 && nodes.length () == 1
2471 && types_same_for_odr (DECL_CONTEXT (nodes[0]->decl),
2472 outer_type->type))
2474 bool existed;
2475 struct decl_warn_count &c =
2476 final_warning_records->decl_warnings.get_or_insert
2477 (nodes[0]->decl, &existed);
2479 if (existed)
2481 c.count++;
2482 c.dyn_count += final_warning_records->dyn_count;
2484 else
2486 c.count = 1;
2487 c.dyn_count = final_warning_records->dyn_count;
2488 c.decl = nodes[0]->decl;
2490 (*slot)->decl_warning = nodes[0]->decl;
2493 complete = false;
2497 if (!speculative)
2499 /* Destructors are never called through construction virtual tables,
2500 because the type is always known. One of entries may be cxa_pure_virtual
2501 so look to at least two of them. */
2502 if (context.maybe_in_construction)
2503 for (i =0 ; i < MIN (nodes.length (), 2); i++)
2504 if (DECL_CXX_DESTRUCTOR_P (nodes[i]->decl))
2505 context.maybe_in_construction = false;
2506 if (context.maybe_in_construction)
2508 if (type != outer_type
2509 && (!skipped
2510 || (context.maybe_derived_type
2511 && !type_all_derivations_known_p (outer_type->type))))
2512 record_targets_from_bases (otr_type, otr_token, outer_type->type,
2513 context.offset, nodes, &inserted,
2514 &matched_vtables, &complete);
2515 if (skipped)
2516 maybe_record_node (nodes, target, &inserted, can_refer, &complete);
2517 for (i = 0; i < bases_to_consider.length(); i++)
2518 maybe_record_node (nodes, bases_to_consider[i], &inserted, can_refer, &complete);
2523 (*slot)->targets = nodes;
2524 (*slot)->complete = complete;
2525 if (completep)
2526 *completep = complete;
2528 timevar_pop (TV_IPA_VIRTUAL_CALL);
2529 return nodes;
2532 bool
2533 add_decl_warning (const tree &key ATTRIBUTE_UNUSED, const decl_warn_count &value,
2534 vec<const decl_warn_count*> *vec)
2536 vec->safe_push (&value);
2537 return true;
2540 /* Dump target list TARGETS into FILE. */
2542 static void
2543 dump_targets (FILE *f, vec <cgraph_node *> targets)
2545 unsigned int i;
2547 for (i = 0; i < targets.length (); i++)
2549 char *name = NULL;
2550 if (in_lto_p)
2551 name = cplus_demangle_v3 (targets[i]->asm_name (), 0);
2552 fprintf (f, " %s/%i", name ? name : targets[i]->name (), targets[i]->order);
2553 if (in_lto_p)
2554 free (name);
2555 if (!targets[i]->definition)
2556 fprintf (f, " (no definition%s)",
2557 DECL_DECLARED_INLINE_P (targets[i]->decl)
2558 ? " inline" : "");
2560 fprintf (f, "\n");
2563 /* Dump all possible targets of a polymorphic call. */
2565 void
2566 dump_possible_polymorphic_call_targets (FILE *f,
2567 tree otr_type,
2568 HOST_WIDE_INT otr_token,
2569 const ipa_polymorphic_call_context &ctx)
2571 vec <cgraph_node *> targets;
2572 bool final;
2573 odr_type type = get_odr_type (TYPE_MAIN_VARIANT (otr_type), false);
2574 unsigned int len;
2576 if (!type)
2577 return;
2578 targets = possible_polymorphic_call_targets (otr_type, otr_token,
2579 ctx,
2580 &final, NULL, false);
2581 fprintf (f, " Targets of polymorphic call of type %i:", type->id);
2582 print_generic_expr (f, type->type, TDF_SLIM);
2583 fprintf (f, " token %i\n", (int)otr_token);
2585 ctx.dump (f);
2587 fprintf (f, " %s%s%s%s\n ",
2588 final ? "This is a complete list." :
2589 "This is partial list; extra targets may be defined in other units.",
2590 ctx.maybe_in_construction ? " (base types included)" : "",
2591 ctx.maybe_derived_type ? " (derived types included)" : "",
2592 ctx.speculative_maybe_derived_type ? " (speculative derived types included)" : "");
2593 len = targets.length ();
2594 dump_targets (f, targets);
2596 targets = possible_polymorphic_call_targets (otr_type, otr_token,
2597 ctx,
2598 &final, NULL, true);
2599 gcc_assert (targets.length () <= len);
2600 if (targets.length () != len)
2602 fprintf (f, " Speculative targets:");
2603 dump_targets (f, targets);
2605 fprintf (f, "\n");
2609 /* Return true if N can be possibly target of a polymorphic call of
2610 OTR_TYPE/OTR_TOKEN. */
2612 bool
2613 possible_polymorphic_call_target_p (tree otr_type,
2614 HOST_WIDE_INT otr_token,
2615 const ipa_polymorphic_call_context &ctx,
2616 struct cgraph_node *n)
2618 vec <cgraph_node *> targets;
2619 unsigned int i;
2620 enum built_in_function fcode;
2621 bool final;
2623 if (TREE_CODE (TREE_TYPE (n->decl)) == FUNCTION_TYPE
2624 && ((fcode = DECL_FUNCTION_CODE (n->decl))
2625 == BUILT_IN_UNREACHABLE
2626 || fcode == BUILT_IN_TRAP))
2627 return true;
2629 if (!odr_hash)
2630 return true;
2631 targets = possible_polymorphic_call_targets (otr_type, otr_token, ctx, &final);
2632 for (i = 0; i < targets.length (); i++)
2633 if (n->semantically_equivalent_p (targets[i]))
2634 return true;
2636 /* At a moment we allow middle end to dig out new external declarations
2637 as a targets of polymorphic calls. */
2638 if (!final && !n->definition)
2639 return true;
2640 return false;
2645 /* Return true if N can be possibly target of a polymorphic call of
2646 OBJ_TYPE_REF expression REF in STMT. */
2648 bool
2649 possible_polymorphic_call_target_p (tree ref,
2650 gimple stmt,
2651 struct cgraph_node *n)
2653 ipa_polymorphic_call_context context (current_function_decl, ref, stmt);
2654 tree call_fn = gimple_call_fn (stmt);
2656 return possible_polymorphic_call_target_p (obj_type_ref_class (call_fn),
2657 tree_to_uhwi
2658 (OBJ_TYPE_REF_TOKEN (call_fn)),
2659 context,
2664 /* After callgraph construction new external nodes may appear.
2665 Add them into the graph. */
2667 void
2668 update_type_inheritance_graph (void)
2670 struct cgraph_node *n;
2672 if (!odr_hash)
2673 return;
2674 free_polymorphic_call_targets_hash ();
2675 timevar_push (TV_IPA_INHERITANCE);
2676 /* We reconstruct the graph starting from types of all methods seen in the
2677 the unit. */
2678 FOR_EACH_FUNCTION (n)
2679 if (DECL_VIRTUAL_P (n->decl)
2680 && !n->definition
2681 && n->real_symbol_p ())
2682 get_odr_type (method_class_type (TYPE_MAIN_VARIANT (TREE_TYPE (n->decl))),
2683 true);
2684 timevar_pop (TV_IPA_INHERITANCE);
2688 /* Return true if N looks like likely target of a polymorphic call.
2689 Rule out cxa_pure_virtual, noreturns, function declared cold and
2690 other obvious cases. */
2692 bool
2693 likely_target_p (struct cgraph_node *n)
2695 int flags;
2696 /* cxa_pure_virtual and similar things are not likely. */
2697 if (TREE_CODE (TREE_TYPE (n->decl)) != METHOD_TYPE)
2698 return false;
2699 flags = flags_from_decl_or_type (n->decl);
2700 if (flags & ECF_NORETURN)
2701 return false;
2702 if (lookup_attribute ("cold",
2703 DECL_ATTRIBUTES (n->decl)))
2704 return false;
2705 if (n->frequency < NODE_FREQUENCY_NORMAL)
2706 return false;
2707 /* If there are no virtual tables refering the target alive,
2708 the only way the target can be called is an instance comming from other
2709 compilation unit; speculative devirtualization is build around an
2710 assumption that won't happen. */
2711 if (!referenced_from_vtable_p (n))
2712 return false;
2713 return true;
2716 /* Compare type warning records P1 and P2 and chose one with larger count;
2717 helper for qsort. */
2720 type_warning_cmp (const void *p1, const void *p2)
2722 const odr_type_warn_count *t1 = (const odr_type_warn_count *)p1;
2723 const odr_type_warn_count *t2 = (const odr_type_warn_count *)p2;
2725 if (t1->dyn_count < t2->dyn_count)
2726 return 1;
2727 if (t1->dyn_count > t2->dyn_count)
2728 return -1;
2729 return t2->count - t1->count;
2732 /* Compare decl warning records P1 and P2 and chose one with larger count;
2733 helper for qsort. */
2736 decl_warning_cmp (const void *p1, const void *p2)
2738 const decl_warn_count *t1 = *(const decl_warn_count * const *)p1;
2739 const decl_warn_count *t2 = *(const decl_warn_count * const *)p2;
2741 if (t1->dyn_count < t2->dyn_count)
2742 return 1;
2743 if (t1->dyn_count > t2->dyn_count)
2744 return -1;
2745 return t2->count - t1->count;
2749 /* Try speculatively devirtualize call to OTR_TYPE with OTR_TOKEN with
2750 context CTX. */
2752 struct cgraph_node *
2753 try_speculative_devirtualization (tree otr_type, HOST_WIDE_INT otr_token,
2754 ipa_polymorphic_call_context ctx)
2756 vec <cgraph_node *>targets
2757 = possible_polymorphic_call_targets
2758 (otr_type, otr_token, ctx, NULL, NULL, true);
2759 unsigned int i;
2760 struct cgraph_node *likely_target = NULL;
2762 for (i = 0; i < targets.length (); i++)
2763 if (likely_target_p (targets[i]))
2765 if (likely_target)
2766 return NULL;
2767 likely_target = targets[i];
2769 if (!likely_target
2770 ||!likely_target->definition
2771 || DECL_EXTERNAL (likely_target->decl))
2772 return NULL;
2774 /* Don't use an implicitly-declared destructor (c++/58678). */
2775 struct cgraph_node *non_thunk_target
2776 = likely_target->function_symbol ();
2777 if (DECL_ARTIFICIAL (non_thunk_target->decl))
2778 return NULL;
2779 if (likely_target->get_availability () <= AVAIL_INTERPOSABLE
2780 && likely_target->can_be_discarded_p ())
2781 return NULL;
2782 return likely_target;
2785 /* The ipa-devirt pass.
2786 When polymorphic call has only one likely target in the unit,
2787 turn it into speculative call. */
2789 static unsigned int
2790 ipa_devirt (void)
2792 struct cgraph_node *n;
2793 hash_set<void *> bad_call_targets;
2794 struct cgraph_edge *e;
2796 int npolymorphic = 0, nspeculated = 0, nconverted = 0, ncold = 0;
2797 int nmultiple = 0, noverwritable = 0, ndevirtualized = 0, nnotdefined = 0;
2798 int nwrong = 0, nok = 0, nexternal = 0, nartificial = 0;
2800 if (!odr_types_ptr)
2801 return 0;
2803 /* We can output -Wsuggest-final-methods and -Wsuggest-final-types warnings.
2804 This is implemented by setting up final_warning_records that are updated
2805 by get_polymorphic_call_targets.
2806 We need to clear cache in this case to trigger recomputation of all
2807 entries. */
2808 if (warn_suggest_final_methods || warn_suggest_final_types)
2810 final_warning_records = new (final_warning_record);
2811 final_warning_records->type_warnings = vNULL;
2812 final_warning_records->type_warnings.safe_grow_cleared (odr_types.length ());
2813 free_polymorphic_call_targets_hash ();
2816 FOR_EACH_DEFINED_FUNCTION (n)
2818 bool update = false;
2819 if (!opt_for_fn (n->decl, flag_devirtualize))
2820 continue;
2821 if (dump_file && n->indirect_calls)
2822 fprintf (dump_file, "\n\nProcesing function %s/%i\n",
2823 n->name (), n->order);
2824 for (e = n->indirect_calls; e; e = e->next_callee)
2825 if (e->indirect_info->polymorphic)
2827 struct cgraph_node *likely_target = NULL;
2828 void *cache_token;
2829 bool final;
2831 if (final_warning_records)
2832 final_warning_records->dyn_count = e->count;
2834 vec <cgraph_node *>targets
2835 = possible_polymorphic_call_targets
2836 (e, &final, &cache_token, true);
2837 unsigned int i;
2839 /* Trigger warnings by calculating non-speculative targets. */
2840 if (warn_suggest_final_methods || warn_suggest_final_types)
2841 possible_polymorphic_call_targets (e);
2843 if (dump_file)
2844 dump_possible_polymorphic_call_targets
2845 (dump_file, e);
2847 npolymorphic++;
2849 if (!opt_for_fn (n->decl, flag_devirtualize_speculatively))
2850 continue;
2852 if (!e->maybe_hot_p ())
2854 if (dump_file)
2855 fprintf (dump_file, "Call is cold\n\n");
2856 ncold++;
2857 continue;
2859 if (e->speculative)
2861 if (dump_file)
2862 fprintf (dump_file, "Call is aready speculated\n\n");
2863 nspeculated++;
2865 /* When dumping see if we agree with speculation. */
2866 if (!dump_file)
2867 continue;
2869 if (bad_call_targets.contains (cache_token))
2871 if (dump_file)
2872 fprintf (dump_file, "Target list is known to be useless\n\n");
2873 nmultiple++;
2874 continue;
2876 for (i = 0; i < targets.length (); i++)
2877 if (likely_target_p (targets[i]))
2879 if (likely_target)
2881 likely_target = NULL;
2882 if (dump_file)
2883 fprintf (dump_file, "More than one likely target\n\n");
2884 nmultiple++;
2885 break;
2887 likely_target = targets[i];
2889 if (!likely_target)
2891 bad_call_targets.add (cache_token);
2892 continue;
2894 /* This is reached only when dumping; check if we agree or disagree
2895 with the speculation. */
2896 if (e->speculative)
2898 struct cgraph_edge *e2;
2899 struct ipa_ref *ref;
2900 e->speculative_call_info (e2, e, ref);
2901 if (e2->callee->ultimate_alias_target ()
2902 == likely_target->ultimate_alias_target ())
2904 fprintf (dump_file, "We agree with speculation\n\n");
2905 nok++;
2907 else
2909 fprintf (dump_file, "We disagree with speculation\n\n");
2910 nwrong++;
2912 continue;
2914 if (!likely_target->definition)
2916 if (dump_file)
2917 fprintf (dump_file, "Target is not an definition\n\n");
2918 nnotdefined++;
2919 continue;
2921 /* Do not introduce new references to external symbols. While we
2922 can handle these just well, it is common for programs to
2923 incorrectly with headers defining methods they are linked
2924 with. */
2925 if (DECL_EXTERNAL (likely_target->decl))
2927 if (dump_file)
2928 fprintf (dump_file, "Target is external\n\n");
2929 nexternal++;
2930 continue;
2932 /* Don't use an implicitly-declared destructor (c++/58678). */
2933 struct cgraph_node *non_thunk_target
2934 = likely_target->function_symbol ();
2935 if (DECL_ARTIFICIAL (non_thunk_target->decl))
2937 if (dump_file)
2938 fprintf (dump_file, "Target is artificial\n\n");
2939 nartificial++;
2940 continue;
2942 if (likely_target->get_availability () <= AVAIL_INTERPOSABLE
2943 && likely_target->can_be_discarded_p ())
2945 if (dump_file)
2946 fprintf (dump_file, "Target is overwritable\n\n");
2947 noverwritable++;
2948 continue;
2950 else if (dbg_cnt (devirt))
2952 if (dump_enabled_p ())
2954 location_t locus = gimple_location_safe (e->call_stmt);
2955 dump_printf_loc (MSG_OPTIMIZED_LOCATIONS, locus,
2956 "speculatively devirtualizing call in %s/%i to %s/%i\n",
2957 n->name (), n->order,
2958 likely_target->name (),
2959 likely_target->order);
2961 if (!likely_target->can_be_discarded_p ())
2963 cgraph_node *alias;
2964 alias = dyn_cast<cgraph_node *> (likely_target->noninterposable_alias ());
2965 if (alias)
2966 likely_target = alias;
2968 nconverted++;
2969 update = true;
2970 e->make_speculative
2971 (likely_target, e->count * 8 / 10, e->frequency * 8 / 10);
2974 if (update)
2975 inline_update_overall_summary (n);
2977 if (warn_suggest_final_methods || warn_suggest_final_types)
2979 if (warn_suggest_final_types)
2981 final_warning_records->type_warnings.qsort (type_warning_cmp);
2982 for (unsigned int i = 0;
2983 i < final_warning_records->type_warnings.length (); i++)
2984 if (final_warning_records->type_warnings[i].count)
2986 tree type = final_warning_records->type_warnings[i].type;
2987 int count = final_warning_records->type_warnings[i].count;
2988 long long dyn_count
2989 = final_warning_records->type_warnings[i].dyn_count;
2991 if (!dyn_count)
2992 warning_n (DECL_SOURCE_LOCATION (TYPE_NAME (type)),
2993 OPT_Wsuggest_final_types, count,
2994 "Declaring type %qD final "
2995 "would enable devirtualization of %i call",
2996 "Declaring type %qD final "
2997 "would enable devirtualization of %i calls",
2998 type,
2999 count);
3000 else
3001 warning_n (DECL_SOURCE_LOCATION (TYPE_NAME (type)),
3002 OPT_Wsuggest_final_types, count,
3003 "Declaring type %qD final "
3004 "would enable devirtualization of %i call "
3005 "executed %lli times",
3006 "Declaring type %qD final "
3007 "would enable devirtualization of %i calls "
3008 "executed %lli times",
3009 type,
3010 count,
3011 dyn_count);
3015 if (warn_suggest_final_methods)
3017 vec<const decl_warn_count*> decl_warnings_vec = vNULL;
3019 final_warning_records->decl_warnings.traverse
3020 <vec<const decl_warn_count *> *, add_decl_warning> (&decl_warnings_vec);
3021 decl_warnings_vec.qsort (decl_warning_cmp);
3022 for (unsigned int i = 0; i < decl_warnings_vec.length (); i++)
3024 tree decl = decl_warnings_vec[i]->decl;
3025 int count = decl_warnings_vec[i]->count;
3026 long long dyn_count = decl_warnings_vec[i]->dyn_count;
3028 if (!dyn_count)
3029 if (DECL_CXX_DESTRUCTOR_P (decl))
3030 warning_n (DECL_SOURCE_LOCATION (decl),
3031 OPT_Wsuggest_final_methods, count,
3032 "Declaring virtual destructor of %qD final "
3033 "would enable devirtualization of %i call",
3034 "Declaring virtual destructor of %qD final "
3035 "would enable devirtualization of %i calls",
3036 DECL_CONTEXT (decl), count);
3037 else
3038 warning_n (DECL_SOURCE_LOCATION (decl),
3039 OPT_Wsuggest_final_methods, count,
3040 "Declaring method %qD final "
3041 "would enable devirtualization of %i call",
3042 "Declaring method %qD final "
3043 "would enable devirtualization of %i calls",
3044 decl, count);
3045 else if (DECL_CXX_DESTRUCTOR_P (decl))
3046 warning_n (DECL_SOURCE_LOCATION (decl),
3047 OPT_Wsuggest_final_methods, count,
3048 "Declaring virtual destructor of %qD final "
3049 "would enable devirtualization of %i call "
3050 "executed %lli times",
3051 "Declaring virtual destructor of %qD final "
3052 "would enable devirtualization of %i calls "
3053 "executed %lli times",
3054 DECL_CONTEXT (decl), count, dyn_count);
3055 else
3056 warning_n (DECL_SOURCE_LOCATION (decl),
3057 OPT_Wsuggest_final_methods, count,
3058 "Declaring method %qD final "
3059 "would enable devirtualization of %i call "
3060 "executed %lli times",
3061 "Declaring method %qD final "
3062 "would enable devirtualization of %i calls "
3063 "executed %lli times",
3064 decl, count, dyn_count);
3068 delete (final_warning_records);
3069 final_warning_records = 0;
3072 if (dump_file)
3073 fprintf (dump_file,
3074 "%i polymorphic calls, %i devirtualized,"
3075 " %i speculatively devirtualized, %i cold\n"
3076 "%i have multiple targets, %i overwritable,"
3077 " %i already speculated (%i agree, %i disagree),"
3078 " %i external, %i not defined, %i artificial\n",
3079 npolymorphic, ndevirtualized, nconverted, ncold,
3080 nmultiple, noverwritable, nspeculated, nok, nwrong,
3081 nexternal, nnotdefined, nartificial);
3082 return ndevirtualized ? TODO_remove_functions : 0;
3085 namespace {
3087 const pass_data pass_data_ipa_devirt =
3089 IPA_PASS, /* type */
3090 "devirt", /* name */
3091 OPTGROUP_NONE, /* optinfo_flags */
3092 TV_IPA_DEVIRT, /* tv_id */
3093 0, /* properties_required */
3094 0, /* properties_provided */
3095 0, /* properties_destroyed */
3096 0, /* todo_flags_start */
3097 ( TODO_dump_symtab ), /* todo_flags_finish */
3100 class pass_ipa_devirt : public ipa_opt_pass_d
3102 public:
3103 pass_ipa_devirt (gcc::context *ctxt)
3104 : ipa_opt_pass_d (pass_data_ipa_devirt, ctxt,
3105 NULL, /* generate_summary */
3106 NULL, /* write_summary */
3107 NULL, /* read_summary */
3108 NULL, /* write_optimization_summary */
3109 NULL, /* read_optimization_summary */
3110 NULL, /* stmt_fixup */
3111 0, /* function_transform_todo_flags_start */
3112 NULL, /* function_transform */
3113 NULL) /* variable_transform */
3116 /* opt_pass methods: */
3117 virtual bool gate (function *)
3119 /* In LTO, always run the IPA passes and decide on function basis if the
3120 pass is enabled. */
3121 if (in_lto_p)
3122 return true;
3123 return (flag_devirtualize
3124 && (flag_devirtualize_speculatively
3125 || (warn_suggest_final_methods
3126 || warn_suggest_final_types))
3127 && optimize);
3130 virtual unsigned int execute (function *) { return ipa_devirt (); }
3132 }; // class pass_ipa_devirt
3134 } // anon namespace
3136 ipa_opt_pass_d *
3137 make_pass_ipa_devirt (gcc::context *ctxt)
3139 return new pass_ipa_devirt (ctxt);
3142 #include "gt-ipa-devirt.h"