2018-02-09 Sebastian Perta <sebastian.perta@renesas.com>
[official-gcc.git] / gcc / ipa-devirt.c
blobf66dc45deb8668372b620d2348c39bef835f8c90
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 T2 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 if (warning_at (DECL_SOURCE_LOCATION
753 (TYPE_NAME (DECL_CONTEXT (vtable->decl))),
754 OPT_Wodr,
755 "virtual table of type %qD violates one definition rule",
756 DECL_CONTEXT (vtable->decl)))
757 inform (DECL_SOURCE_LOCATION (prevailing->decl),
758 "variable of same assembler name as the virtual table is "
759 "defined in another translation unit");
760 return;
762 if (!prevailing->definition || !vtable->definition)
763 return;
765 /* If we do not stream ODR type info, do not bother to do useful compare. */
766 if (!TYPE_BINFO (DECL_CONTEXT (vtable->decl))
767 || !polymorphic_type_binfo_p (TYPE_BINFO (DECL_CONTEXT (vtable->decl))))
768 return;
770 odr_type class_type = get_odr_type (DECL_CONTEXT (vtable->decl), true);
772 if (class_type->odr_violated)
773 return;
775 for (n1 = 0, n2 = 0; true; n1++, n2++)
777 struct ipa_ref *ref1, *ref2;
778 bool end1, end2;
780 end1 = !prevailing->iterate_reference (n1, ref1);
781 end2 = !vtable->iterate_reference (n2, ref2);
783 /* !DECL_VIRTUAL_P means RTTI entry;
784 We warn when RTTI is lost because non-RTTI previals; we silently
785 accept the other case. */
786 while (!end2
787 && (end1
788 || (methods_equal_p (ref1->referred->decl,
789 ref2->referred->decl)
790 && TREE_CODE (ref1->referred->decl) == FUNCTION_DECL))
791 && TREE_CODE (ref2->referred->decl) != FUNCTION_DECL)
793 if (!class_type->rtti_broken
794 && warning_at (DECL_SOURCE_LOCATION
795 (TYPE_NAME (DECL_CONTEXT (vtable->decl))),
796 OPT_Wodr,
797 "virtual table of type %qD contains RTTI "
798 "information",
799 DECL_CONTEXT (vtable->decl)))
801 inform (DECL_SOURCE_LOCATION
802 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
803 "but is prevailed by one without from other translation "
804 "unit");
805 inform (DECL_SOURCE_LOCATION
806 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
807 "RTTI will not work on this type");
808 class_type->rtti_broken = true;
810 n2++;
811 end2 = !vtable->iterate_reference (n2, ref2);
813 while (!end1
814 && (end2
815 || (methods_equal_p (ref2->referred->decl, ref1->referred->decl)
816 && TREE_CODE (ref2->referred->decl) == FUNCTION_DECL))
817 && TREE_CODE (ref1->referred->decl) != FUNCTION_DECL)
819 n1++;
820 end1 = !prevailing->iterate_reference (n1, ref1);
823 /* Finished? */
824 if (end1 && end2)
826 /* Extra paranoia; compare the sizes. We do not have information
827 about virtual inheritance offsets, so just be sure that these
828 match.
829 Do this as very last check so the not very informative error
830 is not output too often. */
831 if (DECL_SIZE (prevailing->decl) != DECL_SIZE (vtable->decl))
833 class_type->odr_violated = true;
834 if (warning_at (DECL_SOURCE_LOCATION
835 (TYPE_NAME (DECL_CONTEXT (vtable->decl))),
836 OPT_Wodr,
837 "virtual table of type %qD violates "
838 "one definition rule ",
839 DECL_CONTEXT (vtable->decl)))
841 inform (DECL_SOURCE_LOCATION
842 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
843 "the conflicting type defined in another translation "
844 "unit has virtual table of different size");
847 return;
850 if (!end1 && !end2)
852 if (methods_equal_p (ref1->referred->decl, ref2->referred->decl))
853 continue;
855 class_type->odr_violated = true;
857 /* If the loops above stopped on non-virtual pointer, we have
858 mismatch in RTTI information mangling. */
859 if (TREE_CODE (ref1->referred->decl) != FUNCTION_DECL
860 && TREE_CODE (ref2->referred->decl) != FUNCTION_DECL)
862 if (warning_at (DECL_SOURCE_LOCATION
863 (TYPE_NAME (DECL_CONTEXT (vtable->decl))),
864 OPT_Wodr,
865 "virtual table of type %qD violates "
866 "one definition rule ",
867 DECL_CONTEXT (vtable->decl)))
869 inform (DECL_SOURCE_LOCATION
870 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
871 "the conflicting type defined in another translation "
872 "unit with different RTTI information");
874 return;
876 /* At this point both REF1 and REF2 points either to virtual table
877 or virtual method. If one points to virtual table and other to
878 method we can complain the same way as if one table was shorter
879 than other pointing out the extra method. */
880 if (TREE_CODE (ref1->referred->decl)
881 != TREE_CODE (ref2->referred->decl))
883 if (VAR_P (ref1->referred->decl))
884 end1 = true;
885 else if (VAR_P (ref2->referred->decl))
886 end2 = true;
890 class_type->odr_violated = true;
892 /* Complain about size mismatch. Either we have too many virutal
893 functions or too many virtual table pointers. */
894 if (end1 || end2)
896 if (end1)
898 varpool_node *tmp = prevailing;
899 prevailing = vtable;
900 vtable = tmp;
901 ref1 = ref2;
903 if (warning_at (DECL_SOURCE_LOCATION
904 (TYPE_NAME (DECL_CONTEXT (vtable->decl))),
905 OPT_Wodr,
906 "virtual table of type %qD violates "
907 "one definition rule",
908 DECL_CONTEXT (vtable->decl)))
910 if (TREE_CODE (ref1->referring->decl) == FUNCTION_DECL)
912 inform (DECL_SOURCE_LOCATION
913 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
914 "the conflicting type defined in another translation "
915 "unit");
916 inform (DECL_SOURCE_LOCATION
917 (TYPE_NAME (DECL_CONTEXT (ref1->referring->decl))),
918 "contains additional virtual method %qD",
919 ref1->referred->decl);
921 else
923 inform (DECL_SOURCE_LOCATION
924 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
925 "the conflicting type defined in another translation "
926 "unit has virtual table with more entries");
929 return;
932 /* And in the last case we have either mistmatch in between two virtual
933 methods or two virtual table pointers. */
934 if (warning_at (DECL_SOURCE_LOCATION
935 (TYPE_NAME (DECL_CONTEXT (vtable->decl))), OPT_Wodr,
936 "virtual table of type %qD violates "
937 "one definition rule ",
938 DECL_CONTEXT (vtable->decl)))
940 if (TREE_CODE (ref1->referred->decl) == FUNCTION_DECL)
942 inform (DECL_SOURCE_LOCATION
943 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
944 "the conflicting type defined in another translation "
945 "unit");
946 gcc_assert (TREE_CODE (ref2->referred->decl)
947 == FUNCTION_DECL);
948 inform (DECL_SOURCE_LOCATION
949 (ref1->referred->ultimate_alias_target ()->decl),
950 "virtual method %qD",
951 ref1->referred->ultimate_alias_target ()->decl);
952 inform (DECL_SOURCE_LOCATION
953 (ref2->referred->ultimate_alias_target ()->decl),
954 "ought to match virtual method %qD but does not",
955 ref2->referred->ultimate_alias_target ()->decl);
957 else
958 inform (DECL_SOURCE_LOCATION
959 (TYPE_NAME (DECL_CONTEXT (prevailing->decl))),
960 "the conflicting type defined in another translation "
961 "unit has virtual table with different contents");
962 return;
967 /* Output ODR violation warning about T1 and T2 with REASON.
968 Display location of ST1 and ST2 if REASON speaks about field or
969 method of the type.
970 If WARN is false, do nothing. Set WARNED if warning was indeed
971 output. */
973 void
974 warn_odr (tree t1, tree t2, tree st1, tree st2,
975 bool warn, bool *warned, const char *reason)
977 tree decl2 = TYPE_NAME (t2);
978 if (warned)
979 *warned = false;
981 if (!warn || !TYPE_NAME(t1))
982 return;
984 /* ODR warnings are output druing LTO streaming; we must apply location
985 cache for potential warnings to be output correctly. */
986 if (lto_location_cache::current_cache)
987 lto_location_cache::current_cache->apply_location_cache ();
989 if (!warning_at (DECL_SOURCE_LOCATION (TYPE_NAME (t1)), OPT_Wodr,
990 "type %qT violates the C++ One Definition Rule",
991 t1))
992 return;
993 if (!st1 && !st2)
995 /* For FIELD_DECL support also case where one of fields is
996 NULL - this is used when the structures have mismatching number of
997 elements. */
998 else if (!st1 || TREE_CODE (st1) == FIELD_DECL)
1000 inform (DECL_SOURCE_LOCATION (decl2),
1001 "a different type is defined in another translation unit");
1002 if (!st1)
1004 st1 = st2;
1005 st2 = NULL;
1007 inform (DECL_SOURCE_LOCATION (st1),
1008 "the first difference of corresponding definitions is field %qD",
1009 st1);
1010 if (st2)
1011 decl2 = st2;
1013 else if (TREE_CODE (st1) == FUNCTION_DECL)
1015 inform (DECL_SOURCE_LOCATION (decl2),
1016 "a different type is defined in another translation unit");
1017 inform (DECL_SOURCE_LOCATION (st1),
1018 "the first difference of corresponding definitions is method %qD",
1019 st1);
1020 decl2 = st2;
1022 else
1023 return;
1024 inform (DECL_SOURCE_LOCATION (decl2), reason);
1026 if (warned)
1027 *warned = true;
1030 /* Return ture if T1 and T2 are incompatible and we want to recusively
1031 dive into them from warn_type_mismatch to give sensible answer. */
1033 static bool
1034 type_mismatch_p (tree t1, tree t2)
1036 if (odr_or_derived_type_p (t1) && odr_or_derived_type_p (t2)
1037 && !odr_types_equivalent_p (t1, t2))
1038 return true;
1039 return !types_compatible_p (t1, t2);
1043 /* Types T1 and T2 was found to be incompatible in a context they can't
1044 (either used to declare a symbol of same assembler name or unified by
1045 ODR rule). We already output warning about this, but if possible, output
1046 extra information on how the types mismatch.
1048 This is hard to do in general. We basically handle the common cases.
1050 If LOC1 and LOC2 are meaningful locations, use it in the case the types
1051 themselves do no thave one.*/
1053 void
1054 warn_types_mismatch (tree t1, tree t2, location_t loc1, location_t loc2)
1056 /* Location of type is known only if it has TYPE_NAME and the name is
1057 TYPE_DECL. */
1058 location_t loc_t1 = TYPE_NAME (t1) && TREE_CODE (TYPE_NAME (t1)) == TYPE_DECL
1059 ? DECL_SOURCE_LOCATION (TYPE_NAME (t1))
1060 : UNKNOWN_LOCATION;
1061 location_t loc_t2 = TYPE_NAME (t2) && TREE_CODE (TYPE_NAME (t2)) == TYPE_DECL
1062 ? DECL_SOURCE_LOCATION (TYPE_NAME (t2))
1063 : UNKNOWN_LOCATION;
1064 bool loc_t2_useful = false;
1066 /* With LTO it is a common case that the location of both types match.
1067 See if T2 has a location that is different from T1. If so, we will
1068 inform user about the location.
1069 Do not consider the location passed to us in LOC1/LOC2 as those are
1070 already output. */
1071 if (loc_t2 > BUILTINS_LOCATION && loc_t2 != loc_t1)
1073 if (loc_t1 <= BUILTINS_LOCATION)
1074 loc_t2_useful = true;
1075 else
1077 expanded_location xloc1 = expand_location (loc_t1);
1078 expanded_location xloc2 = expand_location (loc_t2);
1080 if (strcmp (xloc1.file, xloc2.file)
1081 || xloc1.line != xloc2.line
1082 || xloc1.column != xloc2.column)
1083 loc_t2_useful = true;
1087 if (loc_t1 <= BUILTINS_LOCATION)
1088 loc_t1 = loc1;
1089 if (loc_t2 <= BUILTINS_LOCATION)
1090 loc_t2 = loc2;
1092 location_t loc = loc_t1 <= BUILTINS_LOCATION ? loc_t2 : loc_t1;
1094 /* It is a quite common bug to reference anonymous namespace type in
1095 non-anonymous namespace class. */
1096 if ((type_with_linkage_p (t1) && type_in_anonymous_namespace_p (t1))
1097 || (type_with_linkage_p (t2) && type_in_anonymous_namespace_p (t2)))
1099 if (type_with_linkage_p (t1) && !type_in_anonymous_namespace_p (t1))
1101 std::swap (t1, t2);
1102 std::swap (loc_t1, loc_t2);
1104 gcc_assert (TYPE_NAME (t1) && TYPE_NAME (t2)
1105 && TREE_CODE (TYPE_NAME (t1)) == TYPE_DECL
1106 && TREE_CODE (TYPE_NAME (t2)) == TYPE_DECL);
1107 /* Most of the time, the type names will match, do not be unnecesarily
1108 verbose. */
1109 if (IDENTIFIER_POINTER (DECL_NAME (TYPE_NAME (t1)))
1110 != IDENTIFIER_POINTER (DECL_NAME (TYPE_NAME (t2))))
1111 inform (loc_t1,
1112 "type %qT defined in anonymous namespace can not match "
1113 "type %qT across the translation unit boundary",
1114 t1, t2);
1115 else
1116 inform (loc_t1,
1117 "type %qT defined in anonymous namespace can not match "
1118 "across the translation unit boundary",
1119 t1);
1120 if (loc_t2_useful)
1121 inform (loc_t2,
1122 "the incompatible type defined in another translation unit");
1123 return;
1125 /* If types have mangled ODR names and they are different, it is most
1126 informative to output those.
1127 This also covers types defined in different namespaces. */
1128 if (TYPE_NAME (t1) && TYPE_NAME (t2)
1129 && TREE_CODE (TYPE_NAME (t1)) == TYPE_DECL
1130 && TREE_CODE (TYPE_NAME (t2)) == TYPE_DECL
1131 && DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t1))
1132 && DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t2))
1133 && DECL_ASSEMBLER_NAME (TYPE_NAME (t1))
1134 != DECL_ASSEMBLER_NAME (TYPE_NAME (t2)))
1136 char *name1 = xstrdup (cplus_demangle
1137 (IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (TYPE_NAME (t1))),
1138 DMGL_PARAMS | DMGL_ANSI | DMGL_TYPES));
1139 char *name2 = cplus_demangle
1140 (IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (TYPE_NAME (t2))),
1141 DMGL_PARAMS | DMGL_ANSI | DMGL_TYPES);
1142 if (name1 && name2 && strcmp (name1, name2))
1144 inform (loc_t1,
1145 "type name %qs should match type name %qs",
1146 name1, name2);
1147 if (loc_t2_useful)
1148 inform (loc_t2,
1149 "the incompatible type is defined here");
1150 free (name1);
1151 return;
1153 free (name1);
1155 /* A tricky case are compound types. Often they appear the same in source
1156 code and the mismatch is dragged in by type they are build from.
1157 Look for those differences in subtypes and try to be informative. In other
1158 cases just output nothing because the source code is probably different
1159 and in this case we already output a all necessary info. */
1160 if (!TYPE_NAME (t1) || !TYPE_NAME (t2))
1162 if (TREE_CODE (t1) == TREE_CODE (t2))
1164 if (TREE_CODE (t1) == ARRAY_TYPE
1165 && COMPLETE_TYPE_P (t1) && COMPLETE_TYPE_P (t2))
1167 tree i1 = TYPE_DOMAIN (t1);
1168 tree i2 = TYPE_DOMAIN (t2);
1170 if (i1 && i2
1171 && TYPE_MAX_VALUE (i1)
1172 && TYPE_MAX_VALUE (i2)
1173 && !operand_equal_p (TYPE_MAX_VALUE (i1),
1174 TYPE_MAX_VALUE (i2), 0))
1176 inform (loc,
1177 "array types have different bounds");
1178 return;
1181 if ((POINTER_TYPE_P (t1) || TREE_CODE (t1) == ARRAY_TYPE)
1182 && type_mismatch_p (TREE_TYPE (t1), TREE_TYPE (t2)))
1183 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2), loc_t1, loc_t2);
1184 else if (TREE_CODE (t1) == METHOD_TYPE
1185 || TREE_CODE (t1) == FUNCTION_TYPE)
1187 tree parms1 = NULL, parms2 = NULL;
1188 int count = 1;
1190 if (type_mismatch_p (TREE_TYPE (t1), TREE_TYPE (t2)))
1192 inform (loc, "return value type mismatch");
1193 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2), loc_t1,
1194 loc_t2);
1195 return;
1197 if (prototype_p (t1) && prototype_p (t2))
1198 for (parms1 = TYPE_ARG_TYPES (t1), parms2 = TYPE_ARG_TYPES (t2);
1199 parms1 && parms2;
1200 parms1 = TREE_CHAIN (parms1), parms2 = TREE_CHAIN (parms2),
1201 count++)
1203 if (type_mismatch_p (TREE_VALUE (parms1), TREE_VALUE (parms2)))
1205 if (count == 1 && TREE_CODE (t1) == METHOD_TYPE)
1206 inform (loc,
1207 "implicit this pointer type mismatch");
1208 else
1209 inform (loc,
1210 "type mismatch in parameter %i",
1211 count - (TREE_CODE (t1) == METHOD_TYPE));
1212 warn_types_mismatch (TREE_VALUE (parms1),
1213 TREE_VALUE (parms2),
1214 loc_t1, loc_t2);
1215 return;
1218 if (parms1 || parms2)
1220 inform (loc,
1221 "types have different parameter counts");
1222 return;
1226 return;
1229 if (types_odr_comparable (t1, t2, true)
1230 && types_same_for_odr (t1, t2, true))
1231 inform (loc_t1,
1232 "type %qT itself violates the C++ One Definition Rule", t1);
1233 /* Prevent pointless warnings like "struct aa" should match "struct aa". */
1234 else if (TYPE_NAME (t1) == TYPE_NAME (t2)
1235 && TREE_CODE (t1) == TREE_CODE (t2) && !loc_t2_useful)
1236 return;
1237 else
1238 inform (loc_t1, "type %qT should match type %qT",
1239 t1, t2);
1240 if (loc_t2_useful)
1241 inform (loc_t2, "the incompatible type is defined here");
1244 /* Compare T1 and T2, report ODR violations if WARN is true and set
1245 WARNED to true if anything is reported. Return true if types match.
1246 If true is returned, the types are also compatible in the sense of
1247 gimple_canonical_types_compatible_p.
1248 If LOC1 and LOC2 is not UNKNOWN_LOCATION it may be used to output a warning
1249 about the type if the type itself do not have location. */
1251 static bool
1252 odr_types_equivalent_p (tree t1, tree t2, bool warn, bool *warned,
1253 hash_set<type_pair> *visited,
1254 location_t loc1, location_t loc2)
1256 /* Check first for the obvious case of pointer identity. */
1257 if (t1 == t2)
1258 return true;
1259 gcc_assert (!type_with_linkage_p (t1) || !type_in_anonymous_namespace_p (t1));
1260 gcc_assert (!type_with_linkage_p (t2) || !type_in_anonymous_namespace_p (t2));
1262 /* Can't be the same type if the types don't have the same code. */
1263 if (TREE_CODE (t1) != TREE_CODE (t2))
1265 warn_odr (t1, t2, NULL, NULL, warn, warned,
1266 G_("a different type is defined in another translation unit"));
1267 return false;
1270 if (TYPE_QUALS (t1) != TYPE_QUALS (t2))
1272 warn_odr (t1, t2, NULL, NULL, warn, warned,
1273 G_("a type with different qualifiers is defined in another "
1274 "translation unit"));
1275 return false;
1278 if ((type_with_linkage_p (t1) && type_in_anonymous_namespace_p (t1))
1279 || (type_with_linkage_p (t2) && type_in_anonymous_namespace_p (t2)))
1281 /* We can not trip this when comparing ODR types, only when trying to
1282 match different ODR derivations from different declarations.
1283 So WARN should be always false. */
1284 gcc_assert (!warn);
1285 return false;
1288 if (comp_type_attributes (t1, t2) != 1)
1290 warn_odr (t1, t2, NULL, NULL, warn, warned,
1291 G_("a type with different attributes "
1292 "is defined in another translation unit"));
1293 return false;
1296 if (TREE_CODE (t1) == ENUMERAL_TYPE
1297 && TYPE_VALUES (t1) && TYPE_VALUES (t2))
1299 tree v1, v2;
1300 for (v1 = TYPE_VALUES (t1), v2 = TYPE_VALUES (t2);
1301 v1 && v2 ; v1 = TREE_CHAIN (v1), v2 = TREE_CHAIN (v2))
1303 if (TREE_PURPOSE (v1) != TREE_PURPOSE (v2))
1305 warn_odr (t1, t2, NULL, NULL, warn, warned,
1306 G_("an enum with different value name"
1307 " is defined in another translation unit"));
1308 return false;
1310 if (TREE_VALUE (v1) != TREE_VALUE (v2)
1311 && !operand_equal_p (DECL_INITIAL (TREE_VALUE (v1)),
1312 DECL_INITIAL (TREE_VALUE (v2)), 0))
1314 warn_odr (t1, t2, NULL, NULL, warn, warned,
1315 G_("an enum with different values is defined"
1316 " in another translation unit"));
1317 return false;
1320 if (v1 || v2)
1322 warn_odr (t1, t2, NULL, NULL, warn, warned,
1323 G_("an enum with mismatching number of values "
1324 "is defined in another translation unit"));
1325 return false;
1329 /* Non-aggregate types can be handled cheaply. */
1330 if (INTEGRAL_TYPE_P (t1)
1331 || SCALAR_FLOAT_TYPE_P (t1)
1332 || FIXED_POINT_TYPE_P (t1)
1333 || TREE_CODE (t1) == VECTOR_TYPE
1334 || TREE_CODE (t1) == COMPLEX_TYPE
1335 || TREE_CODE (t1) == OFFSET_TYPE
1336 || POINTER_TYPE_P (t1))
1338 if (TYPE_PRECISION (t1) != TYPE_PRECISION (t2))
1340 warn_odr (t1, t2, NULL, NULL, warn, warned,
1341 G_("a type with different precision is defined "
1342 "in another translation unit"));
1343 return false;
1345 if (TYPE_UNSIGNED (t1) != TYPE_UNSIGNED (t2))
1347 warn_odr (t1, t2, NULL, NULL, warn, warned,
1348 G_("a type with different signedness is defined "
1349 "in another translation unit"));
1350 return false;
1353 if (TREE_CODE (t1) == INTEGER_TYPE
1354 && TYPE_STRING_FLAG (t1) != TYPE_STRING_FLAG (t2))
1356 /* char WRT uint_8? */
1357 warn_odr (t1, t2, NULL, NULL, warn, warned,
1358 G_("a different type is defined in another "
1359 "translation unit"));
1360 return false;
1363 /* For canonical type comparisons we do not want to build SCCs
1364 so we cannot compare pointed-to types. But we can, for now,
1365 require the same pointed-to type kind and match what
1366 useless_type_conversion_p would do. */
1367 if (POINTER_TYPE_P (t1))
1369 if (TYPE_ADDR_SPACE (TREE_TYPE (t1))
1370 != TYPE_ADDR_SPACE (TREE_TYPE (t2)))
1372 warn_odr (t1, t2, NULL, NULL, warn, warned,
1373 G_("it is defined as a pointer in different address "
1374 "space in another translation unit"));
1375 return false;
1378 if (!odr_subtypes_equivalent_p (TREE_TYPE (t1), TREE_TYPE (t2),
1379 visited, loc1, loc2))
1381 warn_odr (t1, t2, NULL, NULL, warn, warned,
1382 G_("it is defined as a pointer to different type "
1383 "in another translation unit"));
1384 if (warn && warned)
1385 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2),
1386 loc1, loc2);
1387 return false;
1391 if ((TREE_CODE (t1) == VECTOR_TYPE || TREE_CODE (t1) == COMPLEX_TYPE)
1392 && !odr_subtypes_equivalent_p (TREE_TYPE (t1), TREE_TYPE (t2),
1393 visited, loc1, loc2))
1395 /* Probably specific enough. */
1396 warn_odr (t1, t2, NULL, NULL, warn, warned,
1397 G_("a different type is defined "
1398 "in another translation unit"));
1399 if (warn && warned)
1400 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2), loc1, loc2);
1401 return false;
1404 /* Do type-specific comparisons. */
1405 else switch (TREE_CODE (t1))
1407 case ARRAY_TYPE:
1409 /* Array types are the same if the element types are the same and
1410 the number of elements are the same. */
1411 if (!odr_subtypes_equivalent_p (TREE_TYPE (t1), TREE_TYPE (t2),
1412 visited, loc1, loc2))
1414 warn_odr (t1, t2, NULL, NULL, warn, warned,
1415 G_("a different type is defined in another "
1416 "translation unit"));
1417 if (warn && warned)
1418 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2), loc1, loc2);
1420 gcc_assert (TYPE_STRING_FLAG (t1) == TYPE_STRING_FLAG (t2));
1421 gcc_assert (TYPE_NONALIASED_COMPONENT (t1)
1422 == TYPE_NONALIASED_COMPONENT (t2));
1424 tree i1 = TYPE_DOMAIN (t1);
1425 tree i2 = TYPE_DOMAIN (t2);
1427 /* For an incomplete external array, the type domain can be
1428 NULL_TREE. Check this condition also. */
1429 if (i1 == NULL_TREE || i2 == NULL_TREE)
1430 return true;
1432 tree min1 = TYPE_MIN_VALUE (i1);
1433 tree min2 = TYPE_MIN_VALUE (i2);
1434 tree max1 = TYPE_MAX_VALUE (i1);
1435 tree max2 = TYPE_MAX_VALUE (i2);
1437 /* In C++, minimums should be always 0. */
1438 gcc_assert (min1 == min2);
1439 if (!operand_equal_p (max1, max2, 0))
1441 warn_odr (t1, t2, NULL, NULL, warn, warned,
1442 G_("an array of different size is defined "
1443 "in another translation unit"));
1444 return false;
1447 break;
1449 case METHOD_TYPE:
1450 case FUNCTION_TYPE:
1451 /* Function types are the same if the return type and arguments types
1452 are the same. */
1453 if (!odr_subtypes_equivalent_p (TREE_TYPE (t1), TREE_TYPE (t2),
1454 visited, loc1, loc2))
1456 warn_odr (t1, t2, NULL, NULL, warn, warned,
1457 G_("has different return value "
1458 "in another translation unit"));
1459 if (warn && warned)
1460 warn_types_mismatch (TREE_TYPE (t1), TREE_TYPE (t2), loc1, loc2);
1461 return false;
1464 if (TYPE_ARG_TYPES (t1) == TYPE_ARG_TYPES (t2)
1465 || !prototype_p (t1) || !prototype_p (t2))
1466 return true;
1467 else
1469 tree parms1, parms2;
1471 for (parms1 = TYPE_ARG_TYPES (t1), parms2 = TYPE_ARG_TYPES (t2);
1472 parms1 && parms2;
1473 parms1 = TREE_CHAIN (parms1), parms2 = TREE_CHAIN (parms2))
1475 if (!odr_subtypes_equivalent_p
1476 (TREE_VALUE (parms1), TREE_VALUE (parms2), visited,
1477 loc1, loc2))
1479 warn_odr (t1, t2, NULL, NULL, warn, warned,
1480 G_("has different parameters in another "
1481 "translation unit"));
1482 if (warn && warned)
1483 warn_types_mismatch (TREE_VALUE (parms1),
1484 TREE_VALUE (parms2), loc1, loc2);
1485 return false;
1489 if (parms1 || parms2)
1491 warn_odr (t1, t2, NULL, NULL, warn, warned,
1492 G_("has different parameters "
1493 "in another translation unit"));
1494 return false;
1497 return true;
1500 case RECORD_TYPE:
1501 case UNION_TYPE:
1502 case QUAL_UNION_TYPE:
1504 tree f1, f2;
1506 /* For aggregate types, all the fields must be the same. */
1507 if (COMPLETE_TYPE_P (t1) && COMPLETE_TYPE_P (t2))
1509 if (TYPE_BINFO (t1) && TYPE_BINFO (t2)
1510 && polymorphic_type_binfo_p (TYPE_BINFO (t1))
1511 != polymorphic_type_binfo_p (TYPE_BINFO (t2)))
1513 if (polymorphic_type_binfo_p (TYPE_BINFO (t1)))
1514 warn_odr (t1, t2, NULL, NULL, warn, warned,
1515 G_("a type defined in another translation unit "
1516 "is not polymorphic"));
1517 else
1518 warn_odr (t1, t2, NULL, NULL, warn, warned,
1519 G_("a type defined in another translation unit "
1520 "is polymorphic"));
1521 return false;
1523 for (f1 = TYPE_FIELDS (t1), f2 = TYPE_FIELDS (t2);
1524 f1 || f2;
1525 f1 = TREE_CHAIN (f1), f2 = TREE_CHAIN (f2))
1527 /* Skip non-fields. */
1528 while (f1 && TREE_CODE (f1) != FIELD_DECL)
1529 f1 = TREE_CHAIN (f1);
1530 while (f2 && TREE_CODE (f2) != FIELD_DECL)
1531 f2 = TREE_CHAIN (f2);
1532 if (!f1 || !f2)
1533 break;
1534 if (DECL_VIRTUAL_P (f1) != DECL_VIRTUAL_P (f2))
1536 warn_odr (t1, t2, NULL, NULL, warn, warned,
1537 G_("a type with different virtual table pointers"
1538 " is defined in another translation unit"));
1539 return false;
1541 if (DECL_ARTIFICIAL (f1) != DECL_ARTIFICIAL (f2))
1543 warn_odr (t1, t2, NULL, NULL, warn, warned,
1544 G_("a type with different bases is defined "
1545 "in another translation unit"));
1546 return false;
1548 if (DECL_NAME (f1) != DECL_NAME (f2)
1549 && !DECL_ARTIFICIAL (f1))
1551 warn_odr (t1, t2, f1, f2, warn, warned,
1552 G_("a field with different name is defined "
1553 "in another translation unit"));
1554 return false;
1556 if (!odr_subtypes_equivalent_p (TREE_TYPE (f1),
1557 TREE_TYPE (f2), visited,
1558 loc1, loc2))
1560 /* Do not warn about artificial fields and just go into
1561 generic field mismatch warning. */
1562 if (DECL_ARTIFICIAL (f1))
1563 break;
1565 warn_odr (t1, t2, f1, f2, warn, warned,
1566 G_("a field of same name but different type "
1567 "is defined in another translation unit"));
1568 if (warn && warned)
1569 warn_types_mismatch (TREE_TYPE (f1), TREE_TYPE (f2), loc1, loc2);
1570 return false;
1572 if (!gimple_compare_field_offset (f1, f2))
1574 /* Do not warn about artificial fields and just go into
1575 generic field mismatch warning. */
1576 if (DECL_ARTIFICIAL (f1))
1577 break;
1578 warn_odr (t1, t2, f1, f2, warn, warned,
1579 G_("fields have different layout "
1580 "in another translation unit"));
1581 return false;
1583 gcc_assert (DECL_NONADDRESSABLE_P (f1)
1584 == DECL_NONADDRESSABLE_P (f2));
1587 /* If one aggregate has more fields than the other, they
1588 are not the same. */
1589 if (f1 || f2)
1591 if ((f1 && DECL_VIRTUAL_P (f1)) || (f2 && DECL_VIRTUAL_P (f2)))
1592 warn_odr (t1, t2, NULL, NULL, warn, warned,
1593 G_("a type with different virtual table pointers"
1594 " is defined in another translation unit"));
1595 else if ((f1 && DECL_ARTIFICIAL (f1))
1596 || (f2 && DECL_ARTIFICIAL (f2)))
1597 warn_odr (t1, t2, NULL, NULL, warn, warned,
1598 G_("a type with different bases is defined "
1599 "in another translation unit"));
1600 else
1601 warn_odr (t1, t2, f1, f2, warn, warned,
1602 G_("a type with different number of fields "
1603 "is defined in another translation unit"));
1605 return false;
1608 break;
1610 case VOID_TYPE:
1611 case NULLPTR_TYPE:
1612 break;
1614 default:
1615 debug_tree (t1);
1616 gcc_unreachable ();
1619 /* Those are better to come last as they are utterly uninformative. */
1620 if (TYPE_SIZE (t1) && TYPE_SIZE (t2)
1621 && !operand_equal_p (TYPE_SIZE (t1), TYPE_SIZE (t2), 0))
1623 warn_odr (t1, t2, NULL, NULL, warn, warned,
1624 G_("a type with different size "
1625 "is defined in another translation unit"));
1626 return false;
1628 if (COMPLETE_TYPE_P (t1) && COMPLETE_TYPE_P (t2)
1629 && TYPE_ALIGN (t1) != TYPE_ALIGN (t2))
1631 warn_odr (t1, t2, NULL, NULL, warn, warned,
1632 G_("a type with different alignment "
1633 "is defined in another translation unit"));
1634 return false;
1636 gcc_assert (!TYPE_SIZE_UNIT (t1) || !TYPE_SIZE_UNIT (t2)
1637 || operand_equal_p (TYPE_SIZE_UNIT (t1),
1638 TYPE_SIZE_UNIT (t2), 0));
1639 return true;
1642 /* Return true if TYPE1 and TYPE2 are equivalent for One Definition Rule. */
1644 bool
1645 odr_types_equivalent_p (tree type1, tree type2)
1647 gcc_checking_assert (odr_or_derived_type_p (type1)
1648 && odr_or_derived_type_p (type2));
1650 hash_set<type_pair> visited;
1651 return odr_types_equivalent_p (type1, type2, false, NULL,
1652 &visited, UNKNOWN_LOCATION, UNKNOWN_LOCATION);
1655 /* TYPE is equivalent to VAL by ODR, but its tree representation differs
1656 from VAL->type. This may happen in LTO where tree merging did not merge
1657 all variants of the same type or due to ODR violation.
1659 Analyze and report ODR violations and add type to duplicate list.
1660 If TYPE is more specified than VAL->type, prevail VAL->type. Also if
1661 this is first time we see definition of a class return true so the
1662 base types are analyzed. */
1664 static bool
1665 add_type_duplicate (odr_type val, tree type)
1667 bool build_bases = false;
1668 bool prevail = false;
1669 bool odr_must_violate = false;
1671 if (!val->types_set)
1672 val->types_set = new hash_set<tree>;
1674 /* Chose polymorphic type as leader (this happens only in case of ODR
1675 violations. */
1676 if ((TREE_CODE (type) == RECORD_TYPE && TYPE_BINFO (type)
1677 && polymorphic_type_binfo_p (TYPE_BINFO (type)))
1678 && (TREE_CODE (val->type) != RECORD_TYPE || !TYPE_BINFO (val->type)
1679 || !polymorphic_type_binfo_p (TYPE_BINFO (val->type))))
1681 prevail = true;
1682 build_bases = true;
1684 /* Always prefer complete type to be the leader. */
1685 else if (!COMPLETE_TYPE_P (val->type) && COMPLETE_TYPE_P (type))
1687 prevail = true;
1688 build_bases = TYPE_BINFO (type);
1690 else if (COMPLETE_TYPE_P (val->type) && !COMPLETE_TYPE_P (type))
1692 else if (TREE_CODE (val->type) == ENUMERAL_TYPE
1693 && TREE_CODE (type) == ENUMERAL_TYPE
1694 && !TYPE_VALUES (val->type) && TYPE_VALUES (type))
1695 prevail = true;
1696 else if (TREE_CODE (val->type) == RECORD_TYPE
1697 && TREE_CODE (type) == RECORD_TYPE
1698 && TYPE_BINFO (type) && !TYPE_BINFO (val->type))
1700 gcc_assert (!val->bases.length ());
1701 build_bases = true;
1702 prevail = true;
1705 if (prevail)
1706 std::swap (val->type, type);
1708 val->types_set->add (type);
1710 /* If we now have a mangled name, be sure to record it to val->type
1711 so ODR hash can work. */
1713 if (can_be_name_hashed_p (type) && !can_be_name_hashed_p (val->type))
1714 SET_DECL_ASSEMBLER_NAME (TYPE_NAME (val->type),
1715 DECL_ASSEMBLER_NAME (TYPE_NAME (type)));
1717 bool merge = true;
1718 bool base_mismatch = false;
1719 unsigned int i;
1720 bool warned = false;
1721 hash_set<type_pair> visited;
1723 gcc_assert (in_lto_p);
1724 vec_safe_push (val->types, type);
1726 /* If both are class types, compare the bases. */
1727 if (COMPLETE_TYPE_P (type) && COMPLETE_TYPE_P (val->type)
1728 && TREE_CODE (val->type) == RECORD_TYPE
1729 && TREE_CODE (type) == RECORD_TYPE
1730 && TYPE_BINFO (val->type) && TYPE_BINFO (type))
1732 if (BINFO_N_BASE_BINFOS (TYPE_BINFO (type))
1733 != BINFO_N_BASE_BINFOS (TYPE_BINFO (val->type)))
1735 if (!flag_ltrans && !warned && !val->odr_violated)
1737 tree extra_base;
1738 warn_odr (type, val->type, NULL, NULL, !warned, &warned,
1739 "a type with the same name but different "
1740 "number of polymorphic bases is "
1741 "defined in another translation unit");
1742 if (warned)
1744 if (BINFO_N_BASE_BINFOS (TYPE_BINFO (type))
1745 > BINFO_N_BASE_BINFOS (TYPE_BINFO (val->type)))
1746 extra_base = BINFO_BASE_BINFO
1747 (TYPE_BINFO (type),
1748 BINFO_N_BASE_BINFOS (TYPE_BINFO (val->type)));
1749 else
1750 extra_base = BINFO_BASE_BINFO
1751 (TYPE_BINFO (val->type),
1752 BINFO_N_BASE_BINFOS (TYPE_BINFO (type)));
1753 tree extra_base_type = BINFO_TYPE (extra_base);
1754 inform (DECL_SOURCE_LOCATION (TYPE_NAME (extra_base_type)),
1755 "the extra base is defined here");
1758 base_mismatch = true;
1760 else
1761 for (i = 0; i < BINFO_N_BASE_BINFOS (TYPE_BINFO (type)); i++)
1763 tree base1 = BINFO_BASE_BINFO (TYPE_BINFO (type), i);
1764 tree base2 = BINFO_BASE_BINFO (TYPE_BINFO (val->type), i);
1765 tree type1 = BINFO_TYPE (base1);
1766 tree type2 = BINFO_TYPE (base2);
1768 if (types_odr_comparable (type1, type2))
1770 if (!types_same_for_odr (type1, type2))
1771 base_mismatch = true;
1773 else
1774 if (!odr_types_equivalent_p (type1, type2))
1775 base_mismatch = true;
1776 if (base_mismatch)
1778 if (!warned && !val->odr_violated)
1780 warn_odr (type, val->type, NULL, NULL,
1781 !warned, &warned,
1782 "a type with the same name but different base "
1783 "type is defined in another translation unit");
1784 if (warned)
1785 warn_types_mismatch (type1, type2,
1786 UNKNOWN_LOCATION, UNKNOWN_LOCATION);
1788 break;
1790 if (BINFO_OFFSET (base1) != BINFO_OFFSET (base2))
1792 base_mismatch = true;
1793 if (!warned && !val->odr_violated)
1794 warn_odr (type, val->type, NULL, NULL,
1795 !warned, &warned,
1796 "a type with the same name but different base "
1797 "layout is defined in another translation unit");
1798 break;
1800 /* One of bases is not of complete type. */
1801 if (!TYPE_BINFO (type1) != !TYPE_BINFO (type2))
1803 /* If we have a polymorphic type info specified for TYPE1
1804 but not for TYPE2 we possibly missed a base when recording
1805 VAL->type earlier.
1806 Be sure this does not happen. */
1807 if (TYPE_BINFO (type1)
1808 && polymorphic_type_binfo_p (TYPE_BINFO (type1))
1809 && !build_bases)
1810 odr_must_violate = true;
1811 break;
1813 /* One base is polymorphic and the other not.
1814 This ought to be diagnosed earlier, but do not ICE in the
1815 checking bellow. */
1816 else if (TYPE_BINFO (type1)
1817 && polymorphic_type_binfo_p (TYPE_BINFO (type1))
1818 != polymorphic_type_binfo_p (TYPE_BINFO (type2)))
1820 if (!warned && !val->odr_violated)
1821 warn_odr (type, val->type, NULL, NULL,
1822 !warned, &warned,
1823 "a base of the type is polymorphic only in one "
1824 "translation unit");
1825 base_mismatch = true;
1826 break;
1829 if (base_mismatch)
1831 merge = false;
1832 odr_violation_reported = true;
1833 val->odr_violated = true;
1835 if (symtab->dump_file)
1837 fprintf (symtab->dump_file, "ODR base violation\n");
1839 print_node (symtab->dump_file, "", val->type, 0);
1840 putc ('\n',symtab->dump_file);
1841 print_node (symtab->dump_file, "", type, 0);
1842 putc ('\n',symtab->dump_file);
1847 /* Next compare memory layout.
1848 The DECL_SOURCE_LOCATIONs in this invocation came from LTO streaming.
1849 We must apply the location cache to ensure that they are valid
1850 before we can pass them to odr_types_equivalent_p (PR lto/83121). */
1851 if (lto_location_cache::current_cache)
1852 lto_location_cache::current_cache->apply_location_cache ();
1853 if (!odr_types_equivalent_p (val->type, type,
1854 !flag_ltrans && !val->odr_violated && !warned,
1855 &warned, &visited,
1856 DECL_SOURCE_LOCATION (TYPE_NAME (val->type)),
1857 DECL_SOURCE_LOCATION (TYPE_NAME (type))))
1859 merge = false;
1860 odr_violation_reported = true;
1861 val->odr_violated = true;
1863 gcc_assert (val->odr_violated || !odr_must_violate);
1864 /* Sanity check that all bases will be build same way again. */
1865 if (flag_checking
1866 && COMPLETE_TYPE_P (type) && COMPLETE_TYPE_P (val->type)
1867 && TREE_CODE (val->type) == RECORD_TYPE
1868 && TREE_CODE (type) == RECORD_TYPE
1869 && TYPE_BINFO (val->type) && TYPE_BINFO (type)
1870 && !val->odr_violated
1871 && !base_mismatch && val->bases.length ())
1873 unsigned int num_poly_bases = 0;
1874 unsigned int j;
1876 for (i = 0; i < BINFO_N_BASE_BINFOS (TYPE_BINFO (type)); i++)
1877 if (polymorphic_type_binfo_p (BINFO_BASE_BINFO
1878 (TYPE_BINFO (type), i)))
1879 num_poly_bases++;
1880 gcc_assert (num_poly_bases == val->bases.length ());
1881 for (j = 0, i = 0; i < BINFO_N_BASE_BINFOS (TYPE_BINFO (type));
1882 i++)
1883 if (polymorphic_type_binfo_p (BINFO_BASE_BINFO
1884 (TYPE_BINFO (type), i)))
1886 odr_type base = get_odr_type
1887 (BINFO_TYPE
1888 (BINFO_BASE_BINFO (TYPE_BINFO (type),
1889 i)),
1890 true);
1891 gcc_assert (val->bases[j] == base);
1892 j++;
1897 /* Regularize things a little. During LTO same types may come with
1898 different BINFOs. Either because their virtual table was
1899 not merged by tree merging and only later at decl merging or
1900 because one type comes with external vtable, while other
1901 with internal. We want to merge equivalent binfos to conserve
1902 memory and streaming overhead.
1904 The external vtables are more harmful: they contain references
1905 to external declarations of methods that may be defined in the
1906 merged LTO unit. For this reason we absolutely need to remove
1907 them and replace by internal variants. Not doing so will lead
1908 to incomplete answers from possible_polymorphic_call_targets.
1910 FIXME: disable for now; because ODR types are now build during
1911 streaming in, the variants do not need to be linked to the type,
1912 yet. We need to do the merging in cleanup pass to be implemented
1913 soon. */
1914 if (!flag_ltrans && merge
1915 && 0
1916 && TREE_CODE (val->type) == RECORD_TYPE
1917 && TREE_CODE (type) == RECORD_TYPE
1918 && TYPE_BINFO (val->type) && TYPE_BINFO (type)
1919 && TYPE_MAIN_VARIANT (type) == type
1920 && TYPE_MAIN_VARIANT (val->type) == val->type
1921 && BINFO_VTABLE (TYPE_BINFO (val->type))
1922 && BINFO_VTABLE (TYPE_BINFO (type)))
1924 tree master_binfo = TYPE_BINFO (val->type);
1925 tree v1 = BINFO_VTABLE (master_binfo);
1926 tree v2 = BINFO_VTABLE (TYPE_BINFO (type));
1928 if (TREE_CODE (v1) == POINTER_PLUS_EXPR)
1930 gcc_assert (TREE_CODE (v2) == POINTER_PLUS_EXPR
1931 && operand_equal_p (TREE_OPERAND (v1, 1),
1932 TREE_OPERAND (v2, 1), 0));
1933 v1 = TREE_OPERAND (TREE_OPERAND (v1, 0), 0);
1934 v2 = TREE_OPERAND (TREE_OPERAND (v2, 0), 0);
1936 gcc_assert (DECL_ASSEMBLER_NAME (v1)
1937 == DECL_ASSEMBLER_NAME (v2));
1939 if (DECL_EXTERNAL (v1) && !DECL_EXTERNAL (v2))
1941 unsigned int i;
1943 set_type_binfo (val->type, TYPE_BINFO (type));
1944 for (i = 0; i < val->types->length (); i++)
1946 if (TYPE_BINFO ((*val->types)[i])
1947 == master_binfo)
1948 set_type_binfo ((*val->types)[i], TYPE_BINFO (type));
1950 BINFO_TYPE (TYPE_BINFO (type)) = val->type;
1952 else
1953 set_type_binfo (type, master_binfo);
1955 return build_bases;
1958 /* Get ODR type hash entry for TYPE. If INSERT is true, create
1959 possibly new entry. */
1961 odr_type
1962 get_odr_type (tree type, bool insert)
1964 odr_type_d **slot = NULL;
1965 odr_type_d **vtable_slot = NULL;
1966 odr_type val = NULL;
1967 hashval_t hash;
1968 bool build_bases = false;
1969 bool insert_to_odr_array = false;
1970 int base_id = -1;
1972 type = main_odr_variant (type);
1974 gcc_checking_assert (can_be_name_hashed_p (type)
1975 || can_be_vtable_hashed_p (type));
1977 /* Lookup entry, first try name hash, fallback to vtable hash. */
1978 if (can_be_name_hashed_p (type))
1980 hash = hash_odr_name (type);
1981 slot = odr_hash->find_slot_with_hash (type, hash,
1982 insert ? INSERT : NO_INSERT);
1984 if ((!slot || !*slot) && in_lto_p && can_be_vtable_hashed_p (type))
1986 hash = hash_odr_vtable (type);
1987 vtable_slot = odr_vtable_hash->find_slot_with_hash (type, hash,
1988 insert ? INSERT : NO_INSERT);
1991 if (!slot && !vtable_slot)
1992 return NULL;
1994 /* See if we already have entry for type. */
1995 if ((slot && *slot) || (vtable_slot && *vtable_slot))
1997 if (slot && *slot)
1999 val = *slot;
2000 if (flag_checking
2001 && in_lto_p && can_be_vtable_hashed_p (type))
2003 hash = hash_odr_vtable (type);
2004 vtable_slot = odr_vtable_hash->find_slot_with_hash (type, hash,
2005 NO_INSERT);
2006 gcc_assert (!vtable_slot || *vtable_slot == *slot);
2007 vtable_slot = NULL;
2010 else if (*vtable_slot)
2011 val = *vtable_slot;
2013 if (val->type != type
2014 && (!val->types_set || !val->types_set->add (type)))
2016 gcc_assert (insert);
2017 /* We have type duplicate, but it may introduce vtable name or
2018 mangled name; be sure to keep hashes in sync. */
2019 if (in_lto_p && can_be_vtable_hashed_p (type)
2020 && (!vtable_slot || !*vtable_slot))
2022 if (!vtable_slot)
2024 hash = hash_odr_vtable (type);
2025 vtable_slot = odr_vtable_hash->find_slot_with_hash
2026 (type, hash, INSERT);
2027 gcc_checking_assert (!*vtable_slot || *vtable_slot == val);
2029 *vtable_slot = val;
2031 if (slot && !*slot)
2032 *slot = val;
2033 build_bases = add_type_duplicate (val, type);
2036 else
2038 val = ggc_cleared_alloc<odr_type_d> ();
2039 val->type = type;
2040 val->bases = vNULL;
2041 val->derived_types = vNULL;
2042 if (type_with_linkage_p (type))
2043 val->anonymous_namespace = type_in_anonymous_namespace_p (type);
2044 else
2045 val->anonymous_namespace = 0;
2046 build_bases = COMPLETE_TYPE_P (val->type);
2047 insert_to_odr_array = true;
2048 if (slot)
2049 *slot = val;
2050 if (vtable_slot)
2051 *vtable_slot = val;
2054 if (build_bases && TREE_CODE (type) == RECORD_TYPE && TYPE_BINFO (type)
2055 && type_with_linkage_p (type)
2056 && type == TYPE_MAIN_VARIANT (type))
2058 tree binfo = TYPE_BINFO (type);
2059 unsigned int i;
2061 gcc_assert (BINFO_TYPE (TYPE_BINFO (val->type)) == type);
2063 val->all_derivations_known = type_all_derivations_known_p (type);
2064 for (i = 0; i < BINFO_N_BASE_BINFOS (binfo); i++)
2065 /* For now record only polymorphic types. other are
2066 pointless for devirtualization and we can not precisely
2067 determine ODR equivalency of these during LTO. */
2068 if (polymorphic_type_binfo_p (BINFO_BASE_BINFO (binfo, i)))
2070 tree base_type= BINFO_TYPE (BINFO_BASE_BINFO (binfo, i));
2071 odr_type base = get_odr_type (base_type, true);
2072 gcc_assert (TYPE_MAIN_VARIANT (base_type) == base_type);
2073 base->derived_types.safe_push (val);
2074 val->bases.safe_push (base);
2075 if (base->id > base_id)
2076 base_id = base->id;
2079 /* Ensure that type always appears after bases. */
2080 if (insert_to_odr_array)
2082 if (odr_types_ptr)
2083 val->id = odr_types.length ();
2084 vec_safe_push (odr_types_ptr, val);
2086 else if (base_id > val->id)
2088 odr_types[val->id] = 0;
2089 /* Be sure we did not recorded any derived types; these may need
2090 renumbering too. */
2091 gcc_assert (val->derived_types.length() == 0);
2092 val->id = odr_types.length ();
2093 vec_safe_push (odr_types_ptr, val);
2095 return val;
2098 /* Add TYPE od ODR type hash. */
2100 void
2101 register_odr_type (tree type)
2103 if (!odr_hash)
2105 odr_hash = new odr_hash_type (23);
2106 if (in_lto_p)
2107 odr_vtable_hash = new odr_vtable_hash_type (23);
2109 /* Arrange things to be nicer and insert main variants first.
2110 ??? fundamental prerecorded types do not have mangled names; this
2111 makes it possible that non-ODR type is main_odr_variant of ODR type.
2112 Things may get smoother if LTO FE set mangled name of those types same
2113 way as C++ FE does. */
2114 if (odr_type_p (main_odr_variant (TYPE_MAIN_VARIANT (type)))
2115 && odr_type_p (TYPE_MAIN_VARIANT (type)))
2116 get_odr_type (TYPE_MAIN_VARIANT (type), true);
2117 if (TYPE_MAIN_VARIANT (type) != type && odr_type_p (main_odr_variant (type)))
2118 get_odr_type (type, true);
2121 /* Return true if type is known to have no derivations. */
2123 bool
2124 type_known_to_have_no_derivations_p (tree t)
2126 return (type_all_derivations_known_p (t)
2127 && (TYPE_FINAL_P (t)
2128 || (odr_hash
2129 && !get_odr_type (t, true)->derived_types.length())));
2132 /* Dump ODR type T and all its derived types. INDENT specifies indentation for
2133 recursive printing. */
2135 static void
2136 dump_odr_type (FILE *f, odr_type t, int indent=0)
2138 unsigned int i;
2139 fprintf (f, "%*s type %i: ", indent * 2, "", t->id);
2140 print_generic_expr (f, t->type, TDF_SLIM);
2141 fprintf (f, "%s", t->anonymous_namespace ? " (anonymous namespace)":"");
2142 fprintf (f, "%s\n", t->all_derivations_known ? " (derivations known)":"");
2143 if (TYPE_NAME (t->type))
2145 /*fprintf (f, "%*s defined at: %s:%i\n", indent * 2, "",
2146 DECL_SOURCE_FILE (TYPE_NAME (t->type)),
2147 DECL_SOURCE_LINE (TYPE_NAME (t->type)));*/
2148 if (DECL_ASSEMBLER_NAME_SET_P (TYPE_NAME (t->type)))
2149 fprintf (f, "%*s mangled name: %s\n", indent * 2, "",
2150 IDENTIFIER_POINTER
2151 (DECL_ASSEMBLER_NAME (TYPE_NAME (t->type))));
2153 if (t->bases.length ())
2155 fprintf (f, "%*s base odr type ids: ", indent * 2, "");
2156 for (i = 0; i < t->bases.length (); i++)
2157 fprintf (f, " %i", t->bases[i]->id);
2158 fprintf (f, "\n");
2160 if (t->derived_types.length ())
2162 fprintf (f, "%*s derived types:\n", indent * 2, "");
2163 for (i = 0; i < t->derived_types.length (); i++)
2164 dump_odr_type (f, t->derived_types[i], indent + 1);
2166 fprintf (f, "\n");
2169 /* Dump the type inheritance graph. */
2171 static void
2172 dump_type_inheritance_graph (FILE *f)
2174 unsigned int i;
2175 if (!odr_types_ptr)
2176 return;
2177 fprintf (f, "\n\nType inheritance graph:\n");
2178 for (i = 0; i < odr_types.length (); i++)
2180 if (odr_types[i] && odr_types[i]->bases.length () == 0)
2181 dump_odr_type (f, odr_types[i]);
2183 for (i = 0; i < odr_types.length (); i++)
2185 if (odr_types[i] && odr_types[i]->types && odr_types[i]->types->length ())
2187 unsigned int j;
2188 fprintf (f, "Duplicate tree types for odr type %i\n", i);
2189 print_node (f, "", odr_types[i]->type, 0);
2190 for (j = 0; j < odr_types[i]->types->length (); j++)
2192 tree t;
2193 fprintf (f, "duplicate #%i\n", j);
2194 print_node (f, "", (*odr_types[i]->types)[j], 0);
2195 t = (*odr_types[i]->types)[j];
2196 while (TYPE_P (t) && TYPE_CONTEXT (t))
2198 t = TYPE_CONTEXT (t);
2199 print_node (f, "", t, 0);
2201 putc ('\n',f);
2207 /* Initialize IPA devirt and build inheritance tree graph. */
2209 void
2210 build_type_inheritance_graph (void)
2212 struct symtab_node *n;
2213 FILE *inheritance_dump_file;
2214 dump_flags_t flags;
2216 if (odr_hash)
2217 return;
2218 timevar_push (TV_IPA_INHERITANCE);
2219 inheritance_dump_file = dump_begin (TDI_inheritance, &flags);
2220 odr_hash = new odr_hash_type (23);
2221 if (in_lto_p)
2222 odr_vtable_hash = new odr_vtable_hash_type (23);
2224 /* We reconstruct the graph starting of types of all methods seen in the
2225 unit. */
2226 FOR_EACH_SYMBOL (n)
2227 if (is_a <cgraph_node *> (n)
2228 && DECL_VIRTUAL_P (n->decl)
2229 && n->real_symbol_p ())
2230 get_odr_type (TYPE_METHOD_BASETYPE (TREE_TYPE (n->decl)), true);
2232 /* Look also for virtual tables of types that do not define any methods.
2234 We need it in a case where class B has virtual base of class A
2235 re-defining its virtual method and there is class C with no virtual
2236 methods with B as virtual base.
2238 Here we output B's virtual method in two variant - for non-virtual
2239 and virtual inheritance. B's virtual table has non-virtual version,
2240 while C's has virtual.
2242 For this reason we need to know about C in order to include both
2243 variants of B. More correctly, record_target_from_binfo should
2244 add both variants of the method when walking B, but we have no
2245 link in between them.
2247 We rely on fact that either the method is exported and thus we
2248 assume it is called externally or C is in anonymous namespace and
2249 thus we will see the vtable. */
2251 else if (is_a <varpool_node *> (n)
2252 && DECL_VIRTUAL_P (n->decl)
2253 && TREE_CODE (DECL_CONTEXT (n->decl)) == RECORD_TYPE
2254 && TYPE_BINFO (DECL_CONTEXT (n->decl))
2255 && polymorphic_type_binfo_p (TYPE_BINFO (DECL_CONTEXT (n->decl))))
2256 get_odr_type (TYPE_MAIN_VARIANT (DECL_CONTEXT (n->decl)), true);
2257 if (inheritance_dump_file)
2259 dump_type_inheritance_graph (inheritance_dump_file);
2260 dump_end (TDI_inheritance, inheritance_dump_file);
2262 timevar_pop (TV_IPA_INHERITANCE);
2265 /* Return true if N has reference from live virtual table
2266 (and thus can be a destination of polymorphic call).
2267 Be conservatively correct when callgraph is not built or
2268 if the method may be referred externally. */
2270 static bool
2271 referenced_from_vtable_p (struct cgraph_node *node)
2273 int i;
2274 struct ipa_ref *ref;
2275 bool found = false;
2277 if (node->externally_visible
2278 || DECL_EXTERNAL (node->decl)
2279 || node->used_from_other_partition)
2280 return true;
2282 /* Keep this test constant time.
2283 It is unlikely this can happen except for the case where speculative
2284 devirtualization introduced many speculative edges to this node.
2285 In this case the target is very likely alive anyway. */
2286 if (node->ref_list.referring.length () > 100)
2287 return true;
2289 /* We need references built. */
2290 if (symtab->state <= CONSTRUCTION)
2291 return true;
2293 for (i = 0; node->iterate_referring (i, ref); i++)
2294 if ((ref->use == IPA_REF_ALIAS
2295 && referenced_from_vtable_p (dyn_cast<cgraph_node *> (ref->referring)))
2296 || (ref->use == IPA_REF_ADDR
2297 && VAR_P (ref->referring->decl)
2298 && DECL_VIRTUAL_P (ref->referring->decl)))
2300 found = true;
2301 break;
2303 return found;
2306 /* Return if TARGET is cxa_pure_virtual. */
2308 static bool
2309 is_cxa_pure_virtual_p (tree target)
2311 return target && TREE_CODE (TREE_TYPE (target)) != METHOD_TYPE
2312 && DECL_NAME (target)
2313 && id_equal (DECL_NAME (target),
2314 "__cxa_pure_virtual");
2317 /* If TARGET has associated node, record it in the NODES array.
2318 CAN_REFER specify if program can refer to the target directly.
2319 if TARGET is unknown (NULL) or it can not be inserted (for example because
2320 its body was already removed and there is no way to refer to it), clear
2321 COMPLETEP. */
2323 static void
2324 maybe_record_node (vec <cgraph_node *> &nodes,
2325 tree target, hash_set<tree> *inserted,
2326 bool can_refer,
2327 bool *completep)
2329 struct cgraph_node *target_node, *alias_target;
2330 enum availability avail;
2331 bool pure_virtual = is_cxa_pure_virtual_p (target);
2333 /* __builtin_unreachable do not need to be added into
2334 list of targets; the runtime effect of calling them is undefined.
2335 Only "real" virtual methods should be accounted. */
2336 if (target && TREE_CODE (TREE_TYPE (target)) != METHOD_TYPE && !pure_virtual)
2337 return;
2339 if (!can_refer)
2341 /* The only case when method of anonymous namespace becomes unreferable
2342 is when we completely optimized it out. */
2343 if (flag_ltrans
2344 || !target
2345 || !type_in_anonymous_namespace_p (DECL_CONTEXT (target)))
2346 *completep = false;
2347 return;
2350 if (!target)
2351 return;
2353 target_node = cgraph_node::get (target);
2355 /* Prefer alias target over aliases, so we do not get confused by
2356 fake duplicates. */
2357 if (target_node)
2359 alias_target = target_node->ultimate_alias_target (&avail);
2360 if (target_node != alias_target
2361 && avail >= AVAIL_AVAILABLE
2362 && target_node->get_availability ())
2363 target_node = alias_target;
2366 /* Method can only be called by polymorphic call if any
2367 of vtables referring to it are alive.
2369 While this holds for non-anonymous functions, too, there are
2370 cases where we want to keep them in the list; for example
2371 inline functions with -fno-weak are static, but we still
2372 may devirtualize them when instance comes from other unit.
2373 The same holds for LTO.
2375 Currently we ignore these functions in speculative devirtualization.
2376 ??? Maybe it would make sense to be more aggressive for LTO even
2377 elsewhere. */
2378 if (!flag_ltrans
2379 && !pure_virtual
2380 && type_in_anonymous_namespace_p (DECL_CONTEXT (target))
2381 && (!target_node
2382 || !referenced_from_vtable_p (target_node)))
2384 /* See if TARGET is useful function we can deal with. */
2385 else if (target_node != NULL
2386 && (TREE_PUBLIC (target)
2387 || DECL_EXTERNAL (target)
2388 || target_node->definition)
2389 && target_node->real_symbol_p ())
2391 gcc_assert (!target_node->global.inlined_to);
2392 gcc_assert (target_node->real_symbol_p ());
2393 /* When sanitizing, do not assume that __cxa_pure_virtual is not called
2394 by valid program. */
2395 if (flag_sanitize & SANITIZE_UNREACHABLE)
2397 /* Only add pure virtual if it is the only possible target. This way
2398 we will preserve the diagnostics about pure virtual called in many
2399 cases without disabling optimization in other. */
2400 else if (pure_virtual)
2402 if (nodes.length ())
2403 return;
2405 /* If we found a real target, take away cxa_pure_virtual. */
2406 else if (!pure_virtual && nodes.length () == 1
2407 && is_cxa_pure_virtual_p (nodes[0]->decl))
2408 nodes.pop ();
2409 if (pure_virtual && nodes.length ())
2410 return;
2411 if (!inserted->add (target))
2413 cached_polymorphic_call_targets->add (target_node);
2414 nodes.safe_push (target_node);
2417 else if (!completep)
2419 /* We have definition of __cxa_pure_virtual that is not accessible (it is
2420 optimized out or partitioned to other unit) so we can not add it. When
2421 not sanitizing, there is nothing to do.
2422 Otherwise declare the list incomplete. */
2423 else if (pure_virtual)
2425 if (flag_sanitize & SANITIZE_UNREACHABLE)
2426 *completep = false;
2428 else if (flag_ltrans
2429 || !type_in_anonymous_namespace_p (DECL_CONTEXT (target)))
2430 *completep = false;
2433 /* See if BINFO's type matches OUTER_TYPE. If so, look up
2434 BINFO of subtype of OTR_TYPE at OFFSET and in that BINFO find
2435 method in vtable and insert method to NODES array
2436 or BASES_TO_CONSIDER if this array is non-NULL.
2437 Otherwise recurse to base BINFOs.
2438 This matches what get_binfo_at_offset does, but with offset
2439 being unknown.
2441 TYPE_BINFOS is a stack of BINFOS of types with defined
2442 virtual table seen on way from class type to BINFO.
2444 MATCHED_VTABLES tracks virtual tables we already did lookup
2445 for virtual function in. INSERTED tracks nodes we already
2446 inserted.
2448 ANONYMOUS is true if BINFO is part of anonymous namespace.
2450 Clear COMPLETEP when we hit unreferable target.
2453 static void
2454 record_target_from_binfo (vec <cgraph_node *> &nodes,
2455 vec <tree> *bases_to_consider,
2456 tree binfo,
2457 tree otr_type,
2458 vec <tree> &type_binfos,
2459 HOST_WIDE_INT otr_token,
2460 tree outer_type,
2461 HOST_WIDE_INT offset,
2462 hash_set<tree> *inserted,
2463 hash_set<tree> *matched_vtables,
2464 bool anonymous,
2465 bool *completep)
2467 tree type = BINFO_TYPE (binfo);
2468 int i;
2469 tree base_binfo;
2472 if (BINFO_VTABLE (binfo))
2473 type_binfos.safe_push (binfo);
2474 if (types_same_for_odr (type, outer_type))
2476 int i;
2477 tree type_binfo = NULL;
2479 /* Look up BINFO with virtual table. For normal types it is always last
2480 binfo on stack. */
2481 for (i = type_binfos.length () - 1; i >= 0; i--)
2482 if (BINFO_OFFSET (type_binfos[i]) == BINFO_OFFSET (binfo))
2484 type_binfo = type_binfos[i];
2485 break;
2487 if (BINFO_VTABLE (binfo))
2488 type_binfos.pop ();
2489 /* If this is duplicated BINFO for base shared by virtual inheritance,
2490 we may not have its associated vtable. This is not a problem, since
2491 we will walk it on the other path. */
2492 if (!type_binfo)
2493 return;
2494 tree inner_binfo = get_binfo_at_offset (type_binfo,
2495 offset, otr_type);
2496 if (!inner_binfo)
2498 gcc_assert (odr_violation_reported);
2499 return;
2501 /* For types in anonymous namespace first check if the respective vtable
2502 is alive. If not, we know the type can't be called. */
2503 if (!flag_ltrans && anonymous)
2505 tree vtable = BINFO_VTABLE (inner_binfo);
2506 varpool_node *vnode;
2508 if (TREE_CODE (vtable) == POINTER_PLUS_EXPR)
2509 vtable = TREE_OPERAND (TREE_OPERAND (vtable, 0), 0);
2510 vnode = varpool_node::get (vtable);
2511 if (!vnode || !vnode->definition)
2512 return;
2514 gcc_assert (inner_binfo);
2515 if (bases_to_consider
2516 ? !matched_vtables->contains (BINFO_VTABLE (inner_binfo))
2517 : !matched_vtables->add (BINFO_VTABLE (inner_binfo)))
2519 bool can_refer;
2520 tree target = gimple_get_virt_method_for_binfo (otr_token,
2521 inner_binfo,
2522 &can_refer);
2523 if (!bases_to_consider)
2524 maybe_record_node (nodes, target, inserted, can_refer, completep);
2525 /* Destructors are never called via construction vtables. */
2526 else if (!target || !DECL_CXX_DESTRUCTOR_P (target))
2527 bases_to_consider->safe_push (target);
2529 return;
2532 /* Walk bases. */
2533 for (i = 0; BINFO_BASE_ITERATE (binfo, i, base_binfo); i++)
2534 /* Walking bases that have no virtual method is pointless exercise. */
2535 if (polymorphic_type_binfo_p (base_binfo))
2536 record_target_from_binfo (nodes, bases_to_consider, base_binfo, otr_type,
2537 type_binfos,
2538 otr_token, outer_type, offset, inserted,
2539 matched_vtables, anonymous, completep);
2540 if (BINFO_VTABLE (binfo))
2541 type_binfos.pop ();
2544 /* Look up virtual methods matching OTR_TYPE (with OFFSET and OTR_TOKEN)
2545 of TYPE, insert them to NODES, recurse into derived nodes.
2546 INSERTED is used to avoid duplicate insertions of methods into NODES.
2547 MATCHED_VTABLES are used to avoid duplicate walking vtables.
2548 Clear COMPLETEP if unreferable target is found.
2550 If CONSIDER_CONSTRUCTION is true, record to BASES_TO_CONSIDER
2551 all cases where BASE_SKIPPED is true (because the base is abstract
2552 class). */
2554 static void
2555 possible_polymorphic_call_targets_1 (vec <cgraph_node *> &nodes,
2556 hash_set<tree> *inserted,
2557 hash_set<tree> *matched_vtables,
2558 tree otr_type,
2559 odr_type type,
2560 HOST_WIDE_INT otr_token,
2561 tree outer_type,
2562 HOST_WIDE_INT offset,
2563 bool *completep,
2564 vec <tree> &bases_to_consider,
2565 bool consider_construction)
2567 tree binfo = TYPE_BINFO (type->type);
2568 unsigned int i;
2569 auto_vec <tree, 8> type_binfos;
2570 bool possibly_instantiated = type_possibly_instantiated_p (type->type);
2572 /* We may need to consider types w/o instances because of possible derived
2573 types using their methods either directly or via construction vtables.
2574 We are safe to skip them when all derivations are known, since we will
2575 handle them later.
2576 This is done by recording them to BASES_TO_CONSIDER array. */
2577 if (possibly_instantiated || consider_construction)
2579 record_target_from_binfo (nodes,
2580 (!possibly_instantiated
2581 && type_all_derivations_known_p (type->type))
2582 ? &bases_to_consider : NULL,
2583 binfo, otr_type, type_binfos, otr_token,
2584 outer_type, offset,
2585 inserted, matched_vtables,
2586 type->anonymous_namespace, completep);
2588 for (i = 0; i < type->derived_types.length (); i++)
2589 possible_polymorphic_call_targets_1 (nodes, inserted,
2590 matched_vtables,
2591 otr_type,
2592 type->derived_types[i],
2593 otr_token, outer_type, offset, completep,
2594 bases_to_consider, consider_construction);
2597 /* Cache of queries for polymorphic call targets.
2599 Enumerating all call targets may get expensive when there are many
2600 polymorphic calls in the program, so we memoize all the previous
2601 queries and avoid duplicated work. */
2603 struct polymorphic_call_target_d
2605 HOST_WIDE_INT otr_token;
2606 ipa_polymorphic_call_context context;
2607 odr_type type;
2608 vec <cgraph_node *> targets;
2609 tree decl_warning;
2610 int type_warning;
2611 bool complete;
2612 bool speculative;
2615 /* Polymorphic call target cache helpers. */
2617 struct polymorphic_call_target_hasher
2618 : pointer_hash <polymorphic_call_target_d>
2620 static inline hashval_t hash (const polymorphic_call_target_d *);
2621 static inline bool equal (const polymorphic_call_target_d *,
2622 const polymorphic_call_target_d *);
2623 static inline void remove (polymorphic_call_target_d *);
2626 /* Return the computed hashcode for ODR_QUERY. */
2628 inline hashval_t
2629 polymorphic_call_target_hasher::hash (const polymorphic_call_target_d *odr_query)
2631 inchash::hash hstate (odr_query->otr_token);
2633 hstate.add_hwi (odr_query->type->id);
2634 hstate.merge_hash (TYPE_UID (odr_query->context.outer_type));
2635 hstate.add_hwi (odr_query->context.offset);
2637 if (odr_query->context.speculative_outer_type)
2639 hstate.merge_hash (TYPE_UID (odr_query->context.speculative_outer_type));
2640 hstate.add_hwi (odr_query->context.speculative_offset);
2642 hstate.add_flag (odr_query->speculative);
2643 hstate.add_flag (odr_query->context.maybe_in_construction);
2644 hstate.add_flag (odr_query->context.maybe_derived_type);
2645 hstate.add_flag (odr_query->context.speculative_maybe_derived_type);
2646 hstate.commit_flag ();
2647 return hstate.end ();
2650 /* Compare cache entries T1 and T2. */
2652 inline bool
2653 polymorphic_call_target_hasher::equal (const polymorphic_call_target_d *t1,
2654 const polymorphic_call_target_d *t2)
2656 return (t1->type == t2->type && t1->otr_token == t2->otr_token
2657 && t1->speculative == t2->speculative
2658 && t1->context.offset == t2->context.offset
2659 && t1->context.speculative_offset == t2->context.speculative_offset
2660 && t1->context.outer_type == t2->context.outer_type
2661 && t1->context.speculative_outer_type == t2->context.speculative_outer_type
2662 && t1->context.maybe_in_construction
2663 == t2->context.maybe_in_construction
2664 && t1->context.maybe_derived_type == t2->context.maybe_derived_type
2665 && (t1->context.speculative_maybe_derived_type
2666 == t2->context.speculative_maybe_derived_type));
2669 /* Remove entry in polymorphic call target cache hash. */
2671 inline void
2672 polymorphic_call_target_hasher::remove (polymorphic_call_target_d *v)
2674 v->targets.release ();
2675 free (v);
2678 /* Polymorphic call target query cache. */
2680 typedef hash_table<polymorphic_call_target_hasher>
2681 polymorphic_call_target_hash_type;
2682 static polymorphic_call_target_hash_type *polymorphic_call_target_hash;
2684 /* Destroy polymorphic call target query cache. */
2686 static void
2687 free_polymorphic_call_targets_hash ()
2689 if (cached_polymorphic_call_targets)
2691 delete polymorphic_call_target_hash;
2692 polymorphic_call_target_hash = NULL;
2693 delete cached_polymorphic_call_targets;
2694 cached_polymorphic_call_targets = NULL;
2698 /* When virtual function is removed, we may need to flush the cache. */
2700 static void
2701 devirt_node_removal_hook (struct cgraph_node *n, void *d ATTRIBUTE_UNUSED)
2703 if (cached_polymorphic_call_targets
2704 && cached_polymorphic_call_targets->contains (n))
2705 free_polymorphic_call_targets_hash ();
2708 /* Look up base of BINFO that has virtual table VTABLE with OFFSET. */
2710 tree
2711 subbinfo_with_vtable_at_offset (tree binfo, unsigned HOST_WIDE_INT offset,
2712 tree vtable)
2714 tree v = BINFO_VTABLE (binfo);
2715 int i;
2716 tree base_binfo;
2717 unsigned HOST_WIDE_INT this_offset;
2719 if (v)
2721 if (!vtable_pointer_value_to_vtable (v, &v, &this_offset))
2722 gcc_unreachable ();
2724 if (offset == this_offset
2725 && DECL_ASSEMBLER_NAME (v) == DECL_ASSEMBLER_NAME (vtable))
2726 return binfo;
2729 for (i = 0; BINFO_BASE_ITERATE (binfo, i, base_binfo); i++)
2730 if (polymorphic_type_binfo_p (base_binfo))
2732 base_binfo = subbinfo_with_vtable_at_offset (base_binfo, offset, vtable);
2733 if (base_binfo)
2734 return base_binfo;
2736 return NULL;
2739 /* T is known constant value of virtual table pointer.
2740 Store virtual table to V and its offset to OFFSET.
2741 Return false if T does not look like virtual table reference. */
2743 bool
2744 vtable_pointer_value_to_vtable (const_tree t, tree *v,
2745 unsigned HOST_WIDE_INT *offset)
2747 /* We expect &MEM[(void *)&virtual_table + 16B].
2748 We obtain object's BINFO from the context of the virtual table.
2749 This one contains pointer to virtual table represented via
2750 POINTER_PLUS_EXPR. Verify that this pointer matches what
2751 we propagated through.
2753 In the case of virtual inheritance, the virtual tables may
2754 be nested, i.e. the offset may be different from 16 and we may
2755 need to dive into the type representation. */
2756 if (TREE_CODE (t) == ADDR_EXPR
2757 && TREE_CODE (TREE_OPERAND (t, 0)) == MEM_REF
2758 && TREE_CODE (TREE_OPERAND (TREE_OPERAND (t, 0), 0)) == ADDR_EXPR
2759 && TREE_CODE (TREE_OPERAND (TREE_OPERAND (t, 0), 1)) == INTEGER_CST
2760 && (TREE_CODE (TREE_OPERAND (TREE_OPERAND (TREE_OPERAND (t, 0), 0), 0))
2761 == VAR_DECL)
2762 && DECL_VIRTUAL_P (TREE_OPERAND (TREE_OPERAND
2763 (TREE_OPERAND (t, 0), 0), 0)))
2765 *v = TREE_OPERAND (TREE_OPERAND (TREE_OPERAND (t, 0), 0), 0);
2766 *offset = tree_to_uhwi (TREE_OPERAND (TREE_OPERAND (t, 0), 1));
2767 return true;
2770 /* Alternative representation, used by C++ frontend is POINTER_PLUS_EXPR.
2771 We need to handle it when T comes from static variable initializer or
2772 BINFO. */
2773 if (TREE_CODE (t) == POINTER_PLUS_EXPR)
2775 *offset = tree_to_uhwi (TREE_OPERAND (t, 1));
2776 t = TREE_OPERAND (t, 0);
2778 else
2779 *offset = 0;
2781 if (TREE_CODE (t) != ADDR_EXPR)
2782 return false;
2783 *v = TREE_OPERAND (t, 0);
2784 return true;
2787 /* T is known constant value of virtual table pointer. Return BINFO of the
2788 instance type. */
2790 tree
2791 vtable_pointer_value_to_binfo (const_tree t)
2793 tree vtable;
2794 unsigned HOST_WIDE_INT offset;
2796 if (!vtable_pointer_value_to_vtable (t, &vtable, &offset))
2797 return NULL_TREE;
2799 /* FIXME: for stores of construction vtables we return NULL,
2800 because we do not have BINFO for those. Eventually we should fix
2801 our representation to allow this case to be handled, too.
2802 In the case we see store of BINFO we however may assume
2803 that standard folding will be able to cope with it. */
2804 return subbinfo_with_vtable_at_offset (TYPE_BINFO (DECL_CONTEXT (vtable)),
2805 offset, vtable);
2808 /* Walk bases of OUTER_TYPE that contain OTR_TYPE at OFFSET.
2809 Look up their respective virtual methods for OTR_TOKEN and OTR_TYPE
2810 and insert them in NODES.
2812 MATCHED_VTABLES and INSERTED is used to avoid duplicated work. */
2814 static void
2815 record_targets_from_bases (tree otr_type,
2816 HOST_WIDE_INT otr_token,
2817 tree outer_type,
2818 HOST_WIDE_INT offset,
2819 vec <cgraph_node *> &nodes,
2820 hash_set<tree> *inserted,
2821 hash_set<tree> *matched_vtables,
2822 bool *completep)
2824 while (true)
2826 HOST_WIDE_INT pos, size;
2827 tree base_binfo;
2828 tree fld;
2830 if (types_same_for_odr (outer_type, otr_type))
2831 return;
2833 for (fld = TYPE_FIELDS (outer_type); fld; fld = DECL_CHAIN (fld))
2835 if (TREE_CODE (fld) != FIELD_DECL)
2836 continue;
2838 pos = int_bit_position (fld);
2839 size = tree_to_shwi (DECL_SIZE (fld));
2840 if (pos <= offset && (pos + size) > offset
2841 /* Do not get confused by zero sized bases. */
2842 && polymorphic_type_binfo_p (TYPE_BINFO (TREE_TYPE (fld))))
2843 break;
2845 /* Within a class type we should always find corresponding fields. */
2846 gcc_assert (fld && TREE_CODE (TREE_TYPE (fld)) == RECORD_TYPE);
2848 /* Nonbase types should have been stripped by outer_class_type. */
2849 gcc_assert (DECL_ARTIFICIAL (fld));
2851 outer_type = TREE_TYPE (fld);
2852 offset -= pos;
2854 base_binfo = get_binfo_at_offset (TYPE_BINFO (outer_type),
2855 offset, otr_type);
2856 if (!base_binfo)
2858 gcc_assert (odr_violation_reported);
2859 return;
2861 gcc_assert (base_binfo);
2862 if (!matched_vtables->add (BINFO_VTABLE (base_binfo)))
2864 bool can_refer;
2865 tree target = gimple_get_virt_method_for_binfo (otr_token,
2866 base_binfo,
2867 &can_refer);
2868 if (!target || ! DECL_CXX_DESTRUCTOR_P (target))
2869 maybe_record_node (nodes, target, inserted, can_refer, completep);
2870 matched_vtables->add (BINFO_VTABLE (base_binfo));
2875 /* When virtual table is removed, we may need to flush the cache. */
2877 static void
2878 devirt_variable_node_removal_hook (varpool_node *n,
2879 void *d ATTRIBUTE_UNUSED)
2881 if (cached_polymorphic_call_targets
2882 && DECL_VIRTUAL_P (n->decl)
2883 && type_in_anonymous_namespace_p (DECL_CONTEXT (n->decl)))
2884 free_polymorphic_call_targets_hash ();
2887 /* Record about how many calls would benefit from given type to be final. */
2889 struct odr_type_warn_count
2891 tree type;
2892 int count;
2893 profile_count dyn_count;
2896 /* Record about how many calls would benefit from given method to be final. */
2898 struct decl_warn_count
2900 tree decl;
2901 int count;
2902 profile_count dyn_count;
2905 /* Information about type and decl warnings. */
2907 struct final_warning_record
2909 /* If needed grow type_warnings vector and initialize new decl_warn_count
2910 to have dyn_count set to profile_count::zero (). */
2911 void grow_type_warnings (unsigned newlen);
2913 profile_count dyn_count;
2914 auto_vec<odr_type_warn_count> type_warnings;
2915 hash_map<tree, decl_warn_count> decl_warnings;
2918 void
2919 final_warning_record::grow_type_warnings (unsigned newlen)
2921 unsigned len = type_warnings.length ();
2922 if (newlen > len)
2924 type_warnings.safe_grow_cleared (newlen);
2925 for (unsigned i = len; i < newlen; i++)
2926 type_warnings[i].dyn_count = profile_count::zero ();
2930 struct final_warning_record *final_warning_records;
2932 /* Return vector containing possible targets of polymorphic call of type
2933 OTR_TYPE calling method OTR_TOKEN within type of OTR_OUTER_TYPE and OFFSET.
2934 If INCLUDE_BASES is true, walk also base types of OUTER_TYPES containing
2935 OTR_TYPE and include their virtual method. This is useful for types
2936 possibly in construction or destruction where the virtual table may
2937 temporarily change to one of base types. INCLUDE_DERIVER_TYPES make
2938 us to walk the inheritance graph for all derivations.
2940 If COMPLETEP is non-NULL, store true if the list is complete.
2941 CACHE_TOKEN (if non-NULL) will get stored to an unique ID of entry
2942 in the target cache. If user needs to visit every target list
2943 just once, it can memoize them.
2945 If SPECULATIVE is set, the list will not contain targets that
2946 are not speculatively taken.
2948 Returned vector is placed into cache. It is NOT caller's responsibility
2949 to free it. The vector can be freed on cgraph_remove_node call if
2950 the particular node is a virtual function present in the cache. */
2952 vec <cgraph_node *>
2953 possible_polymorphic_call_targets (tree otr_type,
2954 HOST_WIDE_INT otr_token,
2955 ipa_polymorphic_call_context context,
2956 bool *completep,
2957 void **cache_token,
2958 bool speculative)
2960 static struct cgraph_node_hook_list *node_removal_hook_holder;
2961 vec <cgraph_node *> nodes = vNULL;
2962 auto_vec <tree, 8> bases_to_consider;
2963 odr_type type, outer_type;
2964 polymorphic_call_target_d key;
2965 polymorphic_call_target_d **slot;
2966 unsigned int i;
2967 tree binfo, target;
2968 bool complete;
2969 bool can_refer = false;
2970 bool skipped = false;
2972 otr_type = TYPE_MAIN_VARIANT (otr_type);
2974 /* If ODR is not initialized or the context is invalid, return empty
2975 incomplete list. */
2976 if (!odr_hash || context.invalid || !TYPE_BINFO (otr_type))
2978 if (completep)
2979 *completep = context.invalid;
2980 if (cache_token)
2981 *cache_token = NULL;
2982 return nodes;
2985 /* Do not bother to compute speculative info when user do not asks for it. */
2986 if (!speculative || !context.speculative_outer_type)
2987 context.clear_speculation ();
2989 type = get_odr_type (otr_type, true);
2991 /* Recording type variants would waste results cache. */
2992 gcc_assert (!context.outer_type
2993 || TYPE_MAIN_VARIANT (context.outer_type) == context.outer_type);
2995 /* Look up the outer class type we want to walk.
2996 If we fail to do so, the context is invalid. */
2997 if ((context.outer_type || context.speculative_outer_type)
2998 && !context.restrict_to_inner_class (otr_type))
3000 if (completep)
3001 *completep = true;
3002 if (cache_token)
3003 *cache_token = NULL;
3004 return nodes;
3006 gcc_assert (!context.invalid);
3008 /* Check that restrict_to_inner_class kept the main variant. */
3009 gcc_assert (!context.outer_type
3010 || TYPE_MAIN_VARIANT (context.outer_type) == context.outer_type);
3012 /* We canonicalize our query, so we do not need extra hashtable entries. */
3014 /* Without outer type, we have no use for offset. Just do the
3015 basic search from inner type. */
3016 if (!context.outer_type)
3017 context.clear_outer_type (otr_type);
3018 /* We need to update our hierarchy if the type does not exist. */
3019 outer_type = get_odr_type (context.outer_type, true);
3020 /* If the type is complete, there are no derivations. */
3021 if (TYPE_FINAL_P (outer_type->type))
3022 context.maybe_derived_type = false;
3024 /* Initialize query cache. */
3025 if (!cached_polymorphic_call_targets)
3027 cached_polymorphic_call_targets = new hash_set<cgraph_node *>;
3028 polymorphic_call_target_hash
3029 = new polymorphic_call_target_hash_type (23);
3030 if (!node_removal_hook_holder)
3032 node_removal_hook_holder =
3033 symtab->add_cgraph_removal_hook (&devirt_node_removal_hook, NULL);
3034 symtab->add_varpool_removal_hook (&devirt_variable_node_removal_hook,
3035 NULL);
3039 if (in_lto_p)
3041 if (context.outer_type != otr_type)
3042 context.outer_type
3043 = get_odr_type (context.outer_type, true)->type;
3044 if (context.speculative_outer_type)
3045 context.speculative_outer_type
3046 = get_odr_type (context.speculative_outer_type, true)->type;
3049 /* Look up cached answer. */
3050 key.type = type;
3051 key.otr_token = otr_token;
3052 key.speculative = speculative;
3053 key.context = context;
3054 slot = polymorphic_call_target_hash->find_slot (&key, INSERT);
3055 if (cache_token)
3056 *cache_token = (void *)*slot;
3057 if (*slot)
3059 if (completep)
3060 *completep = (*slot)->complete;
3061 if ((*slot)->type_warning && final_warning_records)
3063 final_warning_records->type_warnings[(*slot)->type_warning - 1].count++;
3064 if (!final_warning_records->type_warnings
3065 [(*slot)->type_warning - 1].dyn_count.initialized_p ())
3066 final_warning_records->type_warnings
3067 [(*slot)->type_warning - 1].dyn_count = profile_count::zero ();
3068 if (final_warning_records->dyn_count > 0)
3069 final_warning_records->type_warnings[(*slot)->type_warning - 1].dyn_count
3070 = final_warning_records->type_warnings[(*slot)->type_warning - 1].dyn_count
3071 + final_warning_records->dyn_count;
3073 if (!speculative && (*slot)->decl_warning && final_warning_records)
3075 struct decl_warn_count *c =
3076 final_warning_records->decl_warnings.get ((*slot)->decl_warning);
3077 c->count++;
3078 if (final_warning_records->dyn_count > 0)
3079 c->dyn_count += final_warning_records->dyn_count;
3081 return (*slot)->targets;
3084 complete = true;
3086 /* Do actual search. */
3087 timevar_push (TV_IPA_VIRTUAL_CALL);
3088 *slot = XCNEW (polymorphic_call_target_d);
3089 if (cache_token)
3090 *cache_token = (void *)*slot;
3091 (*slot)->type = type;
3092 (*slot)->otr_token = otr_token;
3093 (*slot)->context = context;
3094 (*slot)->speculative = speculative;
3096 hash_set<tree> inserted;
3097 hash_set<tree> matched_vtables;
3099 /* First insert targets we speculatively identified as likely. */
3100 if (context.speculative_outer_type)
3102 odr_type speculative_outer_type;
3103 bool speculation_complete = true;
3105 /* First insert target from type itself and check if it may have
3106 derived types. */
3107 speculative_outer_type = get_odr_type (context.speculative_outer_type, true);
3108 if (TYPE_FINAL_P (speculative_outer_type->type))
3109 context.speculative_maybe_derived_type = false;
3110 binfo = get_binfo_at_offset (TYPE_BINFO (speculative_outer_type->type),
3111 context.speculative_offset, otr_type);
3112 if (binfo)
3113 target = gimple_get_virt_method_for_binfo (otr_token, binfo,
3114 &can_refer);
3115 else
3116 target = NULL;
3118 /* In the case we get complete method, we don't need
3119 to walk derivations. */
3120 if (target && DECL_FINAL_P (target))
3121 context.speculative_maybe_derived_type = false;
3122 if (type_possibly_instantiated_p (speculative_outer_type->type))
3123 maybe_record_node (nodes, target, &inserted, can_refer, &speculation_complete);
3124 if (binfo)
3125 matched_vtables.add (BINFO_VTABLE (binfo));
3128 /* Next walk recursively all derived types. */
3129 if (context.speculative_maybe_derived_type)
3130 for (i = 0; i < speculative_outer_type->derived_types.length(); i++)
3131 possible_polymorphic_call_targets_1 (nodes, &inserted,
3132 &matched_vtables,
3133 otr_type,
3134 speculative_outer_type->derived_types[i],
3135 otr_token, speculative_outer_type->type,
3136 context.speculative_offset,
3137 &speculation_complete,
3138 bases_to_consider,
3139 false);
3142 if (!speculative || !nodes.length ())
3144 /* First see virtual method of type itself. */
3145 binfo = get_binfo_at_offset (TYPE_BINFO (outer_type->type),
3146 context.offset, otr_type);
3147 if (binfo)
3148 target = gimple_get_virt_method_for_binfo (otr_token, binfo,
3149 &can_refer);
3150 else
3152 gcc_assert (odr_violation_reported);
3153 target = NULL;
3156 /* Destructors are never called through construction virtual tables,
3157 because the type is always known. */
3158 if (target && DECL_CXX_DESTRUCTOR_P (target))
3159 context.maybe_in_construction = false;
3161 if (target)
3163 /* In the case we get complete method, we don't need
3164 to walk derivations. */
3165 if (DECL_FINAL_P (target))
3166 context.maybe_derived_type = false;
3169 /* If OUTER_TYPE is abstract, we know we are not seeing its instance. */
3170 if (type_possibly_instantiated_p (outer_type->type))
3171 maybe_record_node (nodes, target, &inserted, can_refer, &complete);
3172 else
3173 skipped = true;
3175 if (binfo)
3176 matched_vtables.add (BINFO_VTABLE (binfo));
3178 /* Next walk recursively all derived types. */
3179 if (context.maybe_derived_type)
3181 for (i = 0; i < outer_type->derived_types.length(); i++)
3182 possible_polymorphic_call_targets_1 (nodes, &inserted,
3183 &matched_vtables,
3184 otr_type,
3185 outer_type->derived_types[i],
3186 otr_token, outer_type->type,
3187 context.offset, &complete,
3188 bases_to_consider,
3189 context.maybe_in_construction);
3191 if (!outer_type->all_derivations_known)
3193 if (!speculative && final_warning_records
3194 && nodes.length () == 1
3195 && TREE_CODE (TREE_TYPE (nodes[0]->decl)) == METHOD_TYPE)
3197 if (complete
3198 && warn_suggest_final_types
3199 && !outer_type->derived_types.length ())
3201 final_warning_records->grow_type_warnings
3202 (outer_type->id);
3203 final_warning_records->type_warnings[outer_type->id].count++;
3204 if (!final_warning_records->type_warnings
3205 [outer_type->id].dyn_count.initialized_p ())
3206 final_warning_records->type_warnings
3207 [outer_type->id].dyn_count = profile_count::zero ();
3208 final_warning_records->type_warnings[outer_type->id].dyn_count
3209 += final_warning_records->dyn_count;
3210 final_warning_records->type_warnings[outer_type->id].type
3211 = outer_type->type;
3212 (*slot)->type_warning = outer_type->id + 1;
3214 if (complete
3215 && warn_suggest_final_methods
3216 && types_same_for_odr (DECL_CONTEXT (nodes[0]->decl),
3217 outer_type->type))
3219 bool existed;
3220 struct decl_warn_count &c =
3221 final_warning_records->decl_warnings.get_or_insert
3222 (nodes[0]->decl, &existed);
3224 if (existed)
3226 c.count++;
3227 c.dyn_count += final_warning_records->dyn_count;
3229 else
3231 c.count = 1;
3232 c.dyn_count = final_warning_records->dyn_count;
3233 c.decl = nodes[0]->decl;
3235 (*slot)->decl_warning = nodes[0]->decl;
3238 complete = false;
3242 if (!speculative)
3244 /* Destructors are never called through construction virtual tables,
3245 because the type is always known. One of entries may be
3246 cxa_pure_virtual so look to at least two of them. */
3247 if (context.maybe_in_construction)
3248 for (i =0 ; i < MIN (nodes.length (), 2); i++)
3249 if (DECL_CXX_DESTRUCTOR_P (nodes[i]->decl))
3250 context.maybe_in_construction = false;
3251 if (context.maybe_in_construction)
3253 if (type != outer_type
3254 && (!skipped
3255 || (context.maybe_derived_type
3256 && !type_all_derivations_known_p (outer_type->type))))
3257 record_targets_from_bases (otr_type, otr_token, outer_type->type,
3258 context.offset, nodes, &inserted,
3259 &matched_vtables, &complete);
3260 if (skipped)
3261 maybe_record_node (nodes, target, &inserted, can_refer, &complete);
3262 for (i = 0; i < bases_to_consider.length(); i++)
3263 maybe_record_node (nodes, bases_to_consider[i], &inserted, can_refer, &complete);
3268 (*slot)->targets = nodes;
3269 (*slot)->complete = complete;
3270 if (completep)
3271 *completep = complete;
3273 timevar_pop (TV_IPA_VIRTUAL_CALL);
3274 return nodes;
3277 bool
3278 add_decl_warning (const tree &key ATTRIBUTE_UNUSED, const decl_warn_count &value,
3279 vec<const decl_warn_count*> *vec)
3281 vec->safe_push (&value);
3282 return true;
3285 /* Dump target list TARGETS into FILE. */
3287 static void
3288 dump_targets (FILE *f, vec <cgraph_node *> targets)
3290 unsigned int i;
3292 for (i = 0; i < targets.length (); i++)
3294 char *name = NULL;
3295 if (in_lto_p)
3296 name = cplus_demangle_v3 (targets[i]->asm_name (), 0);
3297 fprintf (f, " %s/%i", name ? name : targets[i]->name (),
3298 targets[i]->order);
3299 if (in_lto_p)
3300 free (name);
3301 if (!targets[i]->definition)
3302 fprintf (f, " (no definition%s)",
3303 DECL_DECLARED_INLINE_P (targets[i]->decl)
3304 ? " inline" : "");
3306 fprintf (f, "\n");
3309 /* Dump all possible targets of a polymorphic call. */
3311 void
3312 dump_possible_polymorphic_call_targets (FILE *f,
3313 tree otr_type,
3314 HOST_WIDE_INT otr_token,
3315 const ipa_polymorphic_call_context &ctx)
3317 vec <cgraph_node *> targets;
3318 bool final;
3319 odr_type type = get_odr_type (TYPE_MAIN_VARIANT (otr_type), false);
3320 unsigned int len;
3322 if (!type)
3323 return;
3324 targets = possible_polymorphic_call_targets (otr_type, otr_token,
3325 ctx,
3326 &final, NULL, false);
3327 fprintf (f, " Targets of polymorphic call of type %i:", type->id);
3328 print_generic_expr (f, type->type, TDF_SLIM);
3329 fprintf (f, " token %i\n", (int)otr_token);
3331 ctx.dump (f);
3333 fprintf (f, " %s%s%s%s\n ",
3334 final ? "This is a complete list." :
3335 "This is partial list; extra targets may be defined in other units.",
3336 ctx.maybe_in_construction ? " (base types included)" : "",
3337 ctx.maybe_derived_type ? " (derived types included)" : "",
3338 ctx.speculative_maybe_derived_type ? " (speculative derived types included)" : "");
3339 len = targets.length ();
3340 dump_targets (f, targets);
3342 targets = possible_polymorphic_call_targets (otr_type, otr_token,
3343 ctx,
3344 &final, NULL, true);
3345 if (targets.length () != len)
3347 fprintf (f, " Speculative targets:");
3348 dump_targets (f, targets);
3350 /* Ugly: during callgraph construction the target cache may get populated
3351 before all targets are found. While this is harmless (because all local
3352 types are discovered and only in those case we devirtualize fully and we
3353 don't do speculative devirtualization before IPA stage) it triggers
3354 assert here when dumping at that stage also populates the case with
3355 speculative targets. Quietly ignore this. */
3356 gcc_assert (symtab->state < IPA_SSA || targets.length () <= len);
3357 fprintf (f, "\n");
3361 /* Return true if N can be possibly target of a polymorphic call of
3362 OTR_TYPE/OTR_TOKEN. */
3364 bool
3365 possible_polymorphic_call_target_p (tree otr_type,
3366 HOST_WIDE_INT otr_token,
3367 const ipa_polymorphic_call_context &ctx,
3368 struct cgraph_node *n)
3370 vec <cgraph_node *> targets;
3371 unsigned int i;
3372 enum built_in_function fcode;
3373 bool final;
3375 if (TREE_CODE (TREE_TYPE (n->decl)) == FUNCTION_TYPE
3376 && ((fcode = DECL_FUNCTION_CODE (n->decl)) == BUILT_IN_UNREACHABLE
3377 || fcode == BUILT_IN_TRAP))
3378 return true;
3380 if (is_cxa_pure_virtual_p (n->decl))
3381 return true;
3383 if (!odr_hash)
3384 return true;
3385 targets = possible_polymorphic_call_targets (otr_type, otr_token, ctx, &final);
3386 for (i = 0; i < targets.length (); i++)
3387 if (n->semantically_equivalent_p (targets[i]))
3388 return true;
3390 /* At a moment we allow middle end to dig out new external declarations
3391 as a targets of polymorphic calls. */
3392 if (!final && !n->definition)
3393 return true;
3394 return false;
3399 /* Return true if N can be possibly target of a polymorphic call of
3400 OBJ_TYPE_REF expression REF in STMT. */
3402 bool
3403 possible_polymorphic_call_target_p (tree ref,
3404 gimple *stmt,
3405 struct cgraph_node *n)
3407 ipa_polymorphic_call_context context (current_function_decl, ref, stmt);
3408 tree call_fn = gimple_call_fn (stmt);
3410 return possible_polymorphic_call_target_p (obj_type_ref_class (call_fn),
3411 tree_to_uhwi
3412 (OBJ_TYPE_REF_TOKEN (call_fn)),
3413 context,
3418 /* After callgraph construction new external nodes may appear.
3419 Add them into the graph. */
3421 void
3422 update_type_inheritance_graph (void)
3424 struct cgraph_node *n;
3426 if (!odr_hash)
3427 return;
3428 free_polymorphic_call_targets_hash ();
3429 timevar_push (TV_IPA_INHERITANCE);
3430 /* We reconstruct the graph starting from types of all methods seen in the
3431 unit. */
3432 FOR_EACH_FUNCTION (n)
3433 if (DECL_VIRTUAL_P (n->decl)
3434 && !n->definition
3435 && n->real_symbol_p ())
3436 get_odr_type (TYPE_METHOD_BASETYPE (TREE_TYPE (n->decl)), true);
3437 timevar_pop (TV_IPA_INHERITANCE);
3441 /* Return true if N looks like likely target of a polymorphic call.
3442 Rule out cxa_pure_virtual, noreturns, function declared cold and
3443 other obvious cases. */
3445 bool
3446 likely_target_p (struct cgraph_node *n)
3448 int flags;
3449 /* cxa_pure_virtual and similar things are not likely. */
3450 if (TREE_CODE (TREE_TYPE (n->decl)) != METHOD_TYPE)
3451 return false;
3452 flags = flags_from_decl_or_type (n->decl);
3453 if (flags & ECF_NORETURN)
3454 return false;
3455 if (lookup_attribute ("cold",
3456 DECL_ATTRIBUTES (n->decl)))
3457 return false;
3458 if (n->frequency < NODE_FREQUENCY_NORMAL)
3459 return false;
3460 /* If there are no live virtual tables referring the target,
3461 the only way the target can be called is an instance coming from other
3462 compilation unit; speculative devirtualization is built around an
3463 assumption that won't happen. */
3464 if (!referenced_from_vtable_p (n))
3465 return false;
3466 return true;
3469 /* Compare type warning records P1 and P2 and choose one with larger count;
3470 helper for qsort. */
3473 type_warning_cmp (const void *p1, const void *p2)
3475 const odr_type_warn_count *t1 = (const odr_type_warn_count *)p1;
3476 const odr_type_warn_count *t2 = (const odr_type_warn_count *)p2;
3478 if (t1->dyn_count < t2->dyn_count)
3479 return 1;
3480 if (t1->dyn_count > t2->dyn_count)
3481 return -1;
3482 return t2->count - t1->count;
3485 /* Compare decl warning records P1 and P2 and choose one with larger count;
3486 helper for qsort. */
3489 decl_warning_cmp (const void *p1, const void *p2)
3491 const decl_warn_count *t1 = *(const decl_warn_count * const *)p1;
3492 const decl_warn_count *t2 = *(const decl_warn_count * const *)p2;
3494 if (t1->dyn_count < t2->dyn_count)
3495 return 1;
3496 if (t1->dyn_count > t2->dyn_count)
3497 return -1;
3498 return t2->count - t1->count;
3502 /* Try to speculatively devirtualize call to OTR_TYPE with OTR_TOKEN with
3503 context CTX. */
3505 struct cgraph_node *
3506 try_speculative_devirtualization (tree otr_type, HOST_WIDE_INT otr_token,
3507 ipa_polymorphic_call_context ctx)
3509 vec <cgraph_node *>targets
3510 = possible_polymorphic_call_targets
3511 (otr_type, otr_token, ctx, NULL, NULL, true);
3512 unsigned int i;
3513 struct cgraph_node *likely_target = NULL;
3515 for (i = 0; i < targets.length (); i++)
3516 if (likely_target_p (targets[i]))
3518 if (likely_target)
3519 return NULL;
3520 likely_target = targets[i];
3522 if (!likely_target
3523 ||!likely_target->definition
3524 || DECL_EXTERNAL (likely_target->decl))
3525 return NULL;
3527 /* Don't use an implicitly-declared destructor (c++/58678). */
3528 struct cgraph_node *non_thunk_target
3529 = likely_target->function_symbol ();
3530 if (DECL_ARTIFICIAL (non_thunk_target->decl))
3531 return NULL;
3532 if (likely_target->get_availability () <= AVAIL_INTERPOSABLE
3533 && likely_target->can_be_discarded_p ())
3534 return NULL;
3535 return likely_target;
3538 /* The ipa-devirt pass.
3539 When polymorphic call has only one likely target in the unit,
3540 turn it into a speculative call. */
3542 static unsigned int
3543 ipa_devirt (void)
3545 struct cgraph_node *n;
3546 hash_set<void *> bad_call_targets;
3547 struct cgraph_edge *e;
3549 int npolymorphic = 0, nspeculated = 0, nconverted = 0, ncold = 0;
3550 int nmultiple = 0, noverwritable = 0, ndevirtualized = 0, nnotdefined = 0;
3551 int nwrong = 0, nok = 0, nexternal = 0, nartificial = 0;
3552 int ndropped = 0;
3554 if (!odr_types_ptr)
3555 return 0;
3557 if (dump_file)
3558 dump_type_inheritance_graph (dump_file);
3560 /* We can output -Wsuggest-final-methods and -Wsuggest-final-types warnings.
3561 This is implemented by setting up final_warning_records that are updated
3562 by get_polymorphic_call_targets.
3563 We need to clear cache in this case to trigger recomputation of all
3564 entries. */
3565 if (warn_suggest_final_methods || warn_suggest_final_types)
3567 final_warning_records = new (final_warning_record);
3568 final_warning_records->dyn_count = profile_count::zero ();
3569 final_warning_records->grow_type_warnings (odr_types.length ());
3570 free_polymorphic_call_targets_hash ();
3573 FOR_EACH_DEFINED_FUNCTION (n)
3575 bool update = false;
3576 if (!opt_for_fn (n->decl, flag_devirtualize))
3577 continue;
3578 if (dump_file && n->indirect_calls)
3579 fprintf (dump_file, "\n\nProcesing function %s\n",
3580 n->dump_name ());
3581 for (e = n->indirect_calls; e; e = e->next_callee)
3582 if (e->indirect_info->polymorphic)
3584 struct cgraph_node *likely_target = NULL;
3585 void *cache_token;
3586 bool final;
3588 if (final_warning_records)
3589 final_warning_records->dyn_count = e->count.ipa ();
3591 vec <cgraph_node *>targets
3592 = possible_polymorphic_call_targets
3593 (e, &final, &cache_token, true);
3594 unsigned int i;
3596 /* Trigger warnings by calculating non-speculative targets. */
3597 if (warn_suggest_final_methods || warn_suggest_final_types)
3598 possible_polymorphic_call_targets (e);
3600 if (dump_file)
3601 dump_possible_polymorphic_call_targets
3602 (dump_file, e);
3604 npolymorphic++;
3606 /* See if the call can be devirtualized by means of ipa-prop's
3607 polymorphic call context propagation. If not, we can just
3608 forget about this call being polymorphic and avoid some heavy
3609 lifting in remove_unreachable_nodes that will otherwise try to
3610 keep all possible targets alive until inlining and in the inliner
3611 itself.
3613 This may need to be revisited once we add further ways to use
3614 the may edges, but it is a resonable thing to do right now. */
3616 if ((e->indirect_info->param_index == -1
3617 || (!opt_for_fn (n->decl, flag_devirtualize_speculatively)
3618 && e->indirect_info->vptr_changed))
3619 && !flag_ltrans_devirtualize)
3621 e->indirect_info->polymorphic = false;
3622 ndropped++;
3623 if (dump_file)
3624 fprintf (dump_file, "Dropping polymorphic call info;"
3625 " it can not be used by ipa-prop\n");
3628 if (!opt_for_fn (n->decl, flag_devirtualize_speculatively))
3629 continue;
3631 if (!e->maybe_hot_p ())
3633 if (dump_file)
3634 fprintf (dump_file, "Call is cold\n\n");
3635 ncold++;
3636 continue;
3638 if (e->speculative)
3640 if (dump_file)
3641 fprintf (dump_file, "Call is already speculated\n\n");
3642 nspeculated++;
3644 /* When dumping see if we agree with speculation. */
3645 if (!dump_file)
3646 continue;
3648 if (bad_call_targets.contains (cache_token))
3650 if (dump_file)
3651 fprintf (dump_file, "Target list is known to be useless\n\n");
3652 nmultiple++;
3653 continue;
3655 for (i = 0; i < targets.length (); i++)
3656 if (likely_target_p (targets[i]))
3658 if (likely_target)
3660 likely_target = NULL;
3661 if (dump_file)
3662 fprintf (dump_file, "More than one likely target\n\n");
3663 nmultiple++;
3664 break;
3666 likely_target = targets[i];
3668 if (!likely_target)
3670 bad_call_targets.add (cache_token);
3671 continue;
3673 /* This is reached only when dumping; check if we agree or disagree
3674 with the speculation. */
3675 if (e->speculative)
3677 struct cgraph_edge *e2;
3678 struct ipa_ref *ref;
3679 e->speculative_call_info (e2, e, ref);
3680 if (e2->callee->ultimate_alias_target ()
3681 == likely_target->ultimate_alias_target ())
3683 fprintf (dump_file, "We agree with speculation\n\n");
3684 nok++;
3686 else
3688 fprintf (dump_file, "We disagree with speculation\n\n");
3689 nwrong++;
3691 continue;
3693 if (!likely_target->definition)
3695 if (dump_file)
3696 fprintf (dump_file, "Target is not a definition\n\n");
3697 nnotdefined++;
3698 continue;
3700 /* Do not introduce new references to external symbols. While we
3701 can handle these just well, it is common for programs to
3702 incorrectly with headers defining methods they are linked
3703 with. */
3704 if (DECL_EXTERNAL (likely_target->decl))
3706 if (dump_file)
3707 fprintf (dump_file, "Target is external\n\n");
3708 nexternal++;
3709 continue;
3711 /* Don't use an implicitly-declared destructor (c++/58678). */
3712 struct cgraph_node *non_thunk_target
3713 = likely_target->function_symbol ();
3714 if (DECL_ARTIFICIAL (non_thunk_target->decl))
3716 if (dump_file)
3717 fprintf (dump_file, "Target is artificial\n\n");
3718 nartificial++;
3719 continue;
3721 if (likely_target->get_availability () <= AVAIL_INTERPOSABLE
3722 && likely_target->can_be_discarded_p ())
3724 if (dump_file)
3725 fprintf (dump_file, "Target is overwritable\n\n");
3726 noverwritable++;
3727 continue;
3729 else if (dbg_cnt (devirt))
3731 if (dump_enabled_p ())
3733 location_t locus = gimple_location_safe (e->call_stmt);
3734 dump_printf_loc (MSG_OPTIMIZED_LOCATIONS, locus,
3735 "speculatively devirtualizing call "
3736 "in %s to %s\n",
3737 n->dump_name (),
3738 likely_target->dump_name ());
3740 if (!likely_target->can_be_discarded_p ())
3742 cgraph_node *alias;
3743 alias = dyn_cast<cgraph_node *> (likely_target->noninterposable_alias ());
3744 if (alias)
3745 likely_target = alias;
3747 nconverted++;
3748 update = true;
3749 e->make_speculative
3750 (likely_target, e->count.apply_scale (8, 10));
3753 if (update)
3754 ipa_update_overall_fn_summary (n);
3756 if (warn_suggest_final_methods || warn_suggest_final_types)
3758 if (warn_suggest_final_types)
3760 final_warning_records->type_warnings.qsort (type_warning_cmp);
3761 for (unsigned int i = 0;
3762 i < final_warning_records->type_warnings.length (); i++)
3763 if (final_warning_records->type_warnings[i].count)
3765 tree type = final_warning_records->type_warnings[i].type;
3766 int count = final_warning_records->type_warnings[i].count;
3767 profile_count dyn_count
3768 = final_warning_records->type_warnings[i].dyn_count;
3770 if (!(dyn_count > 0))
3771 warning_n (DECL_SOURCE_LOCATION (TYPE_NAME (type)),
3772 OPT_Wsuggest_final_types, count,
3773 "Declaring type %qD final "
3774 "would enable devirtualization of %i call",
3775 "Declaring type %qD final "
3776 "would enable devirtualization of %i calls",
3777 type,
3778 count);
3779 else
3780 warning_n (DECL_SOURCE_LOCATION (TYPE_NAME (type)),
3781 OPT_Wsuggest_final_types, count,
3782 "Declaring type %qD final "
3783 "would enable devirtualization of %i call "
3784 "executed %lli times",
3785 "Declaring type %qD final "
3786 "would enable devirtualization of %i calls "
3787 "executed %lli times",
3788 type,
3789 count,
3790 (long long) dyn_count.to_gcov_type ());
3794 if (warn_suggest_final_methods)
3796 auto_vec<const decl_warn_count*> decl_warnings_vec;
3798 final_warning_records->decl_warnings.traverse
3799 <vec<const decl_warn_count *> *, add_decl_warning> (&decl_warnings_vec);
3800 decl_warnings_vec.qsort (decl_warning_cmp);
3801 for (unsigned int i = 0; i < decl_warnings_vec.length (); i++)
3803 tree decl = decl_warnings_vec[i]->decl;
3804 int count = decl_warnings_vec[i]->count;
3805 profile_count dyn_count
3806 = decl_warnings_vec[i]->dyn_count;
3808 if (!(dyn_count > 0))
3809 if (DECL_CXX_DESTRUCTOR_P (decl))
3810 warning_n (DECL_SOURCE_LOCATION (decl),
3811 OPT_Wsuggest_final_methods, count,
3812 "Declaring virtual destructor of %qD final "
3813 "would enable devirtualization of %i call",
3814 "Declaring virtual destructor of %qD final "
3815 "would enable devirtualization of %i calls",
3816 DECL_CONTEXT (decl), count);
3817 else
3818 warning_n (DECL_SOURCE_LOCATION (decl),
3819 OPT_Wsuggest_final_methods, count,
3820 "Declaring method %qD final "
3821 "would enable devirtualization of %i call",
3822 "Declaring method %qD final "
3823 "would enable devirtualization of %i calls",
3824 decl, count);
3825 else if (DECL_CXX_DESTRUCTOR_P (decl))
3826 warning_n (DECL_SOURCE_LOCATION (decl),
3827 OPT_Wsuggest_final_methods, count,
3828 "Declaring virtual destructor of %qD final "
3829 "would enable devirtualization of %i call "
3830 "executed %lli times",
3831 "Declaring virtual destructor of %qD final "
3832 "would enable devirtualization of %i calls "
3833 "executed %lli times",
3834 DECL_CONTEXT (decl), count,
3835 (long long)dyn_count.to_gcov_type ());
3836 else
3837 warning_n (DECL_SOURCE_LOCATION (decl),
3838 OPT_Wsuggest_final_methods, count,
3839 "Declaring method %qD final "
3840 "would enable devirtualization of %i call "
3841 "executed %lli times",
3842 "Declaring method %qD final "
3843 "would enable devirtualization of %i calls "
3844 "executed %lli times",
3845 decl, count,
3846 (long long)dyn_count.to_gcov_type ());
3850 delete (final_warning_records);
3851 final_warning_records = 0;
3854 if (dump_file)
3855 fprintf (dump_file,
3856 "%i polymorphic calls, %i devirtualized,"
3857 " %i speculatively devirtualized, %i cold\n"
3858 "%i have multiple targets, %i overwritable,"
3859 " %i already speculated (%i agree, %i disagree),"
3860 " %i external, %i not defined, %i artificial, %i infos dropped\n",
3861 npolymorphic, ndevirtualized, nconverted, ncold,
3862 nmultiple, noverwritable, nspeculated, nok, nwrong,
3863 nexternal, nnotdefined, nartificial, ndropped);
3864 return ndevirtualized || ndropped ? TODO_remove_functions : 0;
3867 namespace {
3869 const pass_data pass_data_ipa_devirt =
3871 IPA_PASS, /* type */
3872 "devirt", /* name */
3873 OPTGROUP_NONE, /* optinfo_flags */
3874 TV_IPA_DEVIRT, /* tv_id */
3875 0, /* properties_required */
3876 0, /* properties_provided */
3877 0, /* properties_destroyed */
3878 0, /* todo_flags_start */
3879 ( TODO_dump_symtab ), /* todo_flags_finish */
3882 class pass_ipa_devirt : public ipa_opt_pass_d
3884 public:
3885 pass_ipa_devirt (gcc::context *ctxt)
3886 : ipa_opt_pass_d (pass_data_ipa_devirt, ctxt,
3887 NULL, /* generate_summary */
3888 NULL, /* write_summary */
3889 NULL, /* read_summary */
3890 NULL, /* write_optimization_summary */
3891 NULL, /* read_optimization_summary */
3892 NULL, /* stmt_fixup */
3893 0, /* function_transform_todo_flags_start */
3894 NULL, /* function_transform */
3895 NULL) /* variable_transform */
3898 /* opt_pass methods: */
3899 virtual bool gate (function *)
3901 /* In LTO, always run the IPA passes and decide on function basis if the
3902 pass is enabled. */
3903 if (in_lto_p)
3904 return true;
3905 return (flag_devirtualize
3906 && (flag_devirtualize_speculatively
3907 || (warn_suggest_final_methods
3908 || warn_suggest_final_types))
3909 && optimize);
3912 virtual unsigned int execute (function *) { return ipa_devirt (); }
3914 }; // class pass_ipa_devirt
3916 } // anon namespace
3918 ipa_opt_pass_d *
3919 make_pass_ipa_devirt (gcc::context *ctxt)
3921 return new pass_ipa_devirt (ctxt);
3924 #include "gt-ipa-devirt.h"