* doc/install.texi (Prerequisites): Update link for MPC.
[official-gcc.git] / gcc / ipa-devirt.c
blob9564d651b2be9c5113d718918a921ad0c725eeae
1 /* Basic IPA utilities for type inheritance graph construction and
2 devirtualization.
3 Copyright (C) 2013-2018 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 vocabulary:
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++ frontend. 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 representation 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 "backend.h"
112 #include "rtl.h"
113 #include "tree.h"
114 #include "gimple.h"
115 #include "alloc-pool.h"
116 #include "tree-pass.h"
117 #include "cgraph.h"
118 #include "lto-streamer.h"
119 #include "fold-const.h"
120 #include "print-tree.h"
121 #include "calls.h"
122 #include "ipa-utils.h"
123 #include "gimple-fold.h"
124 #include "symbol-summary.h"
125 #include "tree-vrp.h"
126 #include "ipa-prop.h"
127 #include "ipa-fnsummary.h"
128 #include "demangle.h"
129 #include "dbgcnt.h"
130 #include "gimple-pretty-print.h"
131 #include "intl.h"
132 #include "stringpool.h"
133 #include "attribs.h"
135 /* Hash based set of pairs of types. */
136 struct type_pair
138 tree first;
139 tree second;
142 template <>
143 struct default_hash_traits <type_pair>
144 : typed_noop_remove <type_pair>
146 GTY((skip)) typedef type_pair value_type;
147 GTY((skip)) typedef type_pair compare_type;
148 static hashval_t
149 hash (type_pair p)
151 return TYPE_UID (p.first) ^ TYPE_UID (p.second);
153 static bool
154 is_empty (type_pair p)
156 return p.first == NULL;
158 static bool
159 is_deleted (type_pair p ATTRIBUTE_UNUSED)
161 return false;
163 static bool
164 equal (const type_pair &a, const type_pair &b)
166 return a.first==b.first && a.second == b.second;
168 static void
169 mark_empty (type_pair &e)
171 e.first = NULL;
175 static bool odr_types_equivalent_p (tree, tree, bool, bool *,
176 hash_set<type_pair> *,
177 location_t, location_t);
179 static bool odr_violation_reported = false;
182 /* Pointer set of all call targets appearing in the cache. */
183 static hash_set<cgraph_node *> *cached_polymorphic_call_targets;
185 /* The node of type inheritance graph. For each type unique in
186 One Definition Rule (ODR) sense, we produce one node linking all
187 main variants of types equivalent to it, bases and derived types. */
189 struct GTY(()) odr_type_d
191 /* leader type. */
192 tree type;
193 /* All bases; built only for main variants of types. */
194 vec<odr_type> GTY((skip)) bases;
195 /* All derived types with virtual methods seen in unit;
196 built only for main variants of types. */
197 vec<odr_type> GTY((skip)) derived_types;
199 /* All equivalent types, if more than one. */
200 vec<tree, va_gc> *types;
201 /* Set of all equivalent types, if NON-NULL. */
202 hash_set<tree> * GTY((skip)) types_set;
204 /* Unique ID indexing the type in odr_types array. */
205 int id;
206 /* Is it in anonymous namespace? */
207 bool anonymous_namespace;
208 /* Do we know about all derivations of given type? */
209 bool all_derivations_known;
210 /* Did we report ODR violation here? */
211 bool odr_violated;
212 /* Set when virtual table without RTTI previaled table with. */
213 bool rtti_broken;
216 /* Return TRUE if all derived types of T are known and thus
217 we may consider the walk of derived type complete.
219 This is typically true only for final anonymous namespace types and types
220 defined within functions (that may be COMDAT and thus shared across units,
221 but with the same set of derived types). */
223 bool
224 type_all_derivations_known_p (const_tree t)
226 if (TYPE_FINAL_P (t))
227 return true;
228 if (flag_ltrans)
229 return false;
230 /* Non-C++ types may have IDENTIFIER_NODE here, do not crash. */
231 if (!TYPE_NAME (t) || TREE_CODE (TYPE_NAME (t)) != TYPE_DECL)
232 return true;
233 if (type_in_anonymous_namespace_p (t))
234 return true;
235 return (decl_function_context (TYPE_NAME (t)) != NULL);
238 /* Return TRUE if type's constructors are all visible. */
240 static bool
241 type_all_ctors_visible_p (tree t)
243 return !flag_ltrans
244 && symtab->state >= CONSTRUCTION
245 /* We can not always use type_all_derivations_known_p.
246 For function local types we must assume case where
247 the function is COMDAT and shared in between units.
249 TODO: These cases are quite easy to get, but we need
250 to keep track of C++ privatizing via -Wno-weak
251 as well as the IPA privatizing. */
252 && type_in_anonymous_namespace_p (t);
255 /* Return TRUE if type may have instance. */
257 static bool
258 type_possibly_instantiated_p (tree t)
260 tree vtable;
261 varpool_node *vnode;
263 /* TODO: Add abstract types here. */
264 if (!type_all_ctors_visible_p (t))
265 return true;
267 vtable = BINFO_VTABLE (TYPE_BINFO (t));
268 if (TREE_CODE (vtable) == POINTER_PLUS_EXPR)
269 vtable = TREE_OPERAND (TREE_OPERAND (vtable, 0), 0);
270 vnode = varpool_node::get (vtable);
271 return vnode && vnode->definition;
274 /* Hash used to unify ODR types based on their mangled name and for anonymous
275 namespace types. */
277 struct odr_name_hasher : pointer_hash <odr_type_d>
279 typedef union tree_node *compare_type;
280 static inline hashval_t hash (const odr_type_d *);
281 static inline bool equal (const odr_type_d *, const tree_node *);
282 static inline void remove (odr_type_d *);
285 /* Has used to unify ODR types based on their associated virtual table.
286 This hash is needed to keep -fno-lto-odr-type-merging to work and contains
287 only polymorphic types. Types with mangled names are inserted to both. */
289 struct odr_vtable_hasher:odr_name_hasher
291 static inline hashval_t hash (const odr_type_d *);
292 static inline bool equal (const odr_type_d *, const tree_node *);
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 static bool
309 can_be_name_hashed_p (tree t)
311 return (!in_lto_p || odr_type_p (t));
314 /* Hash type by its ODR name. */
316 static hashval_t
317 hash_odr_name (const_tree t)
319 gcc_checking_assert (main_odr_variant (t) == t);
321 /* If not in LTO, all main variants are unique, so we can do
322 pointer hash. */
323 if (!in_lto_p)
324 return htab_hash_pointer (t);
326 /* Anonymous types are unique. */
327 if (type_with_linkage_p (t) && type_in_anonymous_namespace_p (t))
328 return htab_hash_pointer (t);
330 gcc_checking_assert (TYPE_NAME (t)
331 && DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t)));
332 return IDENTIFIER_HASH_VALUE (DECL_ASSEMBLER_NAME (TYPE_NAME (t)));
335 /* Return the computed hashcode for ODR_TYPE. */
337 inline hashval_t
338 odr_name_hasher::hash (const odr_type_d *odr_type)
340 return hash_odr_name (odr_type->type);
343 static bool
344 can_be_vtable_hashed_p (tree t)
346 /* vtable hashing can distinguish only main variants. */
347 if (TYPE_MAIN_VARIANT (t) != t)
348 return false;
349 /* Anonymous namespace types are always handled by name hash. */
350 if (type_with_linkage_p (t) && type_in_anonymous_namespace_p (t))
351 return false;
352 return (TREE_CODE (t) == RECORD_TYPE
353 && TYPE_BINFO (t) && BINFO_VTABLE (TYPE_BINFO (t)));
356 /* Hash type by assembler name of its vtable. */
358 static hashval_t
359 hash_odr_vtable (const_tree t)
361 tree v = BINFO_VTABLE (TYPE_BINFO (TYPE_MAIN_VARIANT (t)));
362 inchash::hash hstate;
364 gcc_checking_assert (in_lto_p);
365 gcc_checking_assert (!type_in_anonymous_namespace_p (t));
366 gcc_checking_assert (TREE_CODE (t) == RECORD_TYPE
367 && TYPE_BINFO (t) && BINFO_VTABLE (TYPE_BINFO (t)));
368 gcc_checking_assert (main_odr_variant (t) == t);
370 if (TREE_CODE (v) == POINTER_PLUS_EXPR)
372 add_expr (TREE_OPERAND (v, 1), hstate);
373 v = TREE_OPERAND (TREE_OPERAND (v, 0), 0);
376 hstate.add_hwi (IDENTIFIER_HASH_VALUE (DECL_ASSEMBLER_NAME (v)));
377 return hstate.end ();
380 /* Return the computed hashcode for ODR_TYPE. */
382 inline hashval_t
383 odr_vtable_hasher::hash (const odr_type_d *odr_type)
385 return hash_odr_vtable (odr_type->type);
388 /* For languages with One Definition Rule, work out if
389 types are the same based on their name.
391 This is non-trivial for LTO where minor differences in
392 the type representation may have prevented type merging
393 to merge two copies of otherwise equivalent type.
395 Until we start streaming mangled type names, this function works
396 only for polymorphic types.
398 When STRICT is true, we compare types by their names for purposes of
399 ODR violation warnings. When strict is false, we consider variants
400 equivalent, because it is all that matters for devirtualization machinery.
403 bool
404 types_same_for_odr (const_tree type1, const_tree type2, bool strict)
406 gcc_checking_assert (TYPE_P (type1) && TYPE_P (type2));
408 type1 = main_odr_variant (type1);
409 type2 = main_odr_variant (type2);
410 if (!strict)
412 type1 = TYPE_MAIN_VARIANT (type1);
413 type2 = TYPE_MAIN_VARIANT (type2);
416 if (type1 == type2)
417 return true;
419 if (!in_lto_p)
420 return false;
422 /* Check for anonymous namespaces. Those have !TREE_PUBLIC
423 on the corresponding TYPE_STUB_DECL. */
424 if ((type_with_linkage_p (type1) && type_in_anonymous_namespace_p (type1))
425 || (type_with_linkage_p (type2) && type_in_anonymous_namespace_p (type2)))
426 return false;
429 /* ODR name of the type is set in DECL_ASSEMBLER_NAME of its TYPE_NAME.
431 Ideally we should never need types without ODR names here. It can however
432 happen in two cases:
434 1) for builtin types that are not streamed but rebuilt in lto/lto-lang.c
435 Here testing for equivalence is safe, since their MAIN_VARIANTs are
436 unique.
437 2) for units streamed with -fno-lto-odr-type-merging. Here we can't
438 establish precise ODR equivalency, but for correctness we care only
439 about equivalency on complete polymorphic types. For these we can
440 compare assembler names of their virtual tables. */
441 if ((!TYPE_NAME (type1) || !DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (type1)))
442 || (!TYPE_NAME (type2) || !DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (type2))))
444 /* See if types are obviously different (i.e. different codes
445 or polymorphic wrt non-polymorphic). This is not strictly correct
446 for ODR violating programs, but we can't do better without streaming
447 ODR names. */
448 if (TREE_CODE (type1) != TREE_CODE (type2))
449 return false;
450 if (TREE_CODE (type1) == RECORD_TYPE
451 && (TYPE_BINFO (type1) == NULL_TREE)
452 != (TYPE_BINFO (type2) == NULL_TREE))
453 return false;
454 if (TREE_CODE (type1) == RECORD_TYPE && TYPE_BINFO (type1)
455 && (BINFO_VTABLE (TYPE_BINFO (type1)) == NULL_TREE)
456 != (BINFO_VTABLE (TYPE_BINFO (type2)) == NULL_TREE))
457 return false;
459 /* At the moment we have no way to establish ODR equivalence at LTO
460 other than comparing virtual table pointers of polymorphic types.
461 Eventually we should start saving mangled names in TYPE_NAME.
462 Then this condition will become non-trivial. */
464 if (TREE_CODE (type1) == RECORD_TYPE
465 && TYPE_BINFO (type1) && TYPE_BINFO (type2)
466 && BINFO_VTABLE (TYPE_BINFO (type1))
467 && BINFO_VTABLE (TYPE_BINFO (type2)))
469 tree v1 = BINFO_VTABLE (TYPE_BINFO (type1));
470 tree v2 = BINFO_VTABLE (TYPE_BINFO (type2));
471 gcc_assert (TREE_CODE (v1) == POINTER_PLUS_EXPR
472 && TREE_CODE (v2) == POINTER_PLUS_EXPR);
473 return (operand_equal_p (TREE_OPERAND (v1, 1),
474 TREE_OPERAND (v2, 1), 0)
475 && DECL_ASSEMBLER_NAME
476 (TREE_OPERAND (TREE_OPERAND (v1, 0), 0))
477 == DECL_ASSEMBLER_NAME
478 (TREE_OPERAND (TREE_OPERAND (v2, 0), 0)));
480 gcc_unreachable ();
482 return (DECL_ASSEMBLER_NAME (TYPE_NAME (type1))
483 == DECL_ASSEMBLER_NAME (TYPE_NAME (type2)));
486 /* Return true if we can decide on ODR equivalency.
488 In non-LTO it is always decide, in LTO however it depends in the type has
489 ODR info attached.
491 When STRICT is false, compare main variants. */
493 bool
494 types_odr_comparable (tree t1, tree t2, bool strict)
496 return (!in_lto_p
497 || (strict ? (main_odr_variant (t1) == main_odr_variant (t2)
498 && main_odr_variant (t1))
499 : TYPE_MAIN_VARIANT (t1) == TYPE_MAIN_VARIANT (t2))
500 || (odr_type_p (t1) && odr_type_p (t2))
501 || (TREE_CODE (t1) == RECORD_TYPE && TREE_CODE (t2) == RECORD_TYPE
502 && TYPE_BINFO (t1) && TYPE_BINFO (t2)
503 && polymorphic_type_binfo_p (TYPE_BINFO (t1))
504 && polymorphic_type_binfo_p (TYPE_BINFO (t2))));
507 /* Return true if T1 and T2 are ODR equivalent. If ODR equivalency is not
508 known, be conservative and return false. */
510 bool
511 types_must_be_same_for_odr (tree t1, tree t2)
513 if (types_odr_comparable (t1, t2))
514 return types_same_for_odr (t1, t2);
515 else
516 return TYPE_MAIN_VARIANT (t1) == TYPE_MAIN_VARIANT (t2);
519 /* If T is compound type, return type it is based on. */
521 static tree
522 compound_type_base (const_tree t)
524 if (TREE_CODE (t) == ARRAY_TYPE
525 || POINTER_TYPE_P (t)
526 || TREE_CODE (t) == COMPLEX_TYPE
527 || VECTOR_TYPE_P (t))
528 return TREE_TYPE (t);
529 if (TREE_CODE (t) == METHOD_TYPE)
530 return TYPE_METHOD_BASETYPE (t);
531 if (TREE_CODE (t) == OFFSET_TYPE)
532 return TYPE_OFFSET_BASETYPE (t);
533 return NULL_TREE;
536 /* Return true if T is either ODR type or compound type based from it.
537 If the function return true, we know that T is a type originating from C++
538 source even at link-time. */
540 bool
541 odr_or_derived_type_p (const_tree t)
545 if (odr_type_p (t))
546 return true;
547 /* Function type is a tricky one. Basically we can consider it
548 ODR derived if return type or any of the parameters is.
549 We need to check all parameters because LTO streaming merges
550 common types (such as void) and they are not considered ODR then. */
551 if (TREE_CODE (t) == FUNCTION_TYPE)
553 if (TYPE_METHOD_BASETYPE (t))
554 t = TYPE_METHOD_BASETYPE (t);
555 else
557 if (TREE_TYPE (t) && odr_or_derived_type_p (TREE_TYPE (t)))
558 return true;
559 for (t = TYPE_ARG_TYPES (t); t; t = TREE_CHAIN (t))
560 if (odr_or_derived_type_p (TREE_VALUE (t)))
561 return true;
562 return false;
565 else
566 t = compound_type_base (t);
568 while (t);
569 return t;
572 /* Compare types T1 and T2 and return true if they are
573 equivalent. */
575 inline bool
576 odr_name_hasher::equal (const odr_type_d *o1, const tree_node *t2)
578 tree t1 = o1->type;
580 gcc_checking_assert (main_odr_variant (t2) == t2);
581 gcc_checking_assert (main_odr_variant (t1) == t1);
582 if (t1 == t2)
583 return true;
584 if (!in_lto_p)
585 return false;
586 /* Check for anonymous namespaces. Those have !TREE_PUBLIC
587 on the corresponding TYPE_STUB_DECL. */
588 if ((type_with_linkage_p (t1) && type_in_anonymous_namespace_p (t1))
589 || (type_with_linkage_p (t2) && type_in_anonymous_namespace_p (t2)))
590 return false;
591 gcc_checking_assert (DECL_ASSEMBLER_NAME (TYPE_NAME (t1)));
592 gcc_checking_assert (DECL_ASSEMBLER_NAME (TYPE_NAME (t2)));
593 return (DECL_ASSEMBLER_NAME (TYPE_NAME (t1))
594 == DECL_ASSEMBLER_NAME (TYPE_NAME (t2)));
597 /* Compare types T1 and T2 and return true if they are
598 equivalent. */
600 inline bool
601 odr_vtable_hasher::equal (const odr_type_d *o1, const tree_node *t2)
603 tree t1 = o1->type;
605 gcc_checking_assert (main_odr_variant (t2) == t2);
606 gcc_checking_assert (main_odr_variant (t1) == t1);
607 gcc_checking_assert (in_lto_p);
608 t1 = TYPE_MAIN_VARIANT (t1);
609 t2 = TYPE_MAIN_VARIANT (t2);
610 if (t1 == t2)
611 return true;
612 tree v1 = BINFO_VTABLE (TYPE_BINFO (t1));
613 tree v2 = BINFO_VTABLE (TYPE_BINFO (t2));
614 return (operand_equal_p (TREE_OPERAND (v1, 1),
615 TREE_OPERAND (v2, 1), 0)
616 && DECL_ASSEMBLER_NAME
617 (TREE_OPERAND (TREE_OPERAND (v1, 0), 0))
618 == DECL_ASSEMBLER_NAME
619 (TREE_OPERAND (TREE_OPERAND (v2, 0), 0)));
622 /* Free ODR type V. */
624 inline void
625 odr_name_hasher::remove (odr_type_d *v)
627 v->bases.release ();
628 v->derived_types.release ();
629 if (v->types_set)
630 delete v->types_set;
631 ggc_free (v);
634 /* ODR type hash used to look up ODR type based on tree type node. */
636 typedef hash_table<odr_name_hasher> odr_hash_type;
637 static odr_hash_type *odr_hash;
638 typedef hash_table<odr_vtable_hasher> odr_vtable_hash_type;
639 static odr_vtable_hash_type *odr_vtable_hash;
641 /* ODR types are also stored into ODR_TYPE vector to allow consistent
642 walking. Bases appear before derived types. Vector is garbage collected
643 so we won't end up visiting empty types. */
645 static GTY(()) vec <odr_type, va_gc> *odr_types_ptr;
646 #define odr_types (*odr_types_ptr)
648 /* Set TYPE_BINFO of TYPE and its variants to BINFO. */
649 void
650 set_type_binfo (tree type, tree binfo)
652 for (; type; type = TYPE_NEXT_VARIANT (type))
653 if (COMPLETE_TYPE_P (type))
654 TYPE_BINFO (type) = binfo;
655 else
656 gcc_assert (!TYPE_BINFO (type));
659 /* Compare T1 and T2 based on name or structure. */
661 static bool
662 odr_subtypes_equivalent_p (tree t1, tree t2,
663 hash_set<type_pair> *visited,
664 location_t loc1, location_t loc2)
667 /* This can happen in incomplete types that should be handled earlier. */
668 gcc_assert (t1 && t2);
670 t1 = main_odr_variant (t1);
671 t2 = main_odr_variant (t2);
672 if (t1 == t2)
673 return true;
675 /* Anonymous namespace types must match exactly. */
676 if ((type_with_linkage_p (t1) && type_in_anonymous_namespace_p (t1))
677 || (type_with_linkage_p (t2) && type_in_anonymous_namespace_p (t2)))
678 return false;
680 /* For ODR types be sure to compare their names.
681 To support -Wno-odr-type-merging we allow one type to be non-ODR
682 and other ODR even though it is a violation. */
683 if (types_odr_comparable (t1, t2, true))
685 if (!types_same_for_odr (t1, t2, true))
686 return false;
687 /* Limit recursion: If subtypes are ODR types and we know
688 that they are same, be happy. */
689 if (!odr_type_p (t1) || !get_odr_type (t1, true)->odr_violated)
690 return true;
693 /* Component types, builtins and possibly violating ODR types
694 have to be compared structurally. */
695 if (TREE_CODE (t1) != TREE_CODE (t2))
696 return false;
697 if (AGGREGATE_TYPE_P (t1)
698 && (TYPE_NAME (t1) == NULL_TREE) != (TYPE_NAME (t2) == NULL_TREE))
699 return false;
701 type_pair pair={t1,t2};
702 if (TYPE_UID (t1) > TYPE_UID (t2))
704 pair.first = t2;
705 pair.second = t1;
707 if (visited->add (pair))
708 return true;
709 return odr_types_equivalent_p (t1, t2, false, NULL, visited, loc1, loc2);
712 /* Return true if DECL1 and DECL2 are identical methods. Consider
713 name equivalent to name.localalias.xyz. */
715 static bool
716 methods_equal_p (tree decl1, tree decl2)
718 if (DECL_ASSEMBLER_NAME (decl1) == DECL_ASSEMBLER_NAME (decl2))
719 return true;
720 const char sep = symbol_table::symbol_suffix_separator ();
722 const char *name1 = IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (decl1));
723 const char *ptr1 = strchr (name1, sep);
724 int len1 = ptr1 ? ptr1 - name1 : strlen (name1);
726 const char *name2 = IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (decl2));
727 const char *ptr2 = strchr (name2, sep);
728 int len2 = ptr2 ? ptr2 - name2 : strlen (name2);
730 if (len1 != len2)
731 return false;
732 return !strncmp (name1, name2, len1);
735 /* Compare two virtual tables, PREVAILING and VTABLE and output ODR
736 violation warnings. */
738 void
739 compare_virtual_tables (varpool_node *prevailing, varpool_node *vtable)
741 int n1, n2;
743 if (DECL_VIRTUAL_P (prevailing->decl) != DECL_VIRTUAL_P (vtable->decl))
745 odr_violation_reported = true;
746 if (DECL_VIRTUAL_P (prevailing->decl))
748 varpool_node *tmp = prevailing;
749 prevailing = vtable;
750 vtable = tmp;
752 auto_diagnostic_group d;
753 if (warning_at (DECL_SOURCE_LOCATION
754 (TYPE_NAME (DECL_CONTEXT (vtable->decl))),
755 OPT_Wodr,
756 "virtual table of type %qD violates one definition rule",
757 DECL_CONTEXT (vtable->decl)))
758 inform (DECL_SOURCE_LOCATION (prevailing->decl),
759 "variable of same assembler name as the virtual table is "
760 "defined in another translation unit");
761 return;
763 if (!prevailing->definition || !vtable->definition)
764 return;
766 /* If we do not stream ODR type info, do not bother to do useful compare. */
767 if (!TYPE_BINFO (DECL_CONTEXT (vtable->decl))
768 || !polymorphic_type_binfo_p (TYPE_BINFO (DECL_CONTEXT (vtable->decl))))
769 return;
771 odr_type class_type = get_odr_type (DECL_CONTEXT (vtable->decl), true);
773 if (class_type->odr_violated)
774 return;
776 for (n1 = 0, n2 = 0; true; n1++, n2++)
778 struct ipa_ref *ref1, *ref2;
779 bool end1, end2;
781 end1 = !prevailing->iterate_reference (n1, ref1);
782 end2 = !vtable->iterate_reference (n2, ref2);
784 /* !DECL_VIRTUAL_P means RTTI entry;
785 We warn when RTTI is lost because non-RTTI previals; we silently
786 accept the other case. */
787 while (!end2
788 && (end1
789 || (methods_equal_p (ref1->referred->decl,
790 ref2->referred->decl)
791 && TREE_CODE (ref1->referred->decl) == FUNCTION_DECL))
792 && TREE_CODE (ref2->referred->decl) != FUNCTION_DECL)
794 if (!class_type->rtti_broken)
796 auto_diagnostic_group d;
797 if (warning_at (DECL_SOURCE_LOCATION
798 (TYPE_NAME (DECL_CONTEXT (vtable->decl))),
799 OPT_Wodr,
800 "virtual table of type %qD contains RTTI "
801 "information",
802 DECL_CONTEXT (vtable->decl)))
804 inform (DECL_SOURCE_LOCATION
805 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
806 "but is prevailed by one without from other"
807 " translation unit");
808 inform (DECL_SOURCE_LOCATION
809 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
810 "RTTI will not work on this type");
811 class_type->rtti_broken = true;
814 n2++;
815 end2 = !vtable->iterate_reference (n2, ref2);
817 while (!end1
818 && (end2
819 || (methods_equal_p (ref2->referred->decl, ref1->referred->decl)
820 && TREE_CODE (ref2->referred->decl) == FUNCTION_DECL))
821 && TREE_CODE (ref1->referred->decl) != FUNCTION_DECL)
823 n1++;
824 end1 = !prevailing->iterate_reference (n1, ref1);
827 /* Finished? */
828 if (end1 && end2)
830 /* Extra paranoia; compare the sizes. We do not have information
831 about virtual inheritance offsets, so just be sure that these
832 match.
833 Do this as very last check so the not very informative error
834 is not output too often. */
835 if (DECL_SIZE (prevailing->decl) != DECL_SIZE (vtable->decl))
837 class_type->odr_violated = true;
838 auto_diagnostic_group d;
839 if (warning_at (DECL_SOURCE_LOCATION
840 (TYPE_NAME (DECL_CONTEXT (vtable->decl))),
841 OPT_Wodr,
842 "virtual table of type %qD violates "
843 "one definition rule ",
844 DECL_CONTEXT (vtable->decl)))
846 inform (DECL_SOURCE_LOCATION
847 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
848 "the conflicting type defined in another translation "
849 "unit has virtual table of different size");
852 return;
855 if (!end1 && !end2)
857 if (methods_equal_p (ref1->referred->decl, ref2->referred->decl))
858 continue;
860 class_type->odr_violated = true;
862 /* If the loops above stopped on non-virtual pointer, we have
863 mismatch in RTTI information mangling. */
864 if (TREE_CODE (ref1->referred->decl) != FUNCTION_DECL
865 && TREE_CODE (ref2->referred->decl) != FUNCTION_DECL)
867 auto_diagnostic_group d;
868 if (warning_at (DECL_SOURCE_LOCATION
869 (TYPE_NAME (DECL_CONTEXT (vtable->decl))),
870 OPT_Wodr,
871 "virtual table of type %qD violates "
872 "one definition rule ",
873 DECL_CONTEXT (vtable->decl)))
875 inform (DECL_SOURCE_LOCATION
876 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
877 "the conflicting type defined in another translation "
878 "unit with different RTTI information");
880 return;
882 /* At this point both REF1 and REF2 points either to virtual table
883 or virtual method. If one points to virtual table and other to
884 method we can complain the same way as if one table was shorter
885 than other pointing out the extra method. */
886 if (TREE_CODE (ref1->referred->decl)
887 != TREE_CODE (ref2->referred->decl))
889 if (VAR_P (ref1->referred->decl))
890 end1 = true;
891 else if (VAR_P (ref2->referred->decl))
892 end2 = true;
896 class_type->odr_violated = true;
898 /* Complain about size mismatch. Either we have too many virutal
899 functions or too many virtual table pointers. */
900 if (end1 || end2)
902 if (end1)
904 varpool_node *tmp = prevailing;
905 prevailing = vtable;
906 vtable = tmp;
907 ref1 = ref2;
909 auto_diagnostic_group d;
910 if (warning_at (DECL_SOURCE_LOCATION
911 (TYPE_NAME (DECL_CONTEXT (vtable->decl))),
912 OPT_Wodr,
913 "virtual table of type %qD violates "
914 "one definition rule",
915 DECL_CONTEXT (vtable->decl)))
917 if (TREE_CODE (ref1->referring->decl) == FUNCTION_DECL)
919 inform (DECL_SOURCE_LOCATION
920 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
921 "the conflicting type defined in another translation "
922 "unit");
923 inform (DECL_SOURCE_LOCATION
924 (TYPE_NAME (DECL_CONTEXT (ref1->referring->decl))),
925 "contains additional virtual method %qD",
926 ref1->referred->decl);
928 else
930 inform (DECL_SOURCE_LOCATION
931 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
932 "the conflicting type defined in another translation "
933 "unit has virtual table with more entries");
936 return;
939 /* And in the last case we have either mistmatch in between two virtual
940 methods or two virtual table pointers. */
941 auto_diagnostic_group d;
942 if (warning_at (DECL_SOURCE_LOCATION
943 (TYPE_NAME (DECL_CONTEXT (vtable->decl))), OPT_Wodr,
944 "virtual table of type %qD violates "
945 "one definition rule ",
946 DECL_CONTEXT (vtable->decl)))
948 if (TREE_CODE (ref1->referred->decl) == FUNCTION_DECL)
950 inform (DECL_SOURCE_LOCATION
951 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
952 "the conflicting type defined in another translation "
953 "unit");
954 gcc_assert (TREE_CODE (ref2->referred->decl)
955 == FUNCTION_DECL);
956 inform (DECL_SOURCE_LOCATION
957 (ref1->referred->ultimate_alias_target ()->decl),
958 "virtual method %qD",
959 ref1->referred->ultimate_alias_target ()->decl);
960 inform (DECL_SOURCE_LOCATION
961 (ref2->referred->ultimate_alias_target ()->decl),
962 "ought to match virtual method %qD but does not",
963 ref2->referred->ultimate_alias_target ()->decl);
965 else
966 inform (DECL_SOURCE_LOCATION
967 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
968 "the conflicting type defined in another translation "
969 "unit has virtual table with different contents");
970 return;
975 /* Output ODR violation warning about T1 and T2 with REASON.
976 Display location of ST1 and ST2 if REASON speaks about field or
977 method of the type.
978 If WARN is false, do nothing. Set WARNED if warning was indeed
979 output. */
981 void
982 warn_odr (tree t1, tree t2, tree st1, tree st2,
983 bool warn, bool *warned, const char *reason)
985 tree decl2 = TYPE_NAME (t2);
986 if (warned)
987 *warned = false;
989 if (!warn || !TYPE_NAME(t1))
990 return;
992 /* ODR warnings are output druing LTO streaming; we must apply location
993 cache for potential warnings to be output correctly. */
994 if (lto_location_cache::current_cache)
995 lto_location_cache::current_cache->apply_location_cache ();
997 auto_diagnostic_group d;
998 if (!warning_at (DECL_SOURCE_LOCATION (TYPE_NAME (t1)), OPT_Wodr,
999 "type %qT violates the C++ One Definition Rule",
1000 t1))
1001 return;
1002 if (!st1 && !st2)
1004 /* For FIELD_DECL support also case where one of fields is
1005 NULL - this is used when the structures have mismatching number of
1006 elements. */
1007 else if (!st1 || TREE_CODE (st1) == FIELD_DECL)
1009 inform (DECL_SOURCE_LOCATION (decl2),
1010 "a different type is defined in another translation unit");
1011 if (!st1)
1013 st1 = st2;
1014 st2 = NULL;
1016 inform (DECL_SOURCE_LOCATION (st1),
1017 "the first difference of corresponding definitions is field %qD",
1018 st1);
1019 if (st2)
1020 decl2 = st2;
1022 else if (TREE_CODE (st1) == FUNCTION_DECL)
1024 inform (DECL_SOURCE_LOCATION (decl2),
1025 "a different type is defined in another translation unit");
1026 inform (DECL_SOURCE_LOCATION (st1),
1027 "the first difference of corresponding definitions is method %qD",
1028 st1);
1029 decl2 = st2;
1031 else
1032 return;
1033 inform (DECL_SOURCE_LOCATION (decl2), reason);
1035 if (warned)
1036 *warned = true;
1039 /* Return ture if T1 and T2 are incompatible and we want to recusively
1040 dive into them from warn_type_mismatch to give sensible answer. */
1042 static bool
1043 type_mismatch_p (tree t1, tree t2)
1045 if (odr_or_derived_type_p (t1) && odr_or_derived_type_p (t2)
1046 && !odr_types_equivalent_p (t1, t2))
1047 return true;
1048 return !types_compatible_p (t1, t2);
1052 /* Types T1 and T2 was found to be incompatible in a context they can't
1053 (either used to declare a symbol of same assembler name or unified by
1054 ODR rule). We already output warning about this, but if possible, output
1055 extra information on how the types mismatch.
1057 This is hard to do in general. We basically handle the common cases.
1059 If LOC1 and LOC2 are meaningful locations, use it in the case the types
1060 themselves do no thave one.*/
1062 void
1063 warn_types_mismatch (tree t1, tree t2, location_t loc1, location_t loc2)
1065 /* Location of type is known only if it has TYPE_NAME and the name is
1066 TYPE_DECL. */
1067 location_t loc_t1 = TYPE_NAME (t1) && TREE_CODE (TYPE_NAME (t1)) == TYPE_DECL
1068 ? DECL_SOURCE_LOCATION (TYPE_NAME (t1))
1069 : UNKNOWN_LOCATION;
1070 location_t loc_t2 = TYPE_NAME (t2) && TREE_CODE (TYPE_NAME (t2)) == TYPE_DECL
1071 ? DECL_SOURCE_LOCATION (TYPE_NAME (t2))
1072 : UNKNOWN_LOCATION;
1073 bool loc_t2_useful = false;
1075 /* With LTO it is a common case that the location of both types match.
1076 See if T2 has a location that is different from T1. If so, we will
1077 inform user about the location.
1078 Do not consider the location passed to us in LOC1/LOC2 as those are
1079 already output. */
1080 if (loc_t2 > BUILTINS_LOCATION && loc_t2 != loc_t1)
1082 if (loc_t1 <= BUILTINS_LOCATION)
1083 loc_t2_useful = true;
1084 else
1086 expanded_location xloc1 = expand_location (loc_t1);
1087 expanded_location xloc2 = expand_location (loc_t2);
1089 if (strcmp (xloc1.file, xloc2.file)
1090 || xloc1.line != xloc2.line
1091 || xloc1.column != xloc2.column)
1092 loc_t2_useful = true;
1096 if (loc_t1 <= BUILTINS_LOCATION)
1097 loc_t1 = loc1;
1098 if (loc_t2 <= BUILTINS_LOCATION)
1099 loc_t2 = loc2;
1101 location_t loc = loc_t1 <= BUILTINS_LOCATION ? loc_t2 : loc_t1;
1103 /* It is a quite common bug to reference anonymous namespace type in
1104 non-anonymous namespace class. */
1105 if ((type_with_linkage_p (t1) && type_in_anonymous_namespace_p (t1))
1106 || (type_with_linkage_p (t2) && type_in_anonymous_namespace_p (t2)))
1108 if (type_with_linkage_p (t1) && !type_in_anonymous_namespace_p (t1))
1110 std::swap (t1, t2);
1111 std::swap (loc_t1, loc_t2);
1113 gcc_assert (TYPE_NAME (t1) && TYPE_NAME (t2)
1114 && TREE_CODE (TYPE_NAME (t1)) == TYPE_DECL
1115 && TREE_CODE (TYPE_NAME (t2)) == TYPE_DECL);
1116 /* Most of the time, the type names will match, do not be unnecesarily
1117 verbose. */
1118 if (IDENTIFIER_POINTER (DECL_NAME (TYPE_NAME (t1)))
1119 != IDENTIFIER_POINTER (DECL_NAME (TYPE_NAME (t2))))
1120 inform (loc_t1,
1121 "type %qT defined in anonymous namespace can not match "
1122 "type %qT across the translation unit boundary",
1123 t1, t2);
1124 else
1125 inform (loc_t1,
1126 "type %qT defined in anonymous namespace can not match "
1127 "across the translation unit boundary",
1128 t1);
1129 if (loc_t2_useful)
1130 inform (loc_t2,
1131 "the incompatible type defined in another translation unit");
1132 return;
1134 /* If types have mangled ODR names and they are different, it is most
1135 informative to output those.
1136 This also covers types defined in different namespaces. */
1137 if (TYPE_NAME (t1) && TYPE_NAME (t2)
1138 && TREE_CODE (TYPE_NAME (t1)) == TYPE_DECL
1139 && TREE_CODE (TYPE_NAME (t2)) == TYPE_DECL
1140 && DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t1))
1141 && DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t2))
1142 && DECL_ASSEMBLER_NAME (TYPE_NAME (t1))
1143 != DECL_ASSEMBLER_NAME (TYPE_NAME (t2)))
1145 char *name1 = xstrdup (cplus_demangle
1146 (IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (TYPE_NAME (t1))),
1147 DMGL_PARAMS | DMGL_ANSI | DMGL_TYPES));
1148 char *name2 = cplus_demangle
1149 (IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (TYPE_NAME (t2))),
1150 DMGL_PARAMS | DMGL_ANSI | DMGL_TYPES);
1151 if (name1 && name2 && strcmp (name1, name2))
1153 inform (loc_t1,
1154 "type name %qs should match type name %qs",
1155 name1, name2);
1156 if (loc_t2_useful)
1157 inform (loc_t2,
1158 "the incompatible type is defined here");
1159 free (name1);
1160 return;
1162 free (name1);
1164 /* A tricky case are compound types. Often they appear the same in source
1165 code and the mismatch is dragged in by type they are build from.
1166 Look for those differences in subtypes and try to be informative. In other
1167 cases just output nothing because the source code is probably different
1168 and in this case we already output a all necessary info. */
1169 if (!TYPE_NAME (t1) || !TYPE_NAME (t2))
1171 if (TREE_CODE (t1) == TREE_CODE (t2))
1173 if (TREE_CODE (t1) == ARRAY_TYPE
1174 && COMPLETE_TYPE_P (t1) && COMPLETE_TYPE_P (t2))
1176 tree i1 = TYPE_DOMAIN (t1);
1177 tree i2 = TYPE_DOMAIN (t2);
1179 if (i1 && i2
1180 && TYPE_MAX_VALUE (i1)
1181 && TYPE_MAX_VALUE (i2)
1182 && !operand_equal_p (TYPE_MAX_VALUE (i1),
1183 TYPE_MAX_VALUE (i2), 0))
1185 inform (loc,
1186 "array types have different bounds");
1187 return;
1190 if ((POINTER_TYPE_P (t1) || TREE_CODE (t1) == ARRAY_TYPE)
1191 && type_mismatch_p (TREE_TYPE (t1), TREE_TYPE (t2)))
1192 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2), loc_t1, loc_t2);
1193 else if (TREE_CODE (t1) == METHOD_TYPE
1194 || TREE_CODE (t1) == FUNCTION_TYPE)
1196 tree parms1 = NULL, parms2 = NULL;
1197 int count = 1;
1199 if (type_mismatch_p (TREE_TYPE (t1), TREE_TYPE (t2)))
1201 inform (loc, "return value type mismatch");
1202 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2), loc_t1,
1203 loc_t2);
1204 return;
1206 if (prototype_p (t1) && prototype_p (t2))
1207 for (parms1 = TYPE_ARG_TYPES (t1), parms2 = TYPE_ARG_TYPES (t2);
1208 parms1 && parms2;
1209 parms1 = TREE_CHAIN (parms1), parms2 = TREE_CHAIN (parms2),
1210 count++)
1212 if (type_mismatch_p (TREE_VALUE (parms1), TREE_VALUE (parms2)))
1214 if (count == 1 && TREE_CODE (t1) == METHOD_TYPE)
1215 inform (loc,
1216 "implicit this pointer type mismatch");
1217 else
1218 inform (loc,
1219 "type mismatch in parameter %i",
1220 count - (TREE_CODE (t1) == METHOD_TYPE));
1221 warn_types_mismatch (TREE_VALUE (parms1),
1222 TREE_VALUE (parms2),
1223 loc_t1, loc_t2);
1224 return;
1227 if (parms1 || parms2)
1229 inform (loc,
1230 "types have different parameter counts");
1231 return;
1235 return;
1238 if (types_odr_comparable (t1, t2, true)
1239 && types_same_for_odr (t1, t2, true))
1240 inform (loc_t1,
1241 "type %qT itself violates the C++ One Definition Rule", t1);
1242 /* Prevent pointless warnings like "struct aa" should match "struct aa". */
1243 else if (TYPE_NAME (t1) == TYPE_NAME (t2)
1244 && TREE_CODE (t1) == TREE_CODE (t2) && !loc_t2_useful)
1245 return;
1246 else
1247 inform (loc_t1, "type %qT should match type %qT",
1248 t1, t2);
1249 if (loc_t2_useful)
1250 inform (loc_t2, "the incompatible type is defined here");
1253 /* Compare T1 and T2, report ODR violations if WARN is true and set
1254 WARNED to true if anything is reported. Return true if types match.
1255 If true is returned, the types are also compatible in the sense of
1256 gimple_canonical_types_compatible_p.
1257 If LOC1 and LOC2 is not UNKNOWN_LOCATION it may be used to output a warning
1258 about the type if the type itself do not have location. */
1260 static bool
1261 odr_types_equivalent_p (tree t1, tree t2, bool warn, bool *warned,
1262 hash_set<type_pair> *visited,
1263 location_t loc1, location_t loc2)
1265 /* Check first for the obvious case of pointer identity. */
1266 if (t1 == t2)
1267 return true;
1268 gcc_assert (!type_with_linkage_p (t1) || !type_in_anonymous_namespace_p (t1));
1269 gcc_assert (!type_with_linkage_p (t2) || !type_in_anonymous_namespace_p (t2));
1271 /* Can't be the same type if the types don't have the same code. */
1272 if (TREE_CODE (t1) != TREE_CODE (t2))
1274 warn_odr (t1, t2, NULL, NULL, warn, warned,
1275 G_("a different type is defined in another translation unit"));
1276 return false;
1279 if (TYPE_QUALS (t1) != TYPE_QUALS (t2))
1281 warn_odr (t1, t2, NULL, NULL, warn, warned,
1282 G_("a type with different qualifiers is defined in another "
1283 "translation unit"));
1284 return false;
1287 if ((type_with_linkage_p (t1) && type_in_anonymous_namespace_p (t1))
1288 || (type_with_linkage_p (t2) && type_in_anonymous_namespace_p (t2)))
1290 /* We can not trip this when comparing ODR types, only when trying to
1291 match different ODR derivations from different declarations.
1292 So WARN should be always false. */
1293 gcc_assert (!warn);
1294 return false;
1297 if (comp_type_attributes (t1, t2) != 1)
1299 warn_odr (t1, t2, NULL, NULL, warn, warned,
1300 G_("a type with different attributes "
1301 "is defined in another translation unit"));
1302 return false;
1305 if (TREE_CODE (t1) == ENUMERAL_TYPE
1306 && TYPE_VALUES (t1) && TYPE_VALUES (t2))
1308 tree v1, v2;
1309 for (v1 = TYPE_VALUES (t1), v2 = TYPE_VALUES (t2);
1310 v1 && v2 ; v1 = TREE_CHAIN (v1), v2 = TREE_CHAIN (v2))
1312 if (TREE_PURPOSE (v1) != TREE_PURPOSE (v2))
1314 warn_odr (t1, t2, NULL, NULL, warn, warned,
1315 G_("an enum with different value name"
1316 " is defined in another translation unit"));
1317 return false;
1319 if (TREE_VALUE (v1) != TREE_VALUE (v2)
1320 && !operand_equal_p (DECL_INITIAL (TREE_VALUE (v1)),
1321 DECL_INITIAL (TREE_VALUE (v2)), 0))
1323 warn_odr (t1, t2, NULL, NULL, warn, warned,
1324 G_("an enum with different values is defined"
1325 " in another translation unit"));
1326 return false;
1329 if (v1 || v2)
1331 warn_odr (t1, t2, NULL, NULL, warn, warned,
1332 G_("an enum with mismatching number of values "
1333 "is defined in another translation unit"));
1334 return false;
1338 /* Non-aggregate types can be handled cheaply. */
1339 if (INTEGRAL_TYPE_P (t1)
1340 || SCALAR_FLOAT_TYPE_P (t1)
1341 || FIXED_POINT_TYPE_P (t1)
1342 || TREE_CODE (t1) == VECTOR_TYPE
1343 || TREE_CODE (t1) == COMPLEX_TYPE
1344 || TREE_CODE (t1) == OFFSET_TYPE
1345 || POINTER_TYPE_P (t1))
1347 if (TYPE_PRECISION (t1) != TYPE_PRECISION (t2))
1349 warn_odr (t1, t2, NULL, NULL, warn, warned,
1350 G_("a type with different precision is defined "
1351 "in another translation unit"));
1352 return false;
1354 if (TYPE_UNSIGNED (t1) != TYPE_UNSIGNED (t2))
1356 warn_odr (t1, t2, NULL, NULL, warn, warned,
1357 G_("a type with different signedness is defined "
1358 "in another translation unit"));
1359 return false;
1362 if (TREE_CODE (t1) == INTEGER_TYPE
1363 && TYPE_STRING_FLAG (t1) != TYPE_STRING_FLAG (t2))
1365 /* char WRT uint_8? */
1366 warn_odr (t1, t2, NULL, NULL, warn, warned,
1367 G_("a different type is defined in another "
1368 "translation unit"));
1369 return false;
1372 /* For canonical type comparisons we do not want to build SCCs
1373 so we cannot compare pointed-to types. But we can, for now,
1374 require the same pointed-to type kind and match what
1375 useless_type_conversion_p would do. */
1376 if (POINTER_TYPE_P (t1))
1378 if (TYPE_ADDR_SPACE (TREE_TYPE (t1))
1379 != TYPE_ADDR_SPACE (TREE_TYPE (t2)))
1381 warn_odr (t1, t2, NULL, NULL, warn, warned,
1382 G_("it is defined as a pointer in different address "
1383 "space in another translation unit"));
1384 return false;
1387 if (!odr_subtypes_equivalent_p (TREE_TYPE (t1), TREE_TYPE (t2),
1388 visited, loc1, loc2))
1390 warn_odr (t1, t2, NULL, NULL, warn, warned,
1391 G_("it is defined as a pointer to different type "
1392 "in another translation unit"));
1393 if (warn && warned)
1394 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2),
1395 loc1, loc2);
1396 return false;
1400 if ((TREE_CODE (t1) == VECTOR_TYPE || TREE_CODE (t1) == COMPLEX_TYPE)
1401 && !odr_subtypes_equivalent_p (TREE_TYPE (t1), TREE_TYPE (t2),
1402 visited, loc1, loc2))
1404 /* Probably specific enough. */
1405 warn_odr (t1, t2, NULL, NULL, warn, warned,
1406 G_("a different type is defined "
1407 "in another translation unit"));
1408 if (warn && warned)
1409 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2), loc1, loc2);
1410 return false;
1413 /* Do type-specific comparisons. */
1414 else switch (TREE_CODE (t1))
1416 case ARRAY_TYPE:
1418 /* Array types are the same if the element types are the same and
1419 the number of elements are the same. */
1420 if (!odr_subtypes_equivalent_p (TREE_TYPE (t1), TREE_TYPE (t2),
1421 visited, loc1, loc2))
1423 warn_odr (t1, t2, NULL, NULL, warn, warned,
1424 G_("a different type is defined in another "
1425 "translation unit"));
1426 if (warn && warned)
1427 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2), loc1, loc2);
1429 gcc_assert (TYPE_STRING_FLAG (t1) == TYPE_STRING_FLAG (t2));
1430 gcc_assert (TYPE_NONALIASED_COMPONENT (t1)
1431 == TYPE_NONALIASED_COMPONENT (t2));
1433 tree i1 = TYPE_DOMAIN (t1);
1434 tree i2 = TYPE_DOMAIN (t2);
1436 /* For an incomplete external array, the type domain can be
1437 NULL_TREE. Check this condition also. */
1438 if (i1 == NULL_TREE || i2 == NULL_TREE)
1439 return true;
1441 tree min1 = TYPE_MIN_VALUE (i1);
1442 tree min2 = TYPE_MIN_VALUE (i2);
1443 tree max1 = TYPE_MAX_VALUE (i1);
1444 tree max2 = TYPE_MAX_VALUE (i2);
1446 /* In C++, minimums should be always 0. */
1447 gcc_assert (min1 == min2);
1448 if (!operand_equal_p (max1, max2, 0))
1450 warn_odr (t1, t2, NULL, NULL, warn, warned,
1451 G_("an array of different size is defined "
1452 "in another translation unit"));
1453 return false;
1456 break;
1458 case METHOD_TYPE:
1459 case FUNCTION_TYPE:
1460 /* Function types are the same if the return type and arguments types
1461 are the same. */
1462 if (!odr_subtypes_equivalent_p (TREE_TYPE (t1), TREE_TYPE (t2),
1463 visited, loc1, loc2))
1465 warn_odr (t1, t2, NULL, NULL, warn, warned,
1466 G_("has different return value "
1467 "in another translation unit"));
1468 if (warn && warned)
1469 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2), loc1, loc2);
1470 return false;
1473 if (TYPE_ARG_TYPES (t1) == TYPE_ARG_TYPES (t2)
1474 || !prototype_p (t1) || !prototype_p (t2))
1475 return true;
1476 else
1478 tree parms1, parms2;
1480 for (parms1 = TYPE_ARG_TYPES (t1), parms2 = TYPE_ARG_TYPES (t2);
1481 parms1 && parms2;
1482 parms1 = TREE_CHAIN (parms1), parms2 = TREE_CHAIN (parms2))
1484 if (!odr_subtypes_equivalent_p
1485 (TREE_VALUE (parms1), TREE_VALUE (parms2), visited,
1486 loc1, loc2))
1488 warn_odr (t1, t2, NULL, NULL, warn, warned,
1489 G_("has different parameters in another "
1490 "translation unit"));
1491 if (warn && warned)
1492 warn_types_mismatch (TREE_VALUE (parms1),
1493 TREE_VALUE (parms2), loc1, loc2);
1494 return false;
1498 if (parms1 || parms2)
1500 warn_odr (t1, t2, NULL, NULL, warn, warned,
1501 G_("has different parameters "
1502 "in another translation unit"));
1503 return false;
1506 return true;
1509 case RECORD_TYPE:
1510 case UNION_TYPE:
1511 case QUAL_UNION_TYPE:
1513 tree f1, f2;
1515 /* For aggregate types, all the fields must be the same. */
1516 if (COMPLETE_TYPE_P (t1) && COMPLETE_TYPE_P (t2))
1518 if (TYPE_BINFO (t1) && TYPE_BINFO (t2)
1519 && polymorphic_type_binfo_p (TYPE_BINFO (t1))
1520 != polymorphic_type_binfo_p (TYPE_BINFO (t2)))
1522 if (polymorphic_type_binfo_p (TYPE_BINFO (t1)))
1523 warn_odr (t1, t2, NULL, NULL, warn, warned,
1524 G_("a type defined in another translation unit "
1525 "is not polymorphic"));
1526 else
1527 warn_odr (t1, t2, NULL, NULL, warn, warned,
1528 G_("a type defined in another translation unit "
1529 "is polymorphic"));
1530 return false;
1532 for (f1 = TYPE_FIELDS (t1), f2 = TYPE_FIELDS (t2);
1533 f1 || f2;
1534 f1 = TREE_CHAIN (f1), f2 = TREE_CHAIN (f2))
1536 /* Skip non-fields. */
1537 while (f1 && TREE_CODE (f1) != FIELD_DECL)
1538 f1 = TREE_CHAIN (f1);
1539 while (f2 && TREE_CODE (f2) != FIELD_DECL)
1540 f2 = TREE_CHAIN (f2);
1541 if (!f1 || !f2)
1542 break;
1543 if (DECL_VIRTUAL_P (f1) != DECL_VIRTUAL_P (f2))
1545 warn_odr (t1, t2, NULL, NULL, warn, warned,
1546 G_("a type with different virtual table pointers"
1547 " is defined in another translation unit"));
1548 return false;
1550 if (DECL_ARTIFICIAL (f1) != DECL_ARTIFICIAL (f2))
1552 warn_odr (t1, t2, NULL, NULL, warn, warned,
1553 G_("a type with different bases is defined "
1554 "in another translation unit"));
1555 return false;
1557 if (DECL_NAME (f1) != DECL_NAME (f2)
1558 && !DECL_ARTIFICIAL (f1))
1560 warn_odr (t1, t2, f1, f2, warn, warned,
1561 G_("a field with different name is defined "
1562 "in another translation unit"));
1563 return false;
1565 if (!odr_subtypes_equivalent_p (TREE_TYPE (f1),
1566 TREE_TYPE (f2), visited,
1567 loc1, loc2))
1569 /* Do not warn about artificial fields and just go into
1570 generic field mismatch warning. */
1571 if (DECL_ARTIFICIAL (f1))
1572 break;
1574 warn_odr (t1, t2, f1, f2, warn, warned,
1575 G_("a field of same name but different type "
1576 "is defined in another translation unit"));
1577 if (warn && warned)
1578 warn_types_mismatch (TREE_TYPE (f1), TREE_TYPE (f2), loc1, loc2);
1579 return false;
1581 if (!gimple_compare_field_offset (f1, f2))
1583 /* Do not warn about artificial fields and just go into
1584 generic field mismatch warning. */
1585 if (DECL_ARTIFICIAL (f1))
1586 break;
1587 warn_odr (t1, t2, f1, f2, warn, warned,
1588 G_("fields have different layout "
1589 "in another translation unit"));
1590 return false;
1592 if (DECL_BIT_FIELD (f1) != DECL_BIT_FIELD (f2))
1594 warn_odr (t1, t2, f1, f2, warn, warned,
1595 G_("one field is bitfield while other is not"));
1596 return false;
1598 else
1599 gcc_assert (DECL_NONADDRESSABLE_P (f1)
1600 == DECL_NONADDRESSABLE_P (f2));
1603 /* If one aggregate has more fields than the other, they
1604 are not the same. */
1605 if (f1 || f2)
1607 if ((f1 && DECL_VIRTUAL_P (f1)) || (f2 && DECL_VIRTUAL_P (f2)))
1608 warn_odr (t1, t2, NULL, NULL, warn, warned,
1609 G_("a type with different virtual table pointers"
1610 " is defined in another translation unit"));
1611 else if ((f1 && DECL_ARTIFICIAL (f1))
1612 || (f2 && DECL_ARTIFICIAL (f2)))
1613 warn_odr (t1, t2, NULL, NULL, warn, warned,
1614 G_("a type with different bases is defined "
1615 "in another translation unit"));
1616 else
1617 warn_odr (t1, t2, f1, f2, warn, warned,
1618 G_("a type with different number of fields "
1619 "is defined in another translation unit"));
1621 return false;
1624 break;
1626 case VOID_TYPE:
1627 case NULLPTR_TYPE:
1628 break;
1630 default:
1631 debug_tree (t1);
1632 gcc_unreachable ();
1635 /* Those are better to come last as they are utterly uninformative. */
1636 if (TYPE_SIZE (t1) && TYPE_SIZE (t2)
1637 && !operand_equal_p (TYPE_SIZE (t1), TYPE_SIZE (t2), 0))
1639 warn_odr (t1, t2, NULL, NULL, warn, warned,
1640 G_("a type with different size "
1641 "is defined in another translation unit"));
1642 return false;
1644 if (COMPLETE_TYPE_P (t1) && COMPLETE_TYPE_P (t2)
1645 && TYPE_ALIGN (t1) != TYPE_ALIGN (t2))
1647 warn_odr (t1, t2, NULL, NULL, warn, warned,
1648 G_("a type with different alignment "
1649 "is defined in another translation unit"));
1650 return false;
1652 gcc_assert (!TYPE_SIZE_UNIT (t1) || !TYPE_SIZE_UNIT (t2)
1653 || operand_equal_p (TYPE_SIZE_UNIT (t1),
1654 TYPE_SIZE_UNIT (t2), 0));
1655 return true;
1658 /* Return true if TYPE1 and TYPE2 are equivalent for One Definition Rule. */
1660 bool
1661 odr_types_equivalent_p (tree type1, tree type2)
1663 gcc_checking_assert (odr_or_derived_type_p (type1)
1664 && odr_or_derived_type_p (type2));
1666 hash_set<type_pair> visited;
1667 return odr_types_equivalent_p (type1, type2, false, NULL,
1668 &visited, UNKNOWN_LOCATION, UNKNOWN_LOCATION);
1671 /* TYPE is equivalent to VAL by ODR, but its tree representation differs
1672 from VAL->type. This may happen in LTO where tree merging did not merge
1673 all variants of the same type or due to ODR violation.
1675 Analyze and report ODR violations and add type to duplicate list.
1676 If TYPE is more specified than VAL->type, prevail VAL->type. Also if
1677 this is first time we see definition of a class return true so the
1678 base types are analyzed. */
1680 static bool
1681 add_type_duplicate (odr_type val, tree type)
1683 bool build_bases = false;
1684 bool prevail = false;
1685 bool odr_must_violate = false;
1687 if (!val->types_set)
1688 val->types_set = new hash_set<tree>;
1690 /* Chose polymorphic type as leader (this happens only in case of ODR
1691 violations. */
1692 if ((TREE_CODE (type) == RECORD_TYPE && TYPE_BINFO (type)
1693 && polymorphic_type_binfo_p (TYPE_BINFO (type)))
1694 && (TREE_CODE (val->type) != RECORD_TYPE || !TYPE_BINFO (val->type)
1695 || !polymorphic_type_binfo_p (TYPE_BINFO (val->type))))
1697 prevail = true;
1698 build_bases = true;
1700 /* Always prefer complete type to be the leader. */
1701 else if (!COMPLETE_TYPE_P (val->type) && COMPLETE_TYPE_P (type))
1703 prevail = true;
1704 build_bases = TYPE_BINFO (type);
1706 else if (COMPLETE_TYPE_P (val->type) && !COMPLETE_TYPE_P (type))
1708 else if (TREE_CODE (val->type) == ENUMERAL_TYPE
1709 && TREE_CODE (type) == ENUMERAL_TYPE
1710 && !TYPE_VALUES (val->type) && TYPE_VALUES (type))
1711 prevail = true;
1712 else if (TREE_CODE (val->type) == RECORD_TYPE
1713 && TREE_CODE (type) == RECORD_TYPE
1714 && TYPE_BINFO (type) && !TYPE_BINFO (val->type))
1716 gcc_assert (!val->bases.length ());
1717 build_bases = true;
1718 prevail = true;
1721 if (prevail)
1722 std::swap (val->type, type);
1724 val->types_set->add (type);
1726 /* If we now have a mangled name, be sure to record it to val->type
1727 so ODR hash can work. */
1729 if (can_be_name_hashed_p (type) && !can_be_name_hashed_p (val->type))
1730 SET_DECL_ASSEMBLER_NAME (TYPE_NAME (val->type),
1731 DECL_ASSEMBLER_NAME (TYPE_NAME (type)));
1733 bool merge = true;
1734 bool base_mismatch = false;
1735 unsigned int i;
1736 bool warned = false;
1737 hash_set<type_pair> visited;
1739 gcc_assert (in_lto_p);
1740 vec_safe_push (val->types, type);
1742 /* If both are class types, compare the bases. */
1743 if (COMPLETE_TYPE_P (type) && COMPLETE_TYPE_P (val->type)
1744 && TREE_CODE (val->type) == RECORD_TYPE
1745 && TREE_CODE (type) == RECORD_TYPE
1746 && TYPE_BINFO (val->type) && TYPE_BINFO (type))
1748 if (BINFO_N_BASE_BINFOS (TYPE_BINFO (type))
1749 != BINFO_N_BASE_BINFOS (TYPE_BINFO (val->type)))
1751 if (!flag_ltrans && !warned && !val->odr_violated)
1753 tree extra_base;
1754 warn_odr (type, val->type, NULL, NULL, !warned, &warned,
1755 "a type with the same name but different "
1756 "number of polymorphic bases is "
1757 "defined in another translation unit");
1758 if (warned)
1760 if (BINFO_N_BASE_BINFOS (TYPE_BINFO (type))
1761 > BINFO_N_BASE_BINFOS (TYPE_BINFO (val->type)))
1762 extra_base = BINFO_BASE_BINFO
1763 (TYPE_BINFO (type),
1764 BINFO_N_BASE_BINFOS (TYPE_BINFO (val->type)));
1765 else
1766 extra_base = BINFO_BASE_BINFO
1767 (TYPE_BINFO (val->type),
1768 BINFO_N_BASE_BINFOS (TYPE_BINFO (type)));
1769 tree extra_base_type = BINFO_TYPE (extra_base);
1770 inform (DECL_SOURCE_LOCATION (TYPE_NAME (extra_base_type)),
1771 "the extra base is defined here");
1774 base_mismatch = true;
1776 else
1777 for (i = 0; i < BINFO_N_BASE_BINFOS (TYPE_BINFO (type)); i++)
1779 tree base1 = BINFO_BASE_BINFO (TYPE_BINFO (type), i);
1780 tree base2 = BINFO_BASE_BINFO (TYPE_BINFO (val->type), i);
1781 tree type1 = BINFO_TYPE (base1);
1782 tree type2 = BINFO_TYPE (base2);
1784 if (types_odr_comparable (type1, type2))
1786 if (!types_same_for_odr (type1, type2))
1787 base_mismatch = true;
1789 else
1790 if (!odr_types_equivalent_p (type1, type2))
1791 base_mismatch = true;
1792 if (base_mismatch)
1794 if (!warned && !val->odr_violated)
1796 warn_odr (type, val->type, NULL, NULL,
1797 !warned, &warned,
1798 "a type with the same name but different base "
1799 "type is defined in another translation unit");
1800 if (warned)
1801 warn_types_mismatch (type1, type2,
1802 UNKNOWN_LOCATION, UNKNOWN_LOCATION);
1804 break;
1806 if (BINFO_OFFSET (base1) != BINFO_OFFSET (base2))
1808 base_mismatch = true;
1809 if (!warned && !val->odr_violated)
1810 warn_odr (type, val->type, NULL, NULL,
1811 !warned, &warned,
1812 "a type with the same name but different base "
1813 "layout is defined in another translation unit");
1814 break;
1816 /* One of bases is not of complete type. */
1817 if (!TYPE_BINFO (type1) != !TYPE_BINFO (type2))
1819 /* If we have a polymorphic type info specified for TYPE1
1820 but not for TYPE2 we possibly missed a base when recording
1821 VAL->type earlier.
1822 Be sure this does not happen. */
1823 if (TYPE_BINFO (type1)
1824 && polymorphic_type_binfo_p (TYPE_BINFO (type1))
1825 && !build_bases)
1826 odr_must_violate = true;
1827 break;
1829 /* One base is polymorphic and the other not.
1830 This ought to be diagnosed earlier, but do not ICE in the
1831 checking bellow. */
1832 else if (TYPE_BINFO (type1)
1833 && polymorphic_type_binfo_p (TYPE_BINFO (type1))
1834 != polymorphic_type_binfo_p (TYPE_BINFO (type2)))
1836 if (!warned && !val->odr_violated)
1837 warn_odr (type, val->type, NULL, NULL,
1838 !warned, &warned,
1839 "a base of the type is polymorphic only in one "
1840 "translation unit");
1841 base_mismatch = true;
1842 break;
1845 if (base_mismatch)
1847 merge = false;
1848 odr_violation_reported = true;
1849 val->odr_violated = true;
1851 if (symtab->dump_file)
1853 fprintf (symtab->dump_file, "ODR base violation\n");
1855 print_node (symtab->dump_file, "", val->type, 0);
1856 putc ('\n',symtab->dump_file);
1857 print_node (symtab->dump_file, "", type, 0);
1858 putc ('\n',symtab->dump_file);
1863 /* Next compare memory layout.
1864 The DECL_SOURCE_LOCATIONs in this invocation came from LTO streaming.
1865 We must apply the location cache to ensure that they are valid
1866 before we can pass them to odr_types_equivalent_p (PR lto/83121). */
1867 if (lto_location_cache::current_cache)
1868 lto_location_cache::current_cache->apply_location_cache ();
1869 if (!odr_types_equivalent_p (val->type, type,
1870 !flag_ltrans && !val->odr_violated && !warned,
1871 &warned, &visited,
1872 DECL_SOURCE_LOCATION (TYPE_NAME (val->type)),
1873 DECL_SOURCE_LOCATION (TYPE_NAME (type))))
1875 merge = false;
1876 odr_violation_reported = true;
1877 val->odr_violated = true;
1879 gcc_assert (val->odr_violated || !odr_must_violate);
1880 /* Sanity check that all bases will be build same way again. */
1881 if (flag_checking
1882 && COMPLETE_TYPE_P (type) && COMPLETE_TYPE_P (val->type)
1883 && TREE_CODE (val->type) == RECORD_TYPE
1884 && TREE_CODE (type) == RECORD_TYPE
1885 && TYPE_BINFO (val->type) && TYPE_BINFO (type)
1886 && !val->odr_violated
1887 && !base_mismatch && val->bases.length ())
1889 unsigned int num_poly_bases = 0;
1890 unsigned int j;
1892 for (i = 0; i < BINFO_N_BASE_BINFOS (TYPE_BINFO (type)); i++)
1893 if (polymorphic_type_binfo_p (BINFO_BASE_BINFO
1894 (TYPE_BINFO (type), i)))
1895 num_poly_bases++;
1896 gcc_assert (num_poly_bases == val->bases.length ());
1897 for (j = 0, i = 0; i < BINFO_N_BASE_BINFOS (TYPE_BINFO (type));
1898 i++)
1899 if (polymorphic_type_binfo_p (BINFO_BASE_BINFO
1900 (TYPE_BINFO (type), i)))
1902 odr_type base = get_odr_type
1903 (BINFO_TYPE
1904 (BINFO_BASE_BINFO (TYPE_BINFO (type),
1905 i)),
1906 true);
1907 gcc_assert (val->bases[j] == base);
1908 j++;
1913 /* Regularize things a little. During LTO same types may come with
1914 different BINFOs. Either because their virtual table was
1915 not merged by tree merging and only later at decl merging or
1916 because one type comes with external vtable, while other
1917 with internal. We want to merge equivalent binfos to conserve
1918 memory and streaming overhead.
1920 The external vtables are more harmful: they contain references
1921 to external declarations of methods that may be defined in the
1922 merged LTO unit. For this reason we absolutely need to remove
1923 them and replace by internal variants. Not doing so will lead
1924 to incomplete answers from possible_polymorphic_call_targets.
1926 FIXME: disable for now; because ODR types are now build during
1927 streaming in, the variants do not need to be linked to the type,
1928 yet. We need to do the merging in cleanup pass to be implemented
1929 soon. */
1930 if (!flag_ltrans && merge
1931 && 0
1932 && TREE_CODE (val->type) == RECORD_TYPE
1933 && TREE_CODE (type) == RECORD_TYPE
1934 && TYPE_BINFO (val->type) && TYPE_BINFO (type)
1935 && TYPE_MAIN_VARIANT (type) == type
1936 && TYPE_MAIN_VARIANT (val->type) == val->type
1937 && BINFO_VTABLE (TYPE_BINFO (val->type))
1938 && BINFO_VTABLE (TYPE_BINFO (type)))
1940 tree master_binfo = TYPE_BINFO (val->type);
1941 tree v1 = BINFO_VTABLE (master_binfo);
1942 tree v2 = BINFO_VTABLE (TYPE_BINFO (type));
1944 if (TREE_CODE (v1) == POINTER_PLUS_EXPR)
1946 gcc_assert (TREE_CODE (v2) == POINTER_PLUS_EXPR
1947 && operand_equal_p (TREE_OPERAND (v1, 1),
1948 TREE_OPERAND (v2, 1), 0));
1949 v1 = TREE_OPERAND (TREE_OPERAND (v1, 0), 0);
1950 v2 = TREE_OPERAND (TREE_OPERAND (v2, 0), 0);
1952 gcc_assert (DECL_ASSEMBLER_NAME (v1)
1953 == DECL_ASSEMBLER_NAME (v2));
1955 if (DECL_EXTERNAL (v1) && !DECL_EXTERNAL (v2))
1957 unsigned int i;
1959 set_type_binfo (val->type, TYPE_BINFO (type));
1960 for (i = 0; i < val->types->length (); i++)
1962 if (TYPE_BINFO ((*val->types)[i])
1963 == master_binfo)
1964 set_type_binfo ((*val->types)[i], TYPE_BINFO (type));
1966 BINFO_TYPE (TYPE_BINFO (type)) = val->type;
1968 else
1969 set_type_binfo (type, master_binfo);
1971 return build_bases;
1974 /* Get ODR type hash entry for TYPE. If INSERT is true, create
1975 possibly new entry. */
1977 odr_type
1978 get_odr_type (tree type, bool insert)
1980 odr_type_d **slot = NULL;
1981 odr_type_d **vtable_slot = NULL;
1982 odr_type val = NULL;
1983 hashval_t hash;
1984 bool build_bases = false;
1985 bool insert_to_odr_array = false;
1986 int base_id = -1;
1988 type = main_odr_variant (type);
1990 gcc_checking_assert (can_be_name_hashed_p (type)
1991 || can_be_vtable_hashed_p (type));
1993 /* Lookup entry, first try name hash, fallback to vtable hash. */
1994 if (can_be_name_hashed_p (type))
1996 hash = hash_odr_name (type);
1997 slot = odr_hash->find_slot_with_hash (type, hash,
1998 insert ? INSERT : NO_INSERT);
2000 if ((!slot || !*slot) && in_lto_p && can_be_vtable_hashed_p (type))
2002 hash = hash_odr_vtable (type);
2003 vtable_slot = odr_vtable_hash->find_slot_with_hash (type, hash,
2004 insert ? INSERT : NO_INSERT);
2007 if (!slot && !vtable_slot)
2008 return NULL;
2010 /* See if we already have entry for type. */
2011 if ((slot && *slot) || (vtable_slot && *vtable_slot))
2013 if (slot && *slot)
2015 val = *slot;
2016 if (flag_checking
2017 && in_lto_p && can_be_vtable_hashed_p (type))
2019 hash = hash_odr_vtable (type);
2020 vtable_slot = odr_vtable_hash->find_slot_with_hash (type, hash,
2021 NO_INSERT);
2022 gcc_assert (!vtable_slot || *vtable_slot == *slot);
2023 vtable_slot = NULL;
2026 else if (*vtable_slot)
2027 val = *vtable_slot;
2029 if (val->type != type
2030 && (!val->types_set || !val->types_set->add (type)))
2032 gcc_assert (insert);
2033 /* We have type duplicate, but it may introduce vtable name or
2034 mangled name; be sure to keep hashes in sync. */
2035 if (in_lto_p && can_be_vtable_hashed_p (type)
2036 && (!vtable_slot || !*vtable_slot))
2038 if (!vtable_slot)
2040 hash = hash_odr_vtable (type);
2041 vtable_slot = odr_vtable_hash->find_slot_with_hash
2042 (type, hash, INSERT);
2043 gcc_checking_assert (!*vtable_slot || *vtable_slot == val);
2045 *vtable_slot = val;
2047 if (slot && !*slot)
2048 *slot = val;
2049 build_bases = add_type_duplicate (val, type);
2052 else
2054 val = ggc_cleared_alloc<odr_type_d> ();
2055 val->type = type;
2056 val->bases = vNULL;
2057 val->derived_types = vNULL;
2058 if (type_with_linkage_p (type))
2059 val->anonymous_namespace = type_in_anonymous_namespace_p (type);
2060 else
2061 val->anonymous_namespace = 0;
2062 build_bases = COMPLETE_TYPE_P (val->type);
2063 insert_to_odr_array = true;
2064 if (slot)
2065 *slot = val;
2066 if (vtable_slot)
2067 *vtable_slot = val;
2070 if (build_bases && TREE_CODE (type) == RECORD_TYPE && TYPE_BINFO (type)
2071 && type_with_linkage_p (type)
2072 && type == TYPE_MAIN_VARIANT (type))
2074 tree binfo = TYPE_BINFO (type);
2075 unsigned int i;
2077 gcc_assert (BINFO_TYPE (TYPE_BINFO (val->type)) == type);
2079 val->all_derivations_known = type_all_derivations_known_p (type);
2080 for (i = 0; i < BINFO_N_BASE_BINFOS (binfo); i++)
2081 /* For now record only polymorphic types. other are
2082 pointless for devirtualization and we can not precisely
2083 determine ODR equivalency of these during LTO. */
2084 if (polymorphic_type_binfo_p (BINFO_BASE_BINFO (binfo, i)))
2086 tree base_type= BINFO_TYPE (BINFO_BASE_BINFO (binfo, i));
2087 odr_type base = get_odr_type (base_type, true);
2088 gcc_assert (TYPE_MAIN_VARIANT (base_type) == base_type);
2089 base->derived_types.safe_push (val);
2090 val->bases.safe_push (base);
2091 if (base->id > base_id)
2092 base_id = base->id;
2095 /* Ensure that type always appears after bases. */
2096 if (insert_to_odr_array)
2098 if (odr_types_ptr)
2099 val->id = odr_types.length ();
2100 vec_safe_push (odr_types_ptr, val);
2102 else if (base_id > val->id)
2104 odr_types[val->id] = 0;
2105 /* Be sure we did not recorded any derived types; these may need
2106 renumbering too. */
2107 gcc_assert (val->derived_types.length() == 0);
2108 val->id = odr_types.length ();
2109 vec_safe_push (odr_types_ptr, val);
2111 return val;
2114 /* Add TYPE od ODR type hash. */
2116 void
2117 register_odr_type (tree type)
2119 if (!odr_hash)
2121 odr_hash = new odr_hash_type (23);
2122 if (in_lto_p)
2123 odr_vtable_hash = new odr_vtable_hash_type (23);
2125 /* Arrange things to be nicer and insert main variants first.
2126 ??? fundamental prerecorded types do not have mangled names; this
2127 makes it possible that non-ODR type is main_odr_variant of ODR type.
2128 Things may get smoother if LTO FE set mangled name of those types same
2129 way as C++ FE does. */
2130 if (odr_type_p (main_odr_variant (TYPE_MAIN_VARIANT (type)))
2131 && odr_type_p (TYPE_MAIN_VARIANT (type)))
2132 get_odr_type (TYPE_MAIN_VARIANT (type), true);
2133 if (TYPE_MAIN_VARIANT (type) != type && odr_type_p (main_odr_variant (type)))
2134 get_odr_type (type, true);
2137 /* Return true if type is known to have no derivations. */
2139 bool
2140 type_known_to_have_no_derivations_p (tree t)
2142 return (type_all_derivations_known_p (t)
2143 && (TYPE_FINAL_P (t)
2144 || (odr_hash
2145 && !get_odr_type (t, true)->derived_types.length())));
2148 /* Dump ODR type T and all its derived types. INDENT specifies indentation for
2149 recursive printing. */
2151 static void
2152 dump_odr_type (FILE *f, odr_type t, int indent=0)
2154 unsigned int i;
2155 fprintf (f, "%*s type %i: ", indent * 2, "", t->id);
2156 print_generic_expr (f, t->type, TDF_SLIM);
2157 fprintf (f, "%s", t->anonymous_namespace ? " (anonymous namespace)":"");
2158 fprintf (f, "%s\n", t->all_derivations_known ? " (derivations known)":"");
2159 if (TYPE_NAME (t->type))
2161 /*fprintf (f, "%*s defined at: %s:%i\n", indent * 2, "",
2162 DECL_SOURCE_FILE (TYPE_NAME (t->type)),
2163 DECL_SOURCE_LINE (TYPE_NAME (t->type)));*/
2164 if (DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t->type)))
2165 fprintf (f, "%*s mangled name: %s\n", indent * 2, "",
2166 IDENTIFIER_POINTER
2167 (DECL_ASSEMBLER_NAME (TYPE_NAME (t->type))));
2169 if (t->bases.length ())
2171 fprintf (f, "%*s base odr type ids: ", indent * 2, "");
2172 for (i = 0; i < t->bases.length (); i++)
2173 fprintf (f, " %i", t->bases[i]->id);
2174 fprintf (f, "\n");
2176 if (t->derived_types.length ())
2178 fprintf (f, "%*s derived types:\n", indent * 2, "");
2179 for (i = 0; i < t->derived_types.length (); i++)
2180 dump_odr_type (f, t->derived_types[i], indent + 1);
2182 fprintf (f, "\n");
2185 /* Dump the type inheritance graph. */
2187 static void
2188 dump_type_inheritance_graph (FILE *f)
2190 unsigned int i;
2191 if (!odr_types_ptr)
2192 return;
2193 fprintf (f, "\n\nType inheritance graph:\n");
2194 for (i = 0; i < odr_types.length (); i++)
2196 if (odr_types[i] && odr_types[i]->bases.length () == 0)
2197 dump_odr_type (f, odr_types[i]);
2199 for (i = 0; i < odr_types.length (); i++)
2201 if (odr_types[i] && odr_types[i]->types && odr_types[i]->types->length ())
2203 unsigned int j;
2204 fprintf (f, "Duplicate tree types for odr type %i\n", i);
2205 print_node (f, "", odr_types[i]->type, 0);
2206 for (j = 0; j < odr_types[i]->types->length (); j++)
2208 tree t;
2209 fprintf (f, "duplicate #%i\n", j);
2210 print_node (f, "", (*odr_types[i]->types)[j], 0);
2211 t = (*odr_types[i]->types)[j];
2212 while (TYPE_P (t) && TYPE_CONTEXT (t))
2214 t = TYPE_CONTEXT (t);
2215 print_node (f, "", t, 0);
2217 putc ('\n',f);
2223 /* Initialize IPA devirt and build inheritance tree graph. */
2225 void
2226 build_type_inheritance_graph (void)
2228 struct symtab_node *n;
2229 FILE *inheritance_dump_file;
2230 dump_flags_t flags;
2232 if (odr_hash)
2233 return;
2234 timevar_push (TV_IPA_INHERITANCE);
2235 inheritance_dump_file = dump_begin (TDI_inheritance, &flags);
2236 odr_hash = new odr_hash_type (23);
2237 if (in_lto_p)
2238 odr_vtable_hash = new odr_vtable_hash_type (23);
2240 /* We reconstruct the graph starting of types of all methods seen in the
2241 unit. */
2242 FOR_EACH_SYMBOL (n)
2243 if (is_a <cgraph_node *> (n)
2244 && DECL_VIRTUAL_P (n->decl)
2245 && n->real_symbol_p ())
2246 get_odr_type (TYPE_METHOD_BASETYPE (TREE_TYPE (n->decl)), true);
2248 /* Look also for virtual tables of types that do not define any methods.
2250 We need it in a case where class B has virtual base of class A
2251 re-defining its virtual method and there is class C with no virtual
2252 methods with B as virtual base.
2254 Here we output B's virtual method in two variant - for non-virtual
2255 and virtual inheritance. B's virtual table has non-virtual version,
2256 while C's has virtual.
2258 For this reason we need to know about C in order to include both
2259 variants of B. More correctly, record_target_from_binfo should
2260 add both variants of the method when walking B, but we have no
2261 link in between them.
2263 We rely on fact that either the method is exported and thus we
2264 assume it is called externally or C is in anonymous namespace and
2265 thus we will see the vtable. */
2267 else if (is_a <varpool_node *> (n)
2268 && DECL_VIRTUAL_P (n->decl)
2269 && TREE_CODE (DECL_CONTEXT (n->decl)) == RECORD_TYPE
2270 && TYPE_BINFO (DECL_CONTEXT (n->decl))
2271 && polymorphic_type_binfo_p (TYPE_BINFO (DECL_CONTEXT (n->decl))))
2272 get_odr_type (TYPE_MAIN_VARIANT (DECL_CONTEXT (n->decl)), true);
2273 if (inheritance_dump_file)
2275 dump_type_inheritance_graph (inheritance_dump_file);
2276 dump_end (TDI_inheritance, inheritance_dump_file);
2278 timevar_pop (TV_IPA_INHERITANCE);
2281 /* Return true if N has reference from live virtual table
2282 (and thus can be a destination of polymorphic call).
2283 Be conservatively correct when callgraph is not built or
2284 if the method may be referred externally. */
2286 static bool
2287 referenced_from_vtable_p (struct cgraph_node *node)
2289 int i;
2290 struct ipa_ref *ref;
2291 bool found = false;
2293 if (node->externally_visible
2294 || DECL_EXTERNAL (node->decl)
2295 || node->used_from_other_partition)
2296 return true;
2298 /* Keep this test constant time.
2299 It is unlikely this can happen except for the case where speculative
2300 devirtualization introduced many speculative edges to this node.
2301 In this case the target is very likely alive anyway. */
2302 if (node->ref_list.referring.length () > 100)
2303 return true;
2305 /* We need references built. */
2306 if (symtab->state <= CONSTRUCTION)
2307 return true;
2309 for (i = 0; node->iterate_referring (i, ref); i++)
2310 if ((ref->use == IPA_REF_ALIAS
2311 && referenced_from_vtable_p (dyn_cast<cgraph_node *> (ref->referring)))
2312 || (ref->use == IPA_REF_ADDR
2313 && VAR_P (ref->referring->decl)
2314 && DECL_VIRTUAL_P (ref->referring->decl)))
2316 found = true;
2317 break;
2319 return found;
2322 /* Return if TARGET is cxa_pure_virtual. */
2324 static bool
2325 is_cxa_pure_virtual_p (tree target)
2327 return target && TREE_CODE (TREE_TYPE (target)) != METHOD_TYPE
2328 && DECL_NAME (target)
2329 && id_equal (DECL_NAME (target),
2330 "__cxa_pure_virtual");
2333 /* If TARGET has associated node, record it in the NODES array.
2334 CAN_REFER specify if program can refer to the target directly.
2335 if TARGET is unknown (NULL) or it can not be inserted (for example because
2336 its body was already removed and there is no way to refer to it), clear
2337 COMPLETEP. */
2339 static void
2340 maybe_record_node (vec <cgraph_node *> &nodes,
2341 tree target, hash_set<tree> *inserted,
2342 bool can_refer,
2343 bool *completep)
2345 struct cgraph_node *target_node, *alias_target;
2346 enum availability avail;
2347 bool pure_virtual = is_cxa_pure_virtual_p (target);
2349 /* __builtin_unreachable do not need to be added into
2350 list of targets; the runtime effect of calling them is undefined.
2351 Only "real" virtual methods should be accounted. */
2352 if (target && TREE_CODE (TREE_TYPE (target)) != METHOD_TYPE && !pure_virtual)
2353 return;
2355 if (!can_refer)
2357 /* The only case when method of anonymous namespace becomes unreferable
2358 is when we completely optimized it out. */
2359 if (flag_ltrans
2360 || !target
2361 || !type_in_anonymous_namespace_p (DECL_CONTEXT (target)))
2362 *completep = false;
2363 return;
2366 if (!target)
2367 return;
2369 target_node = cgraph_node::get (target);
2371 /* Prefer alias target over aliases, so we do not get confused by
2372 fake duplicates. */
2373 if (target_node)
2375 alias_target = target_node->ultimate_alias_target (&avail);
2376 if (target_node != alias_target
2377 && avail >= AVAIL_AVAILABLE
2378 && target_node->get_availability ())
2379 target_node = alias_target;
2382 /* Method can only be called by polymorphic call if any
2383 of vtables referring to it are alive.
2385 While this holds for non-anonymous functions, too, there are
2386 cases where we want to keep them in the list; for example
2387 inline functions with -fno-weak are static, but we still
2388 may devirtualize them when instance comes from other unit.
2389 The same holds for LTO.
2391 Currently we ignore these functions in speculative devirtualization.
2392 ??? Maybe it would make sense to be more aggressive for LTO even
2393 elsewhere. */
2394 if (!flag_ltrans
2395 && !pure_virtual
2396 && type_in_anonymous_namespace_p (DECL_CONTEXT (target))
2397 && (!target_node
2398 || !referenced_from_vtable_p (target_node)))
2400 /* See if TARGET is useful function we can deal with. */
2401 else if (target_node != NULL
2402 && (TREE_PUBLIC (target)
2403 || DECL_EXTERNAL (target)
2404 || target_node->definition)
2405 && target_node->real_symbol_p ())
2407 gcc_assert (!target_node->global.inlined_to);
2408 gcc_assert (target_node->real_symbol_p ());
2409 /* When sanitizing, do not assume that __cxa_pure_virtual is not called
2410 by valid program. */
2411 if (flag_sanitize & SANITIZE_UNREACHABLE)
2413 /* Only add pure virtual if it is the only possible target. This way
2414 we will preserve the diagnostics about pure virtual called in many
2415 cases without disabling optimization in other. */
2416 else if (pure_virtual)
2418 if (nodes.length ())
2419 return;
2421 /* If we found a real target, take away cxa_pure_virtual. */
2422 else if (!pure_virtual && nodes.length () == 1
2423 && is_cxa_pure_virtual_p (nodes[0]->decl))
2424 nodes.pop ();
2425 if (pure_virtual && nodes.length ())
2426 return;
2427 if (!inserted->add (target))
2429 cached_polymorphic_call_targets->add (target_node);
2430 nodes.safe_push (target_node);
2433 else if (!completep)
2435 /* We have definition of __cxa_pure_virtual that is not accessible (it is
2436 optimized out or partitioned to other unit) so we can not add it. When
2437 not sanitizing, there is nothing to do.
2438 Otherwise declare the list incomplete. */
2439 else if (pure_virtual)
2441 if (flag_sanitize & SANITIZE_UNREACHABLE)
2442 *completep = false;
2444 else if (flag_ltrans
2445 || !type_in_anonymous_namespace_p (DECL_CONTEXT (target)))
2446 *completep = false;
2449 /* See if BINFO's type matches OUTER_TYPE. If so, look up
2450 BINFO of subtype of OTR_TYPE at OFFSET and in that BINFO find
2451 method in vtable and insert method to NODES array
2452 or BASES_TO_CONSIDER if this array is non-NULL.
2453 Otherwise recurse to base BINFOs.
2454 This matches what get_binfo_at_offset does, but with offset
2455 being unknown.
2457 TYPE_BINFOS is a stack of BINFOS of types with defined
2458 virtual table seen on way from class type to BINFO.
2460 MATCHED_VTABLES tracks virtual tables we already did lookup
2461 for virtual function in. INSERTED tracks nodes we already
2462 inserted.
2464 ANONYMOUS is true if BINFO is part of anonymous namespace.
2466 Clear COMPLETEP when we hit unreferable target.
2469 static void
2470 record_target_from_binfo (vec <cgraph_node *> &nodes,
2471 vec <tree> *bases_to_consider,
2472 tree binfo,
2473 tree otr_type,
2474 vec <tree> &type_binfos,
2475 HOST_WIDE_INT otr_token,
2476 tree outer_type,
2477 HOST_WIDE_INT offset,
2478 hash_set<tree> *inserted,
2479 hash_set<tree> *matched_vtables,
2480 bool anonymous,
2481 bool *completep)
2483 tree type = BINFO_TYPE (binfo);
2484 int i;
2485 tree base_binfo;
2488 if (BINFO_VTABLE (binfo))
2489 type_binfos.safe_push (binfo);
2490 if (types_same_for_odr (type, outer_type))
2492 int i;
2493 tree type_binfo = NULL;
2495 /* Look up BINFO with virtual table. For normal types it is always last
2496 binfo on stack. */
2497 for (i = type_binfos.length () - 1; i >= 0; i--)
2498 if (BINFO_OFFSET (type_binfos[i]) == BINFO_OFFSET (binfo))
2500 type_binfo = type_binfos[i];
2501 break;
2503 if (BINFO_VTABLE (binfo))
2504 type_binfos.pop ();
2505 /* If this is duplicated BINFO for base shared by virtual inheritance,
2506 we may not have its associated vtable. This is not a problem, since
2507 we will walk it on the other path. */
2508 if (!type_binfo)
2509 return;
2510 tree inner_binfo = get_binfo_at_offset (type_binfo,
2511 offset, otr_type);
2512 if (!inner_binfo)
2514 gcc_assert (odr_violation_reported);
2515 return;
2517 /* For types in anonymous namespace first check if the respective vtable
2518 is alive. If not, we know the type can't be called. */
2519 if (!flag_ltrans && anonymous)
2521 tree vtable = BINFO_VTABLE (inner_binfo);
2522 varpool_node *vnode;
2524 if (TREE_CODE (vtable) == POINTER_PLUS_EXPR)
2525 vtable = TREE_OPERAND (TREE_OPERAND (vtable, 0), 0);
2526 vnode = varpool_node::get (vtable);
2527 if (!vnode || !vnode->definition)
2528 return;
2530 gcc_assert (inner_binfo);
2531 if (bases_to_consider
2532 ? !matched_vtables->contains (BINFO_VTABLE (inner_binfo))
2533 : !matched_vtables->add (BINFO_VTABLE (inner_binfo)))
2535 bool can_refer;
2536 tree target = gimple_get_virt_method_for_binfo (otr_token,
2537 inner_binfo,
2538 &can_refer);
2539 if (!bases_to_consider)
2540 maybe_record_node (nodes, target, inserted, can_refer, completep);
2541 /* Destructors are never called via construction vtables. */
2542 else if (!target || !DECL_CXX_DESTRUCTOR_P (target))
2543 bases_to_consider->safe_push (target);
2545 return;
2548 /* Walk bases. */
2549 for (i = 0; BINFO_BASE_ITERATE (binfo, i, base_binfo); i++)
2550 /* Walking bases that have no virtual method is pointless exercise. */
2551 if (polymorphic_type_binfo_p (base_binfo))
2552 record_target_from_binfo (nodes, bases_to_consider, base_binfo, otr_type,
2553 type_binfos,
2554 otr_token, outer_type, offset, inserted,
2555 matched_vtables, anonymous, completep);
2556 if (BINFO_VTABLE (binfo))
2557 type_binfos.pop ();
2560 /* Look up virtual methods matching OTR_TYPE (with OFFSET and OTR_TOKEN)
2561 of TYPE, insert them to NODES, recurse into derived nodes.
2562 INSERTED is used to avoid duplicate insertions of methods into NODES.
2563 MATCHED_VTABLES are used to avoid duplicate walking vtables.
2564 Clear COMPLETEP if unreferable target is found.
2566 If CONSIDER_CONSTRUCTION is true, record to BASES_TO_CONSIDER
2567 all cases where BASE_SKIPPED is true (because the base is abstract
2568 class). */
2570 static void
2571 possible_polymorphic_call_targets_1 (vec <cgraph_node *> &nodes,
2572 hash_set<tree> *inserted,
2573 hash_set<tree> *matched_vtables,
2574 tree otr_type,
2575 odr_type type,
2576 HOST_WIDE_INT otr_token,
2577 tree outer_type,
2578 HOST_WIDE_INT offset,
2579 bool *completep,
2580 vec <tree> &bases_to_consider,
2581 bool consider_construction)
2583 tree binfo = TYPE_BINFO (type->type);
2584 unsigned int i;
2585 auto_vec <tree, 8> type_binfos;
2586 bool possibly_instantiated = type_possibly_instantiated_p (type->type);
2588 /* We may need to consider types w/o instances because of possible derived
2589 types using their methods either directly or via construction vtables.
2590 We are safe to skip them when all derivations are known, since we will
2591 handle them later.
2592 This is done by recording them to BASES_TO_CONSIDER array. */
2593 if (possibly_instantiated || consider_construction)
2595 record_target_from_binfo (nodes,
2596 (!possibly_instantiated
2597 && type_all_derivations_known_p (type->type))
2598 ? &bases_to_consider : NULL,
2599 binfo, otr_type, type_binfos, otr_token,
2600 outer_type, offset,
2601 inserted, matched_vtables,
2602 type->anonymous_namespace, completep);
2604 for (i = 0; i < type->derived_types.length (); i++)
2605 possible_polymorphic_call_targets_1 (nodes, inserted,
2606 matched_vtables,
2607 otr_type,
2608 type->derived_types[i],
2609 otr_token, outer_type, offset, completep,
2610 bases_to_consider, consider_construction);
2613 /* Cache of queries for polymorphic call targets.
2615 Enumerating all call targets may get expensive when there are many
2616 polymorphic calls in the program, so we memoize all the previous
2617 queries and avoid duplicated work. */
2619 struct polymorphic_call_target_d
2621 HOST_WIDE_INT otr_token;
2622 ipa_polymorphic_call_context context;
2623 odr_type type;
2624 vec <cgraph_node *> targets;
2625 tree decl_warning;
2626 int type_warning;
2627 bool complete;
2628 bool speculative;
2631 /* Polymorphic call target cache helpers. */
2633 struct polymorphic_call_target_hasher
2634 : pointer_hash <polymorphic_call_target_d>
2636 static inline hashval_t hash (const polymorphic_call_target_d *);
2637 static inline bool equal (const polymorphic_call_target_d *,
2638 const polymorphic_call_target_d *);
2639 static inline void remove (polymorphic_call_target_d *);
2642 /* Return the computed hashcode for ODR_QUERY. */
2644 inline hashval_t
2645 polymorphic_call_target_hasher::hash (const polymorphic_call_target_d *odr_query)
2647 inchash::hash hstate (odr_query->otr_token);
2649 hstate.add_hwi (odr_query->type->id);
2650 hstate.merge_hash (TYPE_UID (odr_query->context.outer_type));
2651 hstate.add_hwi (odr_query->context.offset);
2653 if (odr_query->context.speculative_outer_type)
2655 hstate.merge_hash (TYPE_UID (odr_query->context.speculative_outer_type));
2656 hstate.add_hwi (odr_query->context.speculative_offset);
2658 hstate.add_flag (odr_query->speculative);
2659 hstate.add_flag (odr_query->context.maybe_in_construction);
2660 hstate.add_flag (odr_query->context.maybe_derived_type);
2661 hstate.add_flag (odr_query->context.speculative_maybe_derived_type);
2662 hstate.commit_flag ();
2663 return hstate.end ();
2666 /* Compare cache entries T1 and T2. */
2668 inline bool
2669 polymorphic_call_target_hasher::equal (const polymorphic_call_target_d *t1,
2670 const polymorphic_call_target_d *t2)
2672 return (t1->type == t2->type && t1->otr_token == t2->otr_token
2673 && t1->speculative == t2->speculative
2674 && t1->context.offset == t2->context.offset
2675 && t1->context.speculative_offset == t2->context.speculative_offset
2676 && t1->context.outer_type == t2->context.outer_type
2677 && t1->context.speculative_outer_type == t2->context.speculative_outer_type
2678 && t1->context.maybe_in_construction
2679 == t2->context.maybe_in_construction
2680 && t1->context.maybe_derived_type == t2->context.maybe_derived_type
2681 && (t1->context.speculative_maybe_derived_type
2682 == t2->context.speculative_maybe_derived_type));
2685 /* Remove entry in polymorphic call target cache hash. */
2687 inline void
2688 polymorphic_call_target_hasher::remove (polymorphic_call_target_d *v)
2690 v->targets.release ();
2691 free (v);
2694 /* Polymorphic call target query cache. */
2696 typedef hash_table<polymorphic_call_target_hasher>
2697 polymorphic_call_target_hash_type;
2698 static polymorphic_call_target_hash_type *polymorphic_call_target_hash;
2700 /* Destroy polymorphic call target query cache. */
2702 static void
2703 free_polymorphic_call_targets_hash ()
2705 if (cached_polymorphic_call_targets)
2707 delete polymorphic_call_target_hash;
2708 polymorphic_call_target_hash = NULL;
2709 delete cached_polymorphic_call_targets;
2710 cached_polymorphic_call_targets = NULL;
2714 /* Force rebuilding type inheritance graph from scratch.
2715 This is use to make sure that we do not keep references to types
2716 which was not visible to free_lang_data. */
2718 void
2719 rebuild_type_inheritance_graph ()
2721 if (!odr_hash)
2722 return;
2723 delete odr_hash;
2724 if (in_lto_p)
2725 delete odr_vtable_hash;
2726 odr_hash = NULL;
2727 odr_vtable_hash = NULL;
2728 odr_types_ptr = NULL;
2729 free_polymorphic_call_targets_hash ();
2732 /* When virtual function is removed, we may need to flush the cache. */
2734 static void
2735 devirt_node_removal_hook (struct cgraph_node *n, void *d ATTRIBUTE_UNUSED)
2737 if (cached_polymorphic_call_targets
2738 && cached_polymorphic_call_targets->contains (n))
2739 free_polymorphic_call_targets_hash ();
2742 /* Look up base of BINFO that has virtual table VTABLE with OFFSET. */
2744 tree
2745 subbinfo_with_vtable_at_offset (tree binfo, unsigned HOST_WIDE_INT offset,
2746 tree vtable)
2748 tree v = BINFO_VTABLE (binfo);
2749 int i;
2750 tree base_binfo;
2751 unsigned HOST_WIDE_INT this_offset;
2753 if (v)
2755 if (!vtable_pointer_value_to_vtable (v, &v, &this_offset))
2756 gcc_unreachable ();
2758 if (offset == this_offset
2759 && DECL_ASSEMBLER_NAME (v) == DECL_ASSEMBLER_NAME (vtable))
2760 return binfo;
2763 for (i = 0; BINFO_BASE_ITERATE (binfo, i, base_binfo); i++)
2764 if (polymorphic_type_binfo_p (base_binfo))
2766 base_binfo = subbinfo_with_vtable_at_offset (base_binfo, offset, vtable);
2767 if (base_binfo)
2768 return base_binfo;
2770 return NULL;
2773 /* T is known constant value of virtual table pointer.
2774 Store virtual table to V and its offset to OFFSET.
2775 Return false if T does not look like virtual table reference. */
2777 bool
2778 vtable_pointer_value_to_vtable (const_tree t, tree *v,
2779 unsigned HOST_WIDE_INT *offset)
2781 /* We expect &MEM[(void *)&virtual_table + 16B].
2782 We obtain object's BINFO from the context of the virtual table.
2783 This one contains pointer to virtual table represented via
2784 POINTER_PLUS_EXPR. Verify that this pointer matches what
2785 we propagated through.
2787 In the case of virtual inheritance, the virtual tables may
2788 be nested, i.e. the offset may be different from 16 and we may
2789 need to dive into the type representation. */
2790 if (TREE_CODE (t) == ADDR_EXPR
2791 && TREE_CODE (TREE_OPERAND (t, 0)) == MEM_REF
2792 && TREE_CODE (TREE_OPERAND (TREE_OPERAND (t, 0), 0)) == ADDR_EXPR
2793 && TREE_CODE (TREE_OPERAND (TREE_OPERAND (t, 0), 1)) == INTEGER_CST
2794 && (TREE_CODE (TREE_OPERAND (TREE_OPERAND (TREE_OPERAND (t, 0), 0), 0))
2795 == VAR_DECL)
2796 && DECL_VIRTUAL_P (TREE_OPERAND (TREE_OPERAND
2797 (TREE_OPERAND (t, 0), 0), 0)))
2799 *v = TREE_OPERAND (TREE_OPERAND (TREE_OPERAND (t, 0), 0), 0);
2800 *offset = tree_to_uhwi (TREE_OPERAND (TREE_OPERAND (t, 0), 1));
2801 return true;
2804 /* Alternative representation, used by C++ frontend is POINTER_PLUS_EXPR.
2805 We need to handle it when T comes from static variable initializer or
2806 BINFO. */
2807 if (TREE_CODE (t) == POINTER_PLUS_EXPR)
2809 *offset = tree_to_uhwi (TREE_OPERAND (t, 1));
2810 t = TREE_OPERAND (t, 0);
2812 else
2813 *offset = 0;
2815 if (TREE_CODE (t) != ADDR_EXPR)
2816 return false;
2817 *v = TREE_OPERAND (t, 0);
2818 return true;
2821 /* T is known constant value of virtual table pointer. Return BINFO of the
2822 instance type. */
2824 tree
2825 vtable_pointer_value_to_binfo (const_tree t)
2827 tree vtable;
2828 unsigned HOST_WIDE_INT offset;
2830 if (!vtable_pointer_value_to_vtable (t, &vtable, &offset))
2831 return NULL_TREE;
2833 /* FIXME: for stores of construction vtables we return NULL,
2834 because we do not have BINFO for those. Eventually we should fix
2835 our representation to allow this case to be handled, too.
2836 In the case we see store of BINFO we however may assume
2837 that standard folding will be able to cope with it. */
2838 return subbinfo_with_vtable_at_offset (TYPE_BINFO (DECL_CONTEXT (vtable)),
2839 offset, vtable);
2842 /* Walk bases of OUTER_TYPE that contain OTR_TYPE at OFFSET.
2843 Look up their respective virtual methods for OTR_TOKEN and OTR_TYPE
2844 and insert them in NODES.
2846 MATCHED_VTABLES and INSERTED is used to avoid duplicated work. */
2848 static void
2849 record_targets_from_bases (tree otr_type,
2850 HOST_WIDE_INT otr_token,
2851 tree outer_type,
2852 HOST_WIDE_INT offset,
2853 vec <cgraph_node *> &nodes,
2854 hash_set<tree> *inserted,
2855 hash_set<tree> *matched_vtables,
2856 bool *completep)
2858 while (true)
2860 HOST_WIDE_INT pos, size;
2861 tree base_binfo;
2862 tree fld;
2864 if (types_same_for_odr (outer_type, otr_type))
2865 return;
2867 for (fld = TYPE_FIELDS (outer_type); fld; fld = DECL_CHAIN (fld))
2869 if (TREE_CODE (fld) != FIELD_DECL)
2870 continue;
2872 pos = int_bit_position (fld);
2873 size = tree_to_shwi (DECL_SIZE (fld));
2874 if (pos <= offset && (pos + size) > offset
2875 /* Do not get confused by zero sized bases. */
2876 && polymorphic_type_binfo_p (TYPE_BINFO (TREE_TYPE (fld))))
2877 break;
2879 /* Within a class type we should always find corresponding fields. */
2880 gcc_assert (fld && TREE_CODE (TREE_TYPE (fld)) == RECORD_TYPE);
2882 /* Nonbase types should have been stripped by outer_class_type. */
2883 gcc_assert (DECL_ARTIFICIAL (fld));
2885 outer_type = TREE_TYPE (fld);
2886 offset -= pos;
2888 base_binfo = get_binfo_at_offset (TYPE_BINFO (outer_type),
2889 offset, otr_type);
2890 if (!base_binfo)
2892 gcc_assert (odr_violation_reported);
2893 return;
2895 gcc_assert (base_binfo);
2896 if (!matched_vtables->add (BINFO_VTABLE (base_binfo)))
2898 bool can_refer;
2899 tree target = gimple_get_virt_method_for_binfo (otr_token,
2900 base_binfo,
2901 &can_refer);
2902 if (!target || ! DECL_CXX_DESTRUCTOR_P (target))
2903 maybe_record_node (nodes, target, inserted, can_refer, completep);
2904 matched_vtables->add (BINFO_VTABLE (base_binfo));
2909 /* When virtual table is removed, we may need to flush the cache. */
2911 static void
2912 devirt_variable_node_removal_hook (varpool_node *n,
2913 void *d ATTRIBUTE_UNUSED)
2915 if (cached_polymorphic_call_targets
2916 && DECL_VIRTUAL_P (n->decl)
2917 && type_in_anonymous_namespace_p (DECL_CONTEXT (n->decl)))
2918 free_polymorphic_call_targets_hash ();
2921 /* Record about how many calls would benefit from given type to be final. */
2923 struct odr_type_warn_count
2925 tree type;
2926 int count;
2927 profile_count dyn_count;
2930 /* Record about how many calls would benefit from given method to be final. */
2932 struct decl_warn_count
2934 tree decl;
2935 int count;
2936 profile_count dyn_count;
2939 /* Information about type and decl warnings. */
2941 struct final_warning_record
2943 /* If needed grow type_warnings vector and initialize new decl_warn_count
2944 to have dyn_count set to profile_count::zero (). */
2945 void grow_type_warnings (unsigned newlen);
2947 profile_count dyn_count;
2948 auto_vec<odr_type_warn_count> type_warnings;
2949 hash_map<tree, decl_warn_count> decl_warnings;
2952 void
2953 final_warning_record::grow_type_warnings (unsigned newlen)
2955 unsigned len = type_warnings.length ();
2956 if (newlen > len)
2958 type_warnings.safe_grow_cleared (newlen);
2959 for (unsigned i = len; i < newlen; i++)
2960 type_warnings[i].dyn_count = profile_count::zero ();
2964 struct final_warning_record *final_warning_records;
2966 /* Return vector containing possible targets of polymorphic call of type
2967 OTR_TYPE calling method OTR_TOKEN within type of OTR_OUTER_TYPE and OFFSET.
2968 If INCLUDE_BASES is true, walk also base types of OUTER_TYPES containing
2969 OTR_TYPE and include their virtual method. This is useful for types
2970 possibly in construction or destruction where the virtual table may
2971 temporarily change to one of base types. INCLUDE_DERIVER_TYPES make
2972 us to walk the inheritance graph for all derivations.
2974 If COMPLETEP is non-NULL, store true if the list is complete.
2975 CACHE_TOKEN (if non-NULL) will get stored to an unique ID of entry
2976 in the target cache. If user needs to visit every target list
2977 just once, it can memoize them.
2979 If SPECULATIVE is set, the list will not contain targets that
2980 are not speculatively taken.
2982 Returned vector is placed into cache. It is NOT caller's responsibility
2983 to free it. The vector can be freed on cgraph_remove_node call if
2984 the particular node is a virtual function present in the cache. */
2986 vec <cgraph_node *>
2987 possible_polymorphic_call_targets (tree otr_type,
2988 HOST_WIDE_INT otr_token,
2989 ipa_polymorphic_call_context context,
2990 bool *completep,
2991 void **cache_token,
2992 bool speculative)
2994 static struct cgraph_node_hook_list *node_removal_hook_holder;
2995 vec <cgraph_node *> nodes = vNULL;
2996 auto_vec <tree, 8> bases_to_consider;
2997 odr_type type, outer_type;
2998 polymorphic_call_target_d key;
2999 polymorphic_call_target_d **slot;
3000 unsigned int i;
3001 tree binfo, target;
3002 bool complete;
3003 bool can_refer = false;
3004 bool skipped = false;
3006 otr_type = TYPE_MAIN_VARIANT (otr_type);
3008 /* If ODR is not initialized or the context is invalid, return empty
3009 incomplete list. */
3010 if (!odr_hash || context.invalid || !TYPE_BINFO (otr_type))
3012 if (completep)
3013 *completep = context.invalid;
3014 if (cache_token)
3015 *cache_token = NULL;
3016 return nodes;
3019 /* Do not bother to compute speculative info when user do not asks for it. */
3020 if (!speculative || !context.speculative_outer_type)
3021 context.clear_speculation ();
3023 type = get_odr_type (otr_type, true);
3025 /* Recording type variants would waste results cache. */
3026 gcc_assert (!context.outer_type
3027 || TYPE_MAIN_VARIANT (context.outer_type) == context.outer_type);
3029 /* Look up the outer class type we want to walk.
3030 If we fail to do so, the context is invalid. */
3031 if ((context.outer_type || context.speculative_outer_type)
3032 && !context.restrict_to_inner_class (otr_type))
3034 if (completep)
3035 *completep = true;
3036 if (cache_token)
3037 *cache_token = NULL;
3038 return nodes;
3040 gcc_assert (!context.invalid);
3042 /* Check that restrict_to_inner_class kept the main variant. */
3043 gcc_assert (!context.outer_type
3044 || TYPE_MAIN_VARIANT (context.outer_type) == context.outer_type);
3046 /* We canonicalize our query, so we do not need extra hashtable entries. */
3048 /* Without outer type, we have no use for offset. Just do the
3049 basic search from inner type. */
3050 if (!context.outer_type)
3051 context.clear_outer_type (otr_type);
3052 /* We need to update our hierarchy if the type does not exist. */
3053 outer_type = get_odr_type (context.outer_type, true);
3054 /* If the type is complete, there are no derivations. */
3055 if (TYPE_FINAL_P (outer_type->type))
3056 context.maybe_derived_type = false;
3058 /* Initialize query cache. */
3059 if (!cached_polymorphic_call_targets)
3061 cached_polymorphic_call_targets = new hash_set<cgraph_node *>;
3062 polymorphic_call_target_hash
3063 = new polymorphic_call_target_hash_type (23);
3064 if (!node_removal_hook_holder)
3066 node_removal_hook_holder =
3067 symtab->add_cgraph_removal_hook (&devirt_node_removal_hook, NULL);
3068 symtab->add_varpool_removal_hook (&devirt_variable_node_removal_hook,
3069 NULL);
3073 if (in_lto_p)
3075 if (context.outer_type != otr_type)
3076 context.outer_type
3077 = get_odr_type (context.outer_type, true)->type;
3078 if (context.speculative_outer_type)
3079 context.speculative_outer_type
3080 = get_odr_type (context.speculative_outer_type, true)->type;
3083 /* Look up cached answer. */
3084 key.type = type;
3085 key.otr_token = otr_token;
3086 key.speculative = speculative;
3087 key.context = context;
3088 slot = polymorphic_call_target_hash->find_slot (&key, INSERT);
3089 if (cache_token)
3090 *cache_token = (void *)*slot;
3091 if (*slot)
3093 if (completep)
3094 *completep = (*slot)->complete;
3095 if ((*slot)->type_warning && final_warning_records)
3097 final_warning_records->type_warnings[(*slot)->type_warning - 1].count++;
3098 if (!final_warning_records->type_warnings
3099 [(*slot)->type_warning - 1].dyn_count.initialized_p ())
3100 final_warning_records->type_warnings
3101 [(*slot)->type_warning - 1].dyn_count = profile_count::zero ();
3102 if (final_warning_records->dyn_count > 0)
3103 final_warning_records->type_warnings[(*slot)->type_warning - 1].dyn_count
3104 = final_warning_records->type_warnings[(*slot)->type_warning - 1].dyn_count
3105 + final_warning_records->dyn_count;
3107 if (!speculative && (*slot)->decl_warning && final_warning_records)
3109 struct decl_warn_count *c =
3110 final_warning_records->decl_warnings.get ((*slot)->decl_warning);
3111 c->count++;
3112 if (final_warning_records->dyn_count > 0)
3113 c->dyn_count += final_warning_records->dyn_count;
3115 return (*slot)->targets;
3118 complete = true;
3120 /* Do actual search. */
3121 timevar_push (TV_IPA_VIRTUAL_CALL);
3122 *slot = XCNEW (polymorphic_call_target_d);
3123 if (cache_token)
3124 *cache_token = (void *)*slot;
3125 (*slot)->type = type;
3126 (*slot)->otr_token = otr_token;
3127 (*slot)->context = context;
3128 (*slot)->speculative = speculative;
3130 hash_set<tree> inserted;
3131 hash_set<tree> matched_vtables;
3133 /* First insert targets we speculatively identified as likely. */
3134 if (context.speculative_outer_type)
3136 odr_type speculative_outer_type;
3137 bool speculation_complete = true;
3139 /* First insert target from type itself and check if it may have
3140 derived types. */
3141 speculative_outer_type = get_odr_type (context.speculative_outer_type, true);
3142 if (TYPE_FINAL_P (speculative_outer_type->type))
3143 context.speculative_maybe_derived_type = false;
3144 binfo = get_binfo_at_offset (TYPE_BINFO (speculative_outer_type->type),
3145 context.speculative_offset, otr_type);
3146 if (binfo)
3147 target = gimple_get_virt_method_for_binfo (otr_token, binfo,
3148 &can_refer);
3149 else
3150 target = NULL;
3152 /* In the case we get complete method, we don't need
3153 to walk derivations. */
3154 if (target && DECL_FINAL_P (target))
3155 context.speculative_maybe_derived_type = false;
3156 if (type_possibly_instantiated_p (speculative_outer_type->type))
3157 maybe_record_node (nodes, target, &inserted, can_refer, &speculation_complete);
3158 if (binfo)
3159 matched_vtables.add (BINFO_VTABLE (binfo));
3162 /* Next walk recursively all derived types. */
3163 if (context.speculative_maybe_derived_type)
3164 for (i = 0; i < speculative_outer_type->derived_types.length(); i++)
3165 possible_polymorphic_call_targets_1 (nodes, &inserted,
3166 &matched_vtables,
3167 otr_type,
3168 speculative_outer_type->derived_types[i],
3169 otr_token, speculative_outer_type->type,
3170 context.speculative_offset,
3171 &speculation_complete,
3172 bases_to_consider,
3173 false);
3176 if (!speculative || !nodes.length ())
3178 /* First see virtual method of type itself. */
3179 binfo = get_binfo_at_offset (TYPE_BINFO (outer_type->type),
3180 context.offset, otr_type);
3181 if (binfo)
3182 target = gimple_get_virt_method_for_binfo (otr_token, binfo,
3183 &can_refer);
3184 else
3186 gcc_assert (odr_violation_reported);
3187 target = NULL;
3190 /* Destructors are never called through construction virtual tables,
3191 because the type is always known. */
3192 if (target && DECL_CXX_DESTRUCTOR_P (target))
3193 context.maybe_in_construction = false;
3195 if (target)
3197 /* In the case we get complete method, we don't need
3198 to walk derivations. */
3199 if (DECL_FINAL_P (target))
3200 context.maybe_derived_type = false;
3203 /* If OUTER_TYPE is abstract, we know we are not seeing its instance. */
3204 if (type_possibly_instantiated_p (outer_type->type))
3205 maybe_record_node (nodes, target, &inserted, can_refer, &complete);
3206 else
3207 skipped = true;
3209 if (binfo)
3210 matched_vtables.add (BINFO_VTABLE (binfo));
3212 /* Next walk recursively all derived types. */
3213 if (context.maybe_derived_type)
3215 for (i = 0; i < outer_type->derived_types.length(); i++)
3216 possible_polymorphic_call_targets_1 (nodes, &inserted,
3217 &matched_vtables,
3218 otr_type,
3219 outer_type->derived_types[i],
3220 otr_token, outer_type->type,
3221 context.offset, &complete,
3222 bases_to_consider,
3223 context.maybe_in_construction);
3225 if (!outer_type->all_derivations_known)
3227 if (!speculative && final_warning_records
3228 && nodes.length () == 1
3229 && TREE_CODE (TREE_TYPE (nodes[0]->decl)) == METHOD_TYPE)
3231 if (complete
3232 && warn_suggest_final_types
3233 && !outer_type->derived_types.length ())
3235 final_warning_records->grow_type_warnings
3236 (outer_type->id);
3237 final_warning_records->type_warnings[outer_type->id].count++;
3238 if (!final_warning_records->type_warnings
3239 [outer_type->id].dyn_count.initialized_p ())
3240 final_warning_records->type_warnings
3241 [outer_type->id].dyn_count = profile_count::zero ();
3242 final_warning_records->type_warnings[outer_type->id].dyn_count
3243 += final_warning_records->dyn_count;
3244 final_warning_records->type_warnings[outer_type->id].type
3245 = outer_type->type;
3246 (*slot)->type_warning = outer_type->id + 1;
3248 if (complete
3249 && warn_suggest_final_methods
3250 && types_same_for_odr (DECL_CONTEXT (nodes[0]->decl),
3251 outer_type->type))
3253 bool existed;
3254 struct decl_warn_count &c =
3255 final_warning_records->decl_warnings.get_or_insert
3256 (nodes[0]->decl, &existed);
3258 if (existed)
3260 c.count++;
3261 c.dyn_count += final_warning_records->dyn_count;
3263 else
3265 c.count = 1;
3266 c.dyn_count = final_warning_records->dyn_count;
3267 c.decl = nodes[0]->decl;
3269 (*slot)->decl_warning = nodes[0]->decl;
3272 complete = false;
3276 if (!speculative)
3278 /* Destructors are never called through construction virtual tables,
3279 because the type is always known. One of entries may be
3280 cxa_pure_virtual so look to at least two of them. */
3281 if (context.maybe_in_construction)
3282 for (i =0 ; i < MIN (nodes.length (), 2); i++)
3283 if (DECL_CXX_DESTRUCTOR_P (nodes[i]->decl))
3284 context.maybe_in_construction = false;
3285 if (context.maybe_in_construction)
3287 if (type != outer_type
3288 && (!skipped
3289 || (context.maybe_derived_type
3290 && !type_all_derivations_known_p (outer_type->type))))
3291 record_targets_from_bases (otr_type, otr_token, outer_type->type,
3292 context.offset, nodes, &inserted,
3293 &matched_vtables, &complete);
3294 if (skipped)
3295 maybe_record_node (nodes, target, &inserted, can_refer, &complete);
3296 for (i = 0; i < bases_to_consider.length(); i++)
3297 maybe_record_node (nodes, bases_to_consider[i], &inserted, can_refer, &complete);
3302 (*slot)->targets = nodes;
3303 (*slot)->complete = complete;
3304 if (completep)
3305 *completep = complete;
3307 timevar_pop (TV_IPA_VIRTUAL_CALL);
3308 return nodes;
3311 bool
3312 add_decl_warning (const tree &key ATTRIBUTE_UNUSED, const decl_warn_count &value,
3313 vec<const decl_warn_count*> *vec)
3315 vec->safe_push (&value);
3316 return true;
3319 /* Dump target list TARGETS into FILE. */
3321 static void
3322 dump_targets (FILE *f, vec <cgraph_node *> targets)
3324 unsigned int i;
3326 for (i = 0; i < targets.length (); i++)
3328 char *name = NULL;
3329 if (in_lto_p)
3330 name = cplus_demangle_v3 (targets[i]->asm_name (), 0);
3331 fprintf (f, " %s/%i", name ? name : targets[i]->name (),
3332 targets[i]->order);
3333 if (in_lto_p)
3334 free (name);
3335 if (!targets[i]->definition)
3336 fprintf (f, " (no definition%s)",
3337 DECL_DECLARED_INLINE_P (targets[i]->decl)
3338 ? " inline" : "");
3340 fprintf (f, "\n");
3343 /* Dump all possible targets of a polymorphic call. */
3345 void
3346 dump_possible_polymorphic_call_targets (FILE *f,
3347 tree otr_type,
3348 HOST_WIDE_INT otr_token,
3349 const ipa_polymorphic_call_context &ctx)
3351 vec <cgraph_node *> targets;
3352 bool final;
3353 odr_type type = get_odr_type (TYPE_MAIN_VARIANT (otr_type), false);
3354 unsigned int len;
3356 if (!type)
3357 return;
3358 targets = possible_polymorphic_call_targets (otr_type, otr_token,
3359 ctx,
3360 &final, NULL, false);
3361 fprintf (f, " Targets of polymorphic call of type %i:", type->id);
3362 print_generic_expr (f, type->type, TDF_SLIM);
3363 fprintf (f, " token %i\n", (int)otr_token);
3365 ctx.dump (f);
3367 fprintf (f, " %s%s%s%s\n ",
3368 final ? "This is a complete list." :
3369 "This is partial list; extra targets may be defined in other units.",
3370 ctx.maybe_in_construction ? " (base types included)" : "",
3371 ctx.maybe_derived_type ? " (derived types included)" : "",
3372 ctx.speculative_maybe_derived_type ? " (speculative derived types included)" : "");
3373 len = targets.length ();
3374 dump_targets (f, targets);
3376 targets = possible_polymorphic_call_targets (otr_type, otr_token,
3377 ctx,
3378 &final, NULL, true);
3379 if (targets.length () != len)
3381 fprintf (f, " Speculative targets:");
3382 dump_targets (f, targets);
3384 /* Ugly: during callgraph construction the target cache may get populated
3385 before all targets are found. While this is harmless (because all local
3386 types are discovered and only in those case we devirtualize fully and we
3387 don't do speculative devirtualization before IPA stage) it triggers
3388 assert here when dumping at that stage also populates the case with
3389 speculative targets. Quietly ignore this. */
3390 gcc_assert (symtab->state < IPA_SSA || targets.length () <= len);
3391 fprintf (f, "\n");
3395 /* Return true if N can be possibly target of a polymorphic call of
3396 OTR_TYPE/OTR_TOKEN. */
3398 bool
3399 possible_polymorphic_call_target_p (tree otr_type,
3400 HOST_WIDE_INT otr_token,
3401 const ipa_polymorphic_call_context &ctx,
3402 struct cgraph_node *n)
3404 vec <cgraph_node *> targets;
3405 unsigned int i;
3406 enum built_in_function fcode;
3407 bool final;
3409 if (TREE_CODE (TREE_TYPE (n->decl)) == FUNCTION_TYPE
3410 && ((fcode = DECL_FUNCTION_CODE (n->decl)) == BUILT_IN_UNREACHABLE
3411 || fcode == BUILT_IN_TRAP))
3412 return true;
3414 if (is_cxa_pure_virtual_p (n->decl))
3415 return true;
3417 if (!odr_hash)
3418 return true;
3419 targets = possible_polymorphic_call_targets (otr_type, otr_token, ctx, &final);
3420 for (i = 0; i < targets.length (); i++)
3421 if (n->semantically_equivalent_p (targets[i]))
3422 return true;
3424 /* At a moment we allow middle end to dig out new external declarations
3425 as a targets of polymorphic calls. */
3426 if (!final && !n->definition)
3427 return true;
3428 return false;
3433 /* Return true if N can be possibly target of a polymorphic call of
3434 OBJ_TYPE_REF expression REF in STMT. */
3436 bool
3437 possible_polymorphic_call_target_p (tree ref,
3438 gimple *stmt,
3439 struct cgraph_node *n)
3441 ipa_polymorphic_call_context context (current_function_decl, ref, stmt);
3442 tree call_fn = gimple_call_fn (stmt);
3444 return possible_polymorphic_call_target_p (obj_type_ref_class (call_fn),
3445 tree_to_uhwi
3446 (OBJ_TYPE_REF_TOKEN (call_fn)),
3447 context,
3452 /* After callgraph construction new external nodes may appear.
3453 Add them into the graph. */
3455 void
3456 update_type_inheritance_graph (void)
3458 struct cgraph_node *n;
3460 if (!odr_hash)
3461 return;
3462 free_polymorphic_call_targets_hash ();
3463 timevar_push (TV_IPA_INHERITANCE);
3464 /* We reconstruct the graph starting from types of all methods seen in the
3465 unit. */
3466 FOR_EACH_FUNCTION (n)
3467 if (DECL_VIRTUAL_P (n->decl)
3468 && !n->definition
3469 && n->real_symbol_p ())
3470 get_odr_type (TYPE_METHOD_BASETYPE (TREE_TYPE (n->decl)), true);
3471 timevar_pop (TV_IPA_INHERITANCE);
3475 /* Return true if N looks like likely target of a polymorphic call.
3476 Rule out cxa_pure_virtual, noreturns, function declared cold and
3477 other obvious cases. */
3479 bool
3480 likely_target_p (struct cgraph_node *n)
3482 int flags;
3483 /* cxa_pure_virtual and similar things are not likely. */
3484 if (TREE_CODE (TREE_TYPE (n->decl)) != METHOD_TYPE)
3485 return false;
3486 flags = flags_from_decl_or_type (n->decl);
3487 if (flags & ECF_NORETURN)
3488 return false;
3489 if (lookup_attribute ("cold",
3490 DECL_ATTRIBUTES (n->decl)))
3491 return false;
3492 if (n->frequency < NODE_FREQUENCY_NORMAL)
3493 return false;
3494 /* If there are no live virtual tables referring the target,
3495 the only way the target can be called is an instance coming from other
3496 compilation unit; speculative devirtualization is built around an
3497 assumption that won't happen. */
3498 if (!referenced_from_vtable_p (n))
3499 return false;
3500 return true;
3503 /* Compare type warning records P1 and P2 and choose one with larger count;
3504 helper for qsort. */
3507 type_warning_cmp (const void *p1, const void *p2)
3509 const odr_type_warn_count *t1 = (const odr_type_warn_count *)p1;
3510 const odr_type_warn_count *t2 = (const odr_type_warn_count *)p2;
3512 if (t1->dyn_count < t2->dyn_count)
3513 return 1;
3514 if (t1->dyn_count > t2->dyn_count)
3515 return -1;
3516 return t2->count - t1->count;
3519 /* Compare decl warning records P1 and P2 and choose one with larger count;
3520 helper for qsort. */
3523 decl_warning_cmp (const void *p1, const void *p2)
3525 const decl_warn_count *t1 = *(const decl_warn_count * const *)p1;
3526 const decl_warn_count *t2 = *(const decl_warn_count * const *)p2;
3528 if (t1->dyn_count < t2->dyn_count)
3529 return 1;
3530 if (t1->dyn_count > t2->dyn_count)
3531 return -1;
3532 return t2->count - t1->count;
3536 /* Try to speculatively devirtualize call to OTR_TYPE with OTR_TOKEN with
3537 context CTX. */
3539 struct cgraph_node *
3540 try_speculative_devirtualization (tree otr_type, HOST_WIDE_INT otr_token,
3541 ipa_polymorphic_call_context ctx)
3543 vec <cgraph_node *>targets
3544 = possible_polymorphic_call_targets
3545 (otr_type, otr_token, ctx, NULL, NULL, true);
3546 unsigned int i;
3547 struct cgraph_node *likely_target = NULL;
3549 for (i = 0; i < targets.length (); i++)
3550 if (likely_target_p (targets[i]))
3552 if (likely_target)
3553 return NULL;
3554 likely_target = targets[i];
3556 if (!likely_target
3557 ||!likely_target->definition
3558 || DECL_EXTERNAL (likely_target->decl))
3559 return NULL;
3561 /* Don't use an implicitly-declared destructor (c++/58678). */
3562 struct cgraph_node *non_thunk_target
3563 = likely_target->function_symbol ();
3564 if (DECL_ARTIFICIAL (non_thunk_target->decl))
3565 return NULL;
3566 if (likely_target->get_availability () <= AVAIL_INTERPOSABLE
3567 && likely_target->can_be_discarded_p ())
3568 return NULL;
3569 return likely_target;
3572 /* The ipa-devirt pass.
3573 When polymorphic call has only one likely target in the unit,
3574 turn it into a speculative call. */
3576 static unsigned int
3577 ipa_devirt (void)
3579 struct cgraph_node *n;
3580 hash_set<void *> bad_call_targets;
3581 struct cgraph_edge *e;
3583 int npolymorphic = 0, nspeculated = 0, nconverted = 0, ncold = 0;
3584 int nmultiple = 0, noverwritable = 0, ndevirtualized = 0, nnotdefined = 0;
3585 int nwrong = 0, nok = 0, nexternal = 0, nartificial = 0;
3586 int ndropped = 0;
3588 if (!odr_types_ptr)
3589 return 0;
3591 if (dump_file)
3592 dump_type_inheritance_graph (dump_file);
3594 /* We can output -Wsuggest-final-methods and -Wsuggest-final-types warnings.
3595 This is implemented by setting up final_warning_records that are updated
3596 by get_polymorphic_call_targets.
3597 We need to clear cache in this case to trigger recomputation of all
3598 entries. */
3599 if (warn_suggest_final_methods || warn_suggest_final_types)
3601 final_warning_records = new (final_warning_record);
3602 final_warning_records->dyn_count = profile_count::zero ();
3603 final_warning_records->grow_type_warnings (odr_types.length ());
3604 free_polymorphic_call_targets_hash ();
3607 FOR_EACH_DEFINED_FUNCTION (n)
3609 bool update = false;
3610 if (!opt_for_fn (n->decl, flag_devirtualize))
3611 continue;
3612 if (dump_file && n->indirect_calls)
3613 fprintf (dump_file, "\n\nProcesing function %s\n",
3614 n->dump_name ());
3615 for (e = n->indirect_calls; e; e = e->next_callee)
3616 if (e->indirect_info->polymorphic)
3618 struct cgraph_node *likely_target = NULL;
3619 void *cache_token;
3620 bool final;
3622 if (final_warning_records)
3623 final_warning_records->dyn_count = e->count.ipa ();
3625 vec <cgraph_node *>targets
3626 = possible_polymorphic_call_targets
3627 (e, &final, &cache_token, true);
3628 unsigned int i;
3630 /* Trigger warnings by calculating non-speculative targets. */
3631 if (warn_suggest_final_methods || warn_suggest_final_types)
3632 possible_polymorphic_call_targets (e);
3634 if (dump_file)
3635 dump_possible_polymorphic_call_targets
3636 (dump_file, e);
3638 npolymorphic++;
3640 /* See if the call can be devirtualized by means of ipa-prop's
3641 polymorphic call context propagation. If not, we can just
3642 forget about this call being polymorphic and avoid some heavy
3643 lifting in remove_unreachable_nodes that will otherwise try to
3644 keep all possible targets alive until inlining and in the inliner
3645 itself.
3647 This may need to be revisited once we add further ways to use
3648 the may edges, but it is a resonable thing to do right now. */
3650 if ((e->indirect_info->param_index == -1
3651 || (!opt_for_fn (n->decl, flag_devirtualize_speculatively)
3652 && e->indirect_info->vptr_changed))
3653 && !flag_ltrans_devirtualize)
3655 e->indirect_info->polymorphic = false;
3656 ndropped++;
3657 if (dump_file)
3658 fprintf (dump_file, "Dropping polymorphic call info;"
3659 " it can not be used by ipa-prop\n");
3662 if (!opt_for_fn (n->decl, flag_devirtualize_speculatively))
3663 continue;
3665 if (!e->maybe_hot_p ())
3667 if (dump_file)
3668 fprintf (dump_file, "Call is cold\n\n");
3669 ncold++;
3670 continue;
3672 if (e->speculative)
3674 if (dump_file)
3675 fprintf (dump_file, "Call is already speculated\n\n");
3676 nspeculated++;
3678 /* When dumping see if we agree with speculation. */
3679 if (!dump_file)
3680 continue;
3682 if (bad_call_targets.contains (cache_token))
3684 if (dump_file)
3685 fprintf (dump_file, "Target list is known to be useless\n\n");
3686 nmultiple++;
3687 continue;
3689 for (i = 0; i < targets.length (); i++)
3690 if (likely_target_p (targets[i]))
3692 if (likely_target)
3694 likely_target = NULL;
3695 if (dump_file)
3696 fprintf (dump_file, "More than one likely target\n\n");
3697 nmultiple++;
3698 break;
3700 likely_target = targets[i];
3702 if (!likely_target)
3704 bad_call_targets.add (cache_token);
3705 continue;
3707 /* This is reached only when dumping; check if we agree or disagree
3708 with the speculation. */
3709 if (e->speculative)
3711 struct cgraph_edge *e2;
3712 struct ipa_ref *ref;
3713 e->speculative_call_info (e2, e, ref);
3714 if (e2->callee->ultimate_alias_target ()
3715 == likely_target->ultimate_alias_target ())
3717 fprintf (dump_file, "We agree with speculation\n\n");
3718 nok++;
3720 else
3722 fprintf (dump_file, "We disagree with speculation\n\n");
3723 nwrong++;
3725 continue;
3727 if (!likely_target->definition)
3729 if (dump_file)
3730 fprintf (dump_file, "Target is not a definition\n\n");
3731 nnotdefined++;
3732 continue;
3734 /* Do not introduce new references to external symbols. While we
3735 can handle these just well, it is common for programs to
3736 incorrectly with headers defining methods they are linked
3737 with. */
3738 if (DECL_EXTERNAL (likely_target->decl))
3740 if (dump_file)
3741 fprintf (dump_file, "Target is external\n\n");
3742 nexternal++;
3743 continue;
3745 /* Don't use an implicitly-declared destructor (c++/58678). */
3746 struct cgraph_node *non_thunk_target
3747 = likely_target->function_symbol ();
3748 if (DECL_ARTIFICIAL (non_thunk_target->decl))
3750 if (dump_file)
3751 fprintf (dump_file, "Target is artificial\n\n");
3752 nartificial++;
3753 continue;
3755 if (likely_target->get_availability () <= AVAIL_INTERPOSABLE
3756 && likely_target->can_be_discarded_p ())
3758 if (dump_file)
3759 fprintf (dump_file, "Target is overwritable\n\n");
3760 noverwritable++;
3761 continue;
3763 else if (dbg_cnt (devirt))
3765 if (dump_enabled_p ())
3767 dump_printf_loc (MSG_OPTIMIZED_LOCATIONS, e->call_stmt,
3768 "speculatively devirtualizing call "
3769 "in %s to %s\n",
3770 n->dump_name (),
3771 likely_target->dump_name ());
3773 if (!likely_target->can_be_discarded_p ())
3775 cgraph_node *alias;
3776 alias = dyn_cast<cgraph_node *> (likely_target->noninterposable_alias ());
3777 if (alias)
3778 likely_target = alias;
3780 nconverted++;
3781 update = true;
3782 e->make_speculative
3783 (likely_target, e->count.apply_scale (8, 10));
3786 if (update)
3787 ipa_update_overall_fn_summary (n);
3789 if (warn_suggest_final_methods || warn_suggest_final_types)
3791 if (warn_suggest_final_types)
3793 final_warning_records->type_warnings.qsort (type_warning_cmp);
3794 for (unsigned int i = 0;
3795 i < final_warning_records->type_warnings.length (); i++)
3796 if (final_warning_records->type_warnings[i].count)
3798 tree type = final_warning_records->type_warnings[i].type;
3799 int count = final_warning_records->type_warnings[i].count;
3800 profile_count dyn_count
3801 = final_warning_records->type_warnings[i].dyn_count;
3803 if (!(dyn_count > 0))
3804 warning_n (DECL_SOURCE_LOCATION (TYPE_NAME (type)),
3805 OPT_Wsuggest_final_types, count,
3806 "Declaring type %qD final "
3807 "would enable devirtualization of %i call",
3808 "Declaring type %qD final "
3809 "would enable devirtualization of %i calls",
3810 type,
3811 count);
3812 else
3813 warning_n (DECL_SOURCE_LOCATION (TYPE_NAME (type)),
3814 OPT_Wsuggest_final_types, count,
3815 "Declaring type %qD final "
3816 "would enable devirtualization of %i call "
3817 "executed %lli times",
3818 "Declaring type %qD final "
3819 "would enable devirtualization of %i calls "
3820 "executed %lli times",
3821 type,
3822 count,
3823 (long long) dyn_count.to_gcov_type ());
3827 if (warn_suggest_final_methods)
3829 auto_vec<const decl_warn_count*> decl_warnings_vec;
3831 final_warning_records->decl_warnings.traverse
3832 <vec<const decl_warn_count *> *, add_decl_warning> (&decl_warnings_vec);
3833 decl_warnings_vec.qsort (decl_warning_cmp);
3834 for (unsigned int i = 0; i < decl_warnings_vec.length (); i++)
3836 tree decl = decl_warnings_vec[i]->decl;
3837 int count = decl_warnings_vec[i]->count;
3838 profile_count dyn_count
3839 = decl_warnings_vec[i]->dyn_count;
3841 if (!(dyn_count > 0))
3842 if (DECL_CXX_DESTRUCTOR_P (decl))
3843 warning_n (DECL_SOURCE_LOCATION (decl),
3844 OPT_Wsuggest_final_methods, count,
3845 "Declaring virtual destructor of %qD final "
3846 "would enable devirtualization of %i call",
3847 "Declaring virtual destructor of %qD final "
3848 "would enable devirtualization of %i calls",
3849 DECL_CONTEXT (decl), count);
3850 else
3851 warning_n (DECL_SOURCE_LOCATION (decl),
3852 OPT_Wsuggest_final_methods, count,
3853 "Declaring method %qD final "
3854 "would enable devirtualization of %i call",
3855 "Declaring method %qD final "
3856 "would enable devirtualization of %i calls",
3857 decl, count);
3858 else if (DECL_CXX_DESTRUCTOR_P (decl))
3859 warning_n (DECL_SOURCE_LOCATION (decl),
3860 OPT_Wsuggest_final_methods, count,
3861 "Declaring virtual destructor of %qD final "
3862 "would enable devirtualization of %i call "
3863 "executed %lli times",
3864 "Declaring virtual destructor of %qD final "
3865 "would enable devirtualization of %i calls "
3866 "executed %lli times",
3867 DECL_CONTEXT (decl), count,
3868 (long long)dyn_count.to_gcov_type ());
3869 else
3870 warning_n (DECL_SOURCE_LOCATION (decl),
3871 OPT_Wsuggest_final_methods, count,
3872 "Declaring method %qD final "
3873 "would enable devirtualization of %i call "
3874 "executed %lli times",
3875 "Declaring method %qD final "
3876 "would enable devirtualization of %i calls "
3877 "executed %lli times",
3878 decl, count,
3879 (long long)dyn_count.to_gcov_type ());
3883 delete (final_warning_records);
3884 final_warning_records = 0;
3887 if (dump_file)
3888 fprintf (dump_file,
3889 "%i polymorphic calls, %i devirtualized,"
3890 " %i speculatively devirtualized, %i cold\n"
3891 "%i have multiple targets, %i overwritable,"
3892 " %i already speculated (%i agree, %i disagree),"
3893 " %i external, %i not defined, %i artificial, %i infos dropped\n",
3894 npolymorphic, ndevirtualized, nconverted, ncold,
3895 nmultiple, noverwritable, nspeculated, nok, nwrong,
3896 nexternal, nnotdefined, nartificial, ndropped);
3897 return ndevirtualized || ndropped ? TODO_remove_functions : 0;
3900 namespace {
3902 const pass_data pass_data_ipa_devirt =
3904 IPA_PASS, /* type */
3905 "devirt", /* name */
3906 OPTGROUP_NONE, /* optinfo_flags */
3907 TV_IPA_DEVIRT, /* tv_id */
3908 0, /* properties_required */
3909 0, /* properties_provided */
3910 0, /* properties_destroyed */
3911 0, /* todo_flags_start */
3912 ( TODO_dump_symtab ), /* todo_flags_finish */
3915 class pass_ipa_devirt : public ipa_opt_pass_d
3917 public:
3918 pass_ipa_devirt (gcc::context *ctxt)
3919 : ipa_opt_pass_d (pass_data_ipa_devirt, ctxt,
3920 NULL, /* generate_summary */
3921 NULL, /* write_summary */
3922 NULL, /* read_summary */
3923 NULL, /* write_optimization_summary */
3924 NULL, /* read_optimization_summary */
3925 NULL, /* stmt_fixup */
3926 0, /* function_transform_todo_flags_start */
3927 NULL, /* function_transform */
3928 NULL) /* variable_transform */
3931 /* opt_pass methods: */
3932 virtual bool gate (function *)
3934 /* In LTO, always run the IPA passes and decide on function basis if the
3935 pass is enabled. */
3936 if (in_lto_p)
3937 return true;
3938 return (flag_devirtualize
3939 && (flag_devirtualize_speculatively
3940 || (warn_suggest_final_methods
3941 || warn_suggest_final_types))
3942 && optimize);
3945 virtual unsigned int execute (function *) { return ipa_devirt (); }
3947 }; // class pass_ipa_devirt
3949 } // anon namespace
3951 ipa_opt_pass_d *
3952 make_pass_ipa_devirt (gcc::context *ctxt)
3954 return new pass_ipa_devirt (ctxt);
3957 #include "gt-ipa-devirt.h"