1 /* Callgraph handling code.
2 Copyright (C) 2003-2019 Free Software Foundation, Inc.
3 Contributed by Jan Hubicka
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
24 #include "profile-count.h"
26 #include "plugin-api.h"
27 #include "ipa-param-manipulation.h"
29 extern void debuginfo_early_init (void);
30 extern void debuginfo_init (void);
31 extern void debuginfo_fini (void);
32 extern void debuginfo_start (void);
33 extern void debuginfo_stop (void);
34 extern void debuginfo_early_start (void);
35 extern void debuginfo_early_stop (void);
38 typedef ipa_opt_pass_d
*ipa_opt_pass
;
40 /* Symbol table consists of functions and variables.
41 TODO: add labels and CONST_DECLs. */
49 /* Section names are stored as reference counted strings in GGC safe hashtable
50 (to make them survive through PCH). */
52 struct GTY((for_user
)) section_hash_entry
55 char *name
; /* As long as this datastructure stays in GGC, we cannot put
56 string at the tail of structure of GGC dies in horrible
60 struct section_name_hasher
: ggc_ptr_hash
<section_hash_entry
>
62 typedef const char *compare_type
;
64 static hashval_t
hash (section_hash_entry
*);
65 static bool equal (section_hash_entry
*, const char *);
70 /* Not yet set by cgraph_function_body_availability. */
72 /* Function body/variable initializer is unknown. */
74 /* Function body/variable initializer is known but might be replaced
75 by a different one from other compilation unit and thus needs to
76 be dealt with a care. Like AVAIL_NOT_AVAILABLE it can have
77 arbitrary side effects on escaping variables and functions, while
78 like AVAILABLE it might access static variables. */
80 /* Function body/variable initializer is known and will be used in final
83 /* Function body/variable initializer is known and all it's uses are
84 explicitly visible within current unit (i.e. it's address is never taken
85 and it is not exported to other units). Currently used only for
90 /* Classification of symbols WRT partitioning. */
91 enum symbol_partitioning_class
93 /* External declarations are ignored by partitioning algorithms and they are
94 added into the boundary later via compute_ltrans_boundary. */
96 /* Partitioned symbols are put into one of partitions. */
98 /* Duplicated symbols (such as comdat or constant pool references) are
99 copied into every node needing them via add_symbol_to_partition. */
103 /* Base of all entries in the symbol table.
104 The symtab_node is inherited by cgraph and varpol nodes. */
105 struct GTY((desc ("%h.type"), tag ("SYMTAB_SYMBOL"),
106 chain_next ("%h.next"), chain_prev ("%h.previous")))
110 friend class symbol_table
;
113 const char *name () const;
115 /* Return dump name. */
116 const char *dump_name () const;
118 /* Return asm name. */
119 const char *asm_name () const;
121 /* Return dump name with assembler name. */
122 const char *dump_asm_name () const;
124 /* Return visibility name. */
125 const char *get_visibility_string () const;
127 /* Return type_name name. */
128 const char *get_symtab_type_string () const;
130 /* Add node into symbol table. This function is not used directly, but via
131 cgraph/varpool node creation routines. */
132 void register_symbol (void);
134 /* Remove symbol from symbol table. */
137 /* Dump symtab node to F. */
140 /* Dump symtab callgraph in graphviz format. */
141 void dump_graphviz (FILE *f
);
143 /* Dump symtab node to stderr. */
144 void DEBUG_FUNCTION
debug (void);
146 /* Verify consistency of node. */
147 void DEBUG_FUNCTION
verify (void);
149 /* Return ipa reference from this symtab_node to
150 REFERRED_NODE or REFERRED_VARPOOL_NODE. USE_TYPE specify type
151 of the use and STMT the statement (if it exists). */
152 ipa_ref
*create_reference (symtab_node
*referred_node
,
153 enum ipa_ref_use use_type
);
155 /* Return ipa reference from this symtab_node to
156 REFERRED_NODE or REFERRED_VARPOOL_NODE. USE_TYPE specify type
157 of the use and STMT the statement (if it exists). */
158 ipa_ref
*create_reference (symtab_node
*referred_node
,
159 enum ipa_ref_use use_type
, gimple
*stmt
);
161 /* If VAL is a reference to a function or a variable, add a reference from
162 this symtab_node to the corresponding symbol table node. Return the new
163 reference or NULL if none was created. */
164 ipa_ref
*maybe_create_reference (tree val
, gimple
*stmt
);
166 /* Clone all references from symtab NODE to this symtab_node. */
167 void clone_references (symtab_node
*node
);
169 /* Remove all stmt references in non-speculative references.
170 Those are not maintained during inlining & clonning.
171 The exception are speculative references that are updated along
172 with callgraph edges associated with them. */
173 void clone_referring (symtab_node
*node
);
175 /* Clone reference REF to this symtab_node and set its stmt to STMT. */
176 ipa_ref
*clone_reference (ipa_ref
*ref
, gimple
*stmt
);
178 /* Find the structure describing a reference to REFERRED_NODE
179 and associated with statement STMT. */
180 ipa_ref
*find_reference (symtab_node
*referred_node
, gimple
*stmt
,
181 unsigned int lto_stmt_uid
);
183 /* Remove all references that are associated with statement STMT. */
184 void remove_stmt_references (gimple
*stmt
);
186 /* Remove all stmt references in non-speculative references.
187 Those are not maintained during inlining & clonning.
188 The exception are speculative references that are updated along
189 with callgraph edges associated with them. */
190 void clear_stmts_in_references (void);
192 /* Remove all references in ref list. */
193 void remove_all_references (void);
195 /* Remove all referring items in ref list. */
196 void remove_all_referring (void);
198 /* Dump references in ref list to FILE. */
199 void dump_references (FILE *file
);
201 /* Dump referring in list to FILE. */
202 void dump_referring (FILE *);
204 /* Get number of references for this node. */
205 inline unsigned num_references (void)
207 return ref_list
.references
? ref_list
.references
->length () : 0;
210 /* Iterates I-th reference in the list, REF is also set. */
211 ipa_ref
*iterate_reference (unsigned i
, ipa_ref
*&ref
);
213 /* Iterates I-th referring item in the list, REF is also set. */
214 ipa_ref
*iterate_referring (unsigned i
, ipa_ref
*&ref
);
216 /* Iterates I-th referring alias item in the list, REF is also set. */
217 ipa_ref
*iterate_direct_aliases (unsigned i
, ipa_ref
*&ref
);
219 /* Return true if symtab node and TARGET represents
220 semantically equivalent symbols. */
221 bool semantically_equivalent_p (symtab_node
*target
);
223 /* Classify symbol symtab node for partitioning. */
224 enum symbol_partitioning_class
get_partitioning_class (void);
226 /* Return comdat group. */
227 tree
get_comdat_group ()
229 return x_comdat_group
;
232 /* Return comdat group as identifier_node. */
233 tree
get_comdat_group_id ()
235 if (x_comdat_group
&& TREE_CODE (x_comdat_group
) != IDENTIFIER_NODE
)
236 x_comdat_group
= DECL_ASSEMBLER_NAME (x_comdat_group
);
237 return x_comdat_group
;
240 /* Set comdat group. */
241 void set_comdat_group (tree group
)
243 gcc_checking_assert (!group
|| TREE_CODE (group
) == IDENTIFIER_NODE
245 x_comdat_group
= group
;
248 /* Return section as string. */
249 const char * get_section ()
253 return x_section
->name
;
256 /* Remove node from same comdat group. */
257 void remove_from_same_comdat_group (void);
259 /* Add this symtab_node to the same comdat group that OLD is in. */
260 void add_to_same_comdat_group (symtab_node
*old_node
);
262 /* Dissolve the same_comdat_group list in which NODE resides. */
263 void dissolve_same_comdat_group_list (void);
265 /* Return true when symtab_node is known to be used from other (non-LTO)
266 object file. Known only when doing LTO via linker plugin. */
267 bool used_from_object_file_p (void);
269 /* Walk the alias chain to return the symbol NODE is alias of.
270 If NODE is not an alias, return NODE.
271 When AVAILABILITY is non-NULL, get minimal availability in the chain.
272 When REF is non-NULL, assume that reference happens in symbol REF
273 when determining the availability. */
274 symtab_node
*ultimate_alias_target (enum availability
*avail
= NULL
,
275 struct symtab_node
*ref
= NULL
);
277 /* Return next reachable static symbol with initializer after NODE. */
278 inline symtab_node
*next_defined_symbol (void);
280 /* Add reference recording that symtab node is alias of TARGET.
281 If TRANSPARENT is true make the alias to be transparent alias.
282 The function can fail in the case of aliasing cycles; in this case
284 bool resolve_alias (symtab_node
*target
, bool transparent
= false);
286 /* C++ FE sometimes change linkage flags after producing same
288 void fixup_same_cpp_alias_visibility (symtab_node
*target
);
290 /* Call callback on symtab node and aliases associated to this node.
291 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
293 bool call_for_symbol_and_aliases (bool (*callback
) (symtab_node
*, void *),
295 bool include_overwrite
);
297 /* If node cannot be interposable by static or dynamic linker to point to
298 different definition, return this symbol. Otherwise look for alias with
299 such property and if none exists, introduce new one. */
300 symtab_node
*noninterposable_alias (void);
302 /* Return node that alias is aliasing. */
303 inline symtab_node
*get_alias_target (void);
305 /* Set section for symbol and its aliases. */
306 void set_section (const char *section
);
308 /* Set section, do not recurse into aliases.
309 When one wants to change section of symbol and its aliases,
311 void set_section_for_node (const char *section
);
313 /* Set initialization priority to PRIORITY. */
314 void set_init_priority (priority_type priority
);
316 /* Return the initialization priority. */
317 priority_type
get_init_priority ();
319 /* Return availability of NODE when referenced from REF. */
320 enum availability
get_availability (symtab_node
*ref
= NULL
);
322 /* During LTO stream-in this predicate can be used to check whether node
323 in question prevails in the linking to save some memory usage. */
324 bool prevailing_p (void);
326 /* Return true if NODE binds to current definition in final executable
327 when referenced from REF. If REF is NULL return conservative value
328 for any reference. */
329 bool binds_to_current_def_p (symtab_node
*ref
= NULL
);
331 /* Make DECL local. */
332 void make_decl_local (void);
334 /* Copy visibility from N. */
335 void copy_visibility_from (symtab_node
*n
);
337 /* Return desired alignment of the definition. This is NOT alignment useful
338 to access THIS, because THIS may be interposable and DECL_ALIGN should
339 be used instead. It however must be guaranteed when output definition
341 unsigned int definition_alignment ();
343 /* Return true if alignment can be increased. */
344 bool can_increase_alignment_p ();
346 /* Increase alignment of symbol to ALIGN. */
347 void increase_alignment (unsigned int align
);
349 /* Return true if list contains an alias. */
350 bool has_aliases_p (void);
352 /* Return true when the symbol is real symbol, i.e. it is not inline clone
353 or abstract function kept for debug info purposes only. */
354 bool real_symbol_p (void);
356 /* Return true when the symbol needs to be output to the LTO symbol table. */
357 bool output_to_lto_symbol_table_p (void);
359 /* Determine if symbol declaration is needed. That is, visible to something
360 either outside this translation unit, something magic in the system
361 configury. This function is used just during symbol creation. */
362 bool needed_p (void);
364 /* Return true if this symbol is a function from the C frontend specified
365 directly in RTL form (with "__RTL"). */
366 bool native_rtl_p () const;
368 /* Return true when there are references to the node. */
369 bool referred_to_p (bool include_self
= true);
371 /* Return true if symbol can be discarded by linker from the binary.
372 Assume that symbol is used (so there is no need to take into account
373 garbage collecting linkers)
375 This can happen for comdats, commons and weaks when they are prevailed
376 by other definition at static linking time. */
378 can_be_discarded_p (void)
380 return (DECL_EXTERNAL (decl
)
381 || ((get_comdat_group ()
382 || DECL_COMMON (decl
)
383 || (DECL_SECTION_NAME (decl
) && DECL_WEAK (decl
)))
384 && ((resolution
!= LDPR_PREVAILING_DEF
385 && resolution
!= LDPR_PREVAILING_DEF_IRONLY_EXP
)
386 || flag_incremental_link
)
387 && resolution
!= LDPR_PREVAILING_DEF_IRONLY
));
390 /* Return true if NODE is local to a particular COMDAT group, and must not
391 be named from outside the COMDAT. This is used for C++ decloned
393 inline bool comdat_local_p (void)
395 return (same_comdat_group
&& !TREE_PUBLIC (decl
));
398 /* Return true if ONE and TWO are part of the same COMDAT group. */
399 inline bool in_same_comdat_group_p (symtab_node
*target
);
401 /* Return true if symbol is known to be nonzero. */
402 bool nonzero_address ();
404 /* Return 0 if symbol is known to have different address than S2,
405 Return 1 if symbol is known to have same address as S2,
408 If MEMORY_ACCESSED is true, assume that both memory pointer to THIS
409 and S2 is going to be accessed. This eliminates the situations when
410 either THIS or S2 is NULL and is useful for comparing bases when deciding
411 about memory aliasing. */
412 int equal_address_to (symtab_node
*s2
, bool memory_accessed
= false);
414 /* Return true if symbol's address may possibly be compared to other
416 bool address_matters_p ();
418 /* Return true if NODE's address can be compared. This use properties
419 of NODE only and does not look if the address is actually taken in
420 interesting way. For that use ADDRESS_MATTERS_P instead. */
421 bool address_can_be_compared_p (void);
423 /* Return symbol table node associated with DECL, if any,
424 and NULL otherwise. */
425 static inline symtab_node
*get (const_tree decl
)
427 /* Check that we are called for sane type of object - functions
428 and static or external variables. */
429 gcc_checking_assert (TREE_CODE (decl
) == FUNCTION_DECL
430 || (TREE_CODE (decl
) == VAR_DECL
431 && (TREE_STATIC (decl
) || DECL_EXTERNAL (decl
)
433 /* Check that the mapping is sane - perhaps this check can go away,
434 but at the moment frontends tends to corrupt the mapping by calling
435 memcpy/memset on the tree nodes. */
436 gcc_checking_assert (!decl
->decl_with_vis
.symtab_node
437 || decl
->decl_with_vis
.symtab_node
->decl
== decl
);
438 return decl
->decl_with_vis
.symtab_node
;
441 /* Try to find a symtab node for declaration DECL and if it does not
442 exist or if it corresponds to an inline clone, create a new one. */
443 static inline symtab_node
* get_create (tree node
);
445 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
446 Return NULL if there's no such node. */
447 static symtab_node
*get_for_asmname (const_tree asmname
);
449 /* Verify symbol table for internal consistency. */
450 static DEBUG_FUNCTION
void verify_symtab_nodes (void);
452 /* Perform internal consistency checks, if they are enabled. */
453 static inline void checking_verify_symtab_nodes (void);
455 /* Type of the symbol. */
456 ENUM_BITFIELD (symtab_type
) type
: 8;
458 /* The symbols resolution. */
459 ENUM_BITFIELD (ld_plugin_symbol_resolution
) resolution
: 8;
461 /*** Flags representing the symbol type. ***/
463 /* True when symbol corresponds to a definition in current unit.
464 set via finalize_function or finalize_decl */
465 unsigned definition
: 1;
466 /* True when symbol is an alias.
467 Set by assemble_alias. */
469 /* When true the alias is translated into its target symbol either by GCC
470 or assembler (it also may just be a duplicate declaration of the same
473 Currently transparent aliases come in three different flavors
474 - aliases having the same assembler name as their target (aka duplicated
475 declarations). In this case the assembler names compare via
476 assembler_names_equal_p and weakref is false
477 - aliases that are renamed at a time being output to final file
478 by varasm.c. For those DECL_ASSEMBLER_NAME have
479 IDENTIFIER_TRANSPARENT_ALIAS set and thus also their assembler
481 Weakrefs belong to this category when we target assembler without
483 - weakrefs that are renamed by assembler via .weakref directive.
484 In this case the alias may or may not be definition (depending if
485 target declaration was seen by the compiler), weakref is set.
486 Unless we are before renaming statics, assembler names are different.
488 Given that we now support duplicate declarations, the second option is
489 redundant and will be removed. */
490 unsigned transparent_alias
: 1;
491 /* True when alias is a weakref. */
492 unsigned weakref
: 1;
493 /* C++ frontend produce same body aliases and extra name aliases for
494 virtual functions and vtables that are obviously equivalent.
495 Those aliases are bit special, especially because C++ frontend
496 visibility code is so ugly it cannot get them right at first time
497 and their visibility needs to be copied from their "masters" at
498 the end of parsing. */
499 unsigned cpp_implicit_alias
: 1;
500 /* Set once the definition was analyzed. The list of references and
501 other properties are built during analysis. */
502 unsigned analyzed
: 1;
503 /* Set for write-only variables. */
504 unsigned writeonly
: 1;
505 /* Visibility of symbol was used for further optimization; do not
506 permit further changes. */
507 unsigned refuse_visibility_changes
: 1;
509 /*** Visibility and linkage flags. ***/
511 /* Set when function is visible by other units. */
512 unsigned externally_visible
: 1;
513 /* Don't reorder to other symbols having this set. */
514 unsigned no_reorder
: 1;
515 /* The symbol will be assumed to be used in an invisible way (like
516 by an toplevel asm statement). */
517 unsigned force_output
: 1;
518 /* Like FORCE_OUTPUT, but in the case it is ABI requiring the symbol to be
519 exported. Unlike FORCE_OUTPUT this flag gets cleared to symbols promoted
520 to static and it does not inhibit optimization. */
521 unsigned forced_by_abi
: 1;
522 /* True when the name is known to be unique and thus it does not need mangling. */
523 unsigned unique_name
: 1;
524 /* Specify whether the section was set by user or by
525 compiler via -ffunction-sections. */
526 unsigned implicit_section
: 1;
527 /* True when body and other characteristics have been removed by
528 symtab_remove_unreachable_nodes. */
529 unsigned body_removed
: 1;
531 /*** WHOPR Partitioning flags.
532 These flags are used at ltrans stage when only part of the callgraph is
535 /* Set when variable is used from other LTRANS partition. */
536 unsigned used_from_other_partition
: 1;
537 /* Set when function is available in the other LTRANS partition.
538 During WPA output it is used to mark nodes that are present in
539 multiple partitions. */
540 unsigned in_other_partition
: 1;
544 /*** other flags. ***/
546 /* Set when symbol has address taken. */
547 unsigned address_taken
: 1;
548 /* Set when init priority is set. */
549 unsigned in_init_priority_hash
: 1;
551 /* Set when symbol needs to be streamed into LTO bytecode for LTO, or in case
552 of offloading, for separate compilation for a different target. */
553 unsigned need_lto_streaming
: 1;
555 /* Set when symbol can be streamed into bytecode for offloading. */
556 unsigned offloadable
: 1;
558 /* Set when symbol is an IFUNC resolver. */
559 unsigned ifunc_resolver
: 1;
562 /* Ordering of all symtab entries. */
565 /* Declaration representing the symbol. */
568 /* Linked list of symbol table entries starting with symtab_nodes. */
570 symtab_node
*previous
;
572 /* Linked list of symbols with the same asm name. There may be multiple
573 entries for single symbol name during LTO, because symbols are renamed
574 only after partitioning.
576 Because inline clones are kept in the assembler name has, they also produce
579 There are also several long standing bugs where frontends and builtin
580 code produce duplicated decls. */
581 symtab_node
*next_sharing_asm_name
;
582 symtab_node
*previous_sharing_asm_name
;
584 /* Circular list of nodes in the same comdat group if non-NULL. */
585 symtab_node
*same_comdat_group
;
587 /* Vectors of referring and referenced entities. */
588 ipa_ref_list ref_list
;
590 /* Alias target. May be either DECL pointer or ASSEMBLER_NAME pointer
591 depending to what was known to frontend on the creation time.
592 Once alias is resolved, this pointer become NULL. */
595 /* File stream where this node is being written to. */
596 struct lto_file_decl_data
* lto_file_data
;
598 PTR
GTY ((skip
)) aux
;
600 /* Comdat group the symbol is in. Can be private if GGC allowed that. */
603 /* Section name. Again can be private, if allowed. */
604 section_hash_entry
*x_section
;
607 /* Dump base fields of symtab nodes to F. Not to be used directly. */
608 void dump_base (FILE *);
610 /* Verify common part of symtab node. */
611 bool DEBUG_FUNCTION
verify_base (void);
613 /* Remove node from symbol table. This function is not used directly, but via
614 cgraph/varpool node removal routines. */
615 void unregister (void);
617 /* Return the initialization and finalization priority information for
618 DECL. If there is no previous priority information, a freshly
619 allocated structure is returned. */
620 struct symbol_priority_map
*priority_info (void);
622 /* Worker for call_for_symbol_and_aliases_1. */
623 bool call_for_symbol_and_aliases_1 (bool (*callback
) (symtab_node
*, void *),
625 bool include_overwrite
);
627 /* Worker for set_section. */
628 static bool set_section (symtab_node
*n
, void *s
);
630 /* Worker for symtab_resolve_alias. */
631 static bool set_implicit_section (symtab_node
*n
, void *);
633 /* Worker searching noninterposable alias. */
634 static bool noninterposable_alias (symtab_node
*node
, void *data
);
636 /* Worker for ultimate_alias_target. */
637 symtab_node
*ultimate_alias_target_1 (enum availability
*avail
= NULL
,
638 symtab_node
*ref
= NULL
);
640 /* Get dump name with normal or assembly name. */
641 const char *get_dump_name (bool asm_name_p
) const;
645 symtab_node::checking_verify_symtab_nodes (void)
648 symtab_node::verify_symtab_nodes ();
651 /* Walk all aliases for NODE. */
652 #define FOR_EACH_ALIAS(NODE, ALIAS) \
653 for (unsigned ALIAS##_iter_ = 0; \
654 (NODE)->iterate_direct_aliases (ALIAS##_iter_, ALIAS); \
657 /* This is the information that is put into the cgraph local structure
658 to recover a function. */
659 struct lto_file_decl_data
;
661 extern const char * const cgraph_availability_names
[];
662 extern const char * const ld_plugin_symbol_resolution_names
[];
663 extern const char * const tls_model_names
[];
665 /* Sub-structure of cgraph_node. Holds information about thunk, used only for
668 Thunks are basically wrappers around methods which are introduced in case
669 of multiple inheritance in order to adjust the value of the "this" pointer
670 or of the returned value.
672 In the case of this-adjusting thunks, each back-end can override the
673 can_output_mi_thunk/output_mi_thunk target hooks to generate a minimal thunk
674 (with a tail call for instance) directly as assembly. For the default hook
675 or for the case where the can_output_mi_thunk hooks return false, the thunk
676 is gimplified and lowered using the regular machinery. */
678 struct GTY(()) cgraph_thunk_info
{
679 /* Offset used to adjust "this". */
680 HOST_WIDE_INT fixed_offset
;
682 /* Offset in the virtual table to get the offset to adjust "this". Valid iff
683 VIRTUAL_OFFSET_P is true. */
684 HOST_WIDE_INT virtual_value
;
686 /* Offset from "this" to get the offset to adjust "this". Zero means: this
687 offset is to be ignored. */
688 HOST_WIDE_INT indirect_offset
;
690 /* Thunk target, i.e. the method that this thunk wraps. Depending on the
691 TARGET_USE_LOCAL_THUNK_ALIAS_P macro, this may have to be a new alias. */
694 /* Nonzero for a "this" adjusting thunk and zero for a result adjusting
698 /* If true, this thunk is what we call a virtual thunk. In this case:
699 * for this-adjusting thunks, after the FIXED_OFFSET based adjustment is
700 done, add to the result the offset found in the vtable at:
702 * for result-adjusting thunks, the FIXED_OFFSET adjustment is done after
704 bool virtual_offset_p
;
706 /* Set to true when alias node (the cgraph_node to which this struct belong)
707 is a thunk. Access to any other fields is invalid if this is false. */
711 /* Represent which DECL tree (or reference to such tree)
712 will be replaced by another tree while versioning. */
713 struct GTY(()) ipa_replace_map
715 /* The new (replacing) tree. */
717 /* Parameter number to replace, when old_tree is NULL. */
721 struct GTY(()) cgraph_clone_info
723 /* Constants discovered by IPA-CP, i.e. which parameter should be replaced
725 vec
<ipa_replace_map
*, va_gc
> *tree_map
;
726 /* Parameter modification that IPA-SRA decided to perform. */
727 ipa_param_adjustments
*param_adjustments
;
728 /* Lists of dummy-decl and offset pairs representing split formal parameters
729 in the caller. Offsets of all new replacements are enumerated, those
730 coming from the same original parameter have the same dummy decl stored
733 Dummy decls sit in call statement arguments followed by new parameter
734 decls (or their SSA names) in between (caller) clone materialization and
735 call redirection. Redirection then recognizes the dummy variable and
736 together with the stored offsets can reconstruct what exactly the new
737 parameter decls represent and can leave in place only those that the
739 vec
<ipa_param_performed_split
, va_gc
> *performed_splits
;
742 enum cgraph_simd_clone_arg_type
744 SIMD_CLONE_ARG_TYPE_VECTOR
,
745 SIMD_CLONE_ARG_TYPE_UNIFORM
,
746 /* These are only for integer/pointer arguments passed by value. */
747 SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP
,
748 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP
,
749 /* These 6 are only for reference type arguments or arguments passed
751 SIMD_CLONE_ARG_TYPE_LINEAR_REF_CONSTANT_STEP
,
752 SIMD_CLONE_ARG_TYPE_LINEAR_REF_VARIABLE_STEP
,
753 SIMD_CLONE_ARG_TYPE_LINEAR_UVAL_CONSTANT_STEP
,
754 SIMD_CLONE_ARG_TYPE_LINEAR_UVAL_VARIABLE_STEP
,
755 SIMD_CLONE_ARG_TYPE_LINEAR_VAL_CONSTANT_STEP
,
756 SIMD_CLONE_ARG_TYPE_LINEAR_VAL_VARIABLE_STEP
,
757 SIMD_CLONE_ARG_TYPE_MASK
760 /* Function arguments in the original function of a SIMD clone.
761 Supplementary data for `struct simd_clone'. */
763 struct GTY(()) cgraph_simd_clone_arg
{
764 /* Original function argument as it originally existed in
768 /* orig_arg's function (or for extern functions type from
772 /* If argument is a vector, this holds the vector version of
773 orig_arg that after adjusting the argument types will live in
774 DECL_ARGUMENTS. Otherwise, this is NULL.
776 This basically holds:
777 vector(simdlen) __typeof__(orig_arg) new_arg. */
780 /* vector_arg's type (or for extern functions new vector type. */
783 /* If argument is a vector, this holds the array where the simd
784 argument is held while executing the simd clone function. This
785 is a local variable in the cloned function. Its content is
786 copied from vector_arg upon entry to the clone.
788 This basically holds:
789 __typeof__(orig_arg) simd_array[simdlen]. */
792 /* A SIMD clone's argument can be either linear (constant or
793 variable), uniform, or vector. */
794 enum cgraph_simd_clone_arg_type arg_type
;
796 /* For arg_type SIMD_CLONE_ARG_TYPE_LINEAR_*CONSTANT_STEP this is
797 the constant linear step, if arg_type is
798 SIMD_CLONE_ARG_TYPE_LINEAR_*VARIABLE_STEP, this is index of
799 the uniform argument holding the step, otherwise 0. */
800 HOST_WIDE_INT linear_step
;
802 /* Variable alignment if available, otherwise 0. */
803 unsigned int alignment
;
806 /* Specific data for a SIMD function clone. */
808 struct GTY(()) cgraph_simd_clone
{
809 /* Number of words in the SIMD lane associated with this clone. */
810 unsigned int simdlen
;
812 /* Number of annotated function arguments in `args'. This is
813 usually the number of named arguments in FNDECL. */
816 /* Max hardware vector size in bits for integral vectors. */
817 unsigned int vecsize_int
;
819 /* Max hardware vector size in bits for floating point vectors. */
820 unsigned int vecsize_float
;
822 /* Machine mode of the mask argument(s), if they are to be passed
823 as bitmasks in integer argument(s). VOIDmode if masks are passed
824 as vectors of characteristic type. */
825 machine_mode mask_mode
;
827 /* The mangling character for a given vector size. This is used
828 to determine the ISA mangling bit as specified in the Intel
830 unsigned char vecsize_mangle
;
832 /* True if this is the masked, in-branch version of the clone,
834 unsigned int inbranch
: 1;
836 /* Doubly linked list of SIMD clones. */
837 cgraph_node
*prev_clone
, *next_clone
;
839 /* Original cgraph node the SIMD clones were created for. */
842 /* Annotated function arguments for the original function. */
843 cgraph_simd_clone_arg
GTY((length ("%h.nargs"))) args
[1];
846 /* Function Multiversioning info. */
847 struct GTY((for_user
)) cgraph_function_version_info
{
848 /* The cgraph_node for which the function version info is stored. */
849 cgraph_node
*this_node
;
850 /* Chains all the semantically identical function versions. The
851 first function in this chain is the version_info node of the
853 cgraph_function_version_info
*prev
;
854 /* If this version node corresponds to a dispatcher for function
855 versions, this points to the version info node of the default
856 function, the first node in the chain. */
857 cgraph_function_version_info
*next
;
858 /* If this node corresponds to a function version, this points
859 to the dispatcher function decl, which is the function that must
860 be called to execute the right function version at run-time.
862 If this cgraph node is a dispatcher (if dispatcher_function is
863 true, in the cgraph_node struct) for function versions, this
864 points to resolver function, which holds the function body of the
865 dispatcher. The dispatcher decl is an alias to the resolver
867 tree dispatcher_resolver
;
870 #define DEFCIFCODE(code, type, string) CIF_ ## code,
871 /* Reasons for inlining failures. */
873 enum cgraph_inline_failed_t
{
874 #include "cif-code.def"
878 enum cgraph_inline_failed_type_t
880 CIF_FINAL_NORMAL
= 0,
886 struct cgraph_edge_hasher
: ggc_ptr_hash
<cgraph_edge
>
888 typedef gimple
*compare_type
;
890 static hashval_t
hash (cgraph_edge
*);
891 static hashval_t
hash (gimple
*);
892 static bool equal (cgraph_edge
*, gimple
*);
895 /* The cgraph data structure.
896 Each function decl has assigned cgraph_node listing callees and callers. */
898 struct GTY((tag ("SYMTAB_FUNCTION"))) cgraph_node
: public symtab_node
900 friend class symbol_table
;
902 /* Remove the node from cgraph and all inline clones inlined into it.
903 Skip however removal of FORBIDDEN_NODE and return true if it needs to be
904 removed. This allows to call the function from outer loop walking clone
906 bool remove_symbol_and_inline_clones (cgraph_node
*forbidden_node
= NULL
);
908 /* Record all references from cgraph_node that are taken
909 in statement STMT. */
910 void record_stmt_references (gimple
*stmt
);
912 /* Like cgraph_set_call_stmt but walk the clone tree and update all
913 clones sharing the same function body.
914 When WHOLE_SPECULATIVE_EDGES is true, all three components of
915 speculative edge gets updated. Otherwise we update only direct
917 void set_call_stmt_including_clones (gimple
*old_stmt
, gcall
*new_stmt
,
918 bool update_speculative
= true);
920 /* Walk the alias chain to return the function cgraph_node is alias of.
921 Walk through thunk, too.
922 When AVAILABILITY is non-NULL, get minimal availability in the chain.
923 When REF is non-NULL, assume that reference happens in symbol REF
924 when determining the availability. */
925 cgraph_node
*function_symbol (enum availability
*avail
= NULL
,
926 struct symtab_node
*ref
= NULL
);
928 /* Walk the alias chain to return the function cgraph_node is alias of.
929 Walk through non virtual thunks, too. Thus we return either a function
930 or a virtual thunk node.
931 When AVAILABILITY is non-NULL, get minimal availability in the chain.
932 When REF is non-NULL, assume that reference happens in symbol REF
933 when determining the availability. */
934 cgraph_node
*function_or_virtual_thunk_symbol
935 (enum availability
*avail
= NULL
,
936 struct symtab_node
*ref
= NULL
);
938 /* Create node representing clone of N executed COUNT times. Decrease
939 the execution counts from original node too.
940 The new clone will have decl set to DECL that may or may not be the same
943 When UPDATE_ORIGINAL is true, the counts are subtracted from the original
944 function's profile to reflect the fact that part of execution is handled
946 When CALL_DUPLICATION_HOOK is true, the ipa passes are acknowledged about
947 the new clone. Otherwise the caller is responsible for doing so later.
949 If the new node is being inlined into another one, NEW_INLINED_TO should be
950 the outline function the new one is (even indirectly) inlined to.
951 All hooks will see this in node's inlined_to, when invoked.
952 Can be NULL if the node is not inlined. SUFFIX is string that is appended
953 to the original name. */
954 cgraph_node
*create_clone (tree decl
, profile_count count
,
955 bool update_original
,
956 vec
<cgraph_edge
*> redirect_callers
,
957 bool call_duplication_hook
,
958 cgraph_node
*new_inlined_to
,
959 ipa_param_adjustments
*param_adjustments
,
960 const char *suffix
= NULL
);
962 /* Create callgraph node clone with new declaration. The actual body will be
963 copied later at compilation stage. The name of the new clone will be
964 constructed from the name of the original node, SUFFIX and NUM_SUFFIX. */
965 cgraph_node
*create_virtual_clone (vec
<cgraph_edge
*> redirect_callers
,
966 vec
<ipa_replace_map
*, va_gc
> *tree_map
,
967 ipa_param_adjustments
*param_adjustments
,
968 const char * suffix
, unsigned num_suffix
);
970 /* cgraph node being removed from symbol table; see if its entry can be
971 replaced by other inline clone. */
972 cgraph_node
*find_replacement (void);
974 /* Create a new cgraph node which is the new version of
975 callgraph node. REDIRECT_CALLERS holds the callers
976 edges which should be redirected to point to
977 NEW_VERSION. ALL the callees edges of the node
978 are cloned to the new version node. Return the new
981 If non-NULL BLOCK_TO_COPY determine what basic blocks
982 was copied to prevent duplications of calls that are dead
985 SUFFIX is string that is appended to the original name. */
987 cgraph_node
*create_version_clone (tree new_decl
,
988 vec
<cgraph_edge
*> redirect_callers
,
990 const char *suffix
= NULL
);
992 /* Perform function versioning.
993 Function versioning includes copying of the tree and
994 a callgraph update (creating a new cgraph node and updating
995 its callees and callers).
997 REDIRECT_CALLERS varray includes the edges to be redirected
1000 TREE_MAP is a mapping of tree nodes we want to replace with
1001 new ones (according to results of prior analysis).
1003 If non-NULL ARGS_TO_SKIP determine function parameters to remove
1005 If SKIP_RETURN is true, the new version will return void.
1006 If non-NULL BLOCK_TO_COPY determine what basic blocks to copy.
1007 If non_NULL NEW_ENTRY determine new entry BB of the clone.
1009 If TARGET_ATTRIBUTES is non-null, when creating a new declaration,
1010 add the attributes to DECL_ATTRIBUTES. And call valid_attribute_p
1011 that will promote value of the attribute DECL_FUNCTION_SPECIFIC_TARGET
1014 Return the new version's cgraph node. */
1015 cgraph_node
*create_version_clone_with_body
1016 (vec
<cgraph_edge
*> redirect_callers
,
1017 vec
<ipa_replace_map
*, va_gc
> *tree_map
,
1018 ipa_param_adjustments
*param_adjustments
,
1019 bitmap bbs_to_copy
, basic_block new_entry_block
, const char *clone_name
,
1020 tree target_attributes
= NULL_TREE
);
1022 /* Insert a new cgraph_function_version_info node into cgraph_fnver_htab
1023 corresponding to cgraph_node. */
1024 cgraph_function_version_info
*insert_new_function_version (void);
1026 /* Get the cgraph_function_version_info node corresponding to node. */
1027 cgraph_function_version_info
*function_version (void);
1029 /* Discover all functions and variables that are trivially needed, analyze
1030 them as well as all functions and variables referred by them */
1031 void analyze (void);
1033 /* Add thunk alias into callgraph. The alias declaration is ALIAS and it
1034 aliases DECL with an adjustments made into the first parameter.
1035 See comments in struct cgraph_thunk_info for detail on the parameters. */
1036 cgraph_node
* create_thunk (tree alias
, tree
, bool this_adjusting
,
1037 HOST_WIDE_INT fixed_offset
,
1038 HOST_WIDE_INT virtual_value
,
1039 HOST_WIDE_INT indirect_offset
,
1040 tree virtual_offset
,
1044 /* Return node that alias is aliasing. */
1045 inline cgraph_node
*get_alias_target (void);
1047 /* Given function symbol, walk the alias chain to return the function node
1048 is alias of. Do not walk through thunks.
1049 When AVAILABILITY is non-NULL, get minimal availability in the chain.
1050 When REF is non-NULL, assume that reference happens in symbol REF
1051 when determining the availability. */
1053 cgraph_node
*ultimate_alias_target (availability
*availability
= NULL
,
1054 symtab_node
*ref
= NULL
);
1056 /* Expand thunk NODE to gimple if possible.
1057 When FORCE_GIMPLE_THUNK is true, gimple thunk is created and
1058 no assembler is produced.
1059 When OUTPUT_ASM_THUNK is true, also produce assembler for
1060 thunks that are not lowered. */
1061 bool expand_thunk (bool output_asm_thunks
, bool force_gimple_thunk
);
1063 /* Call expand_thunk on all callers that are thunks and analyze those
1064 nodes that were expanded. */
1065 void expand_all_artificial_thunks ();
1067 /* Assemble thunks and aliases associated to node. */
1068 void assemble_thunks_and_aliases (void);
1070 /* Expand function specified by node. */
1073 /* As an GCC extension we allow redefinition of the function. The
1074 semantics when both copies of bodies differ is not well defined.
1075 We replace the old body with new body so in unit at a time mode
1076 we always use new body, while in normal mode we may end up with
1077 old body inlined into some functions and new body expanded and
1078 inlined in others. */
1081 /* Creates a wrapper from cgraph_node to TARGET node. Thunk is used for this
1082 kind of wrapper method. */
1083 void create_wrapper (cgraph_node
*target
);
1085 /* Verify cgraph nodes of the cgraph node. */
1086 void DEBUG_FUNCTION
verify_node (void);
1088 /* Remove function from symbol table. */
1091 /* Dump call graph node to file F. */
1092 void dump (FILE *f
);
1094 /* Dump call graph node to file F. */
1095 void dump_graphviz (FILE *f
);
1097 /* Dump call graph node to stderr. */
1098 void DEBUG_FUNCTION
debug (void);
1100 /* When doing LTO, read cgraph_node's body from disk if it is not already
1102 bool get_untransformed_body (void);
1104 /* Prepare function body. When doing LTO, read cgraph_node's body from disk
1105 if it is not already present. When some IPA transformations are scheduled,
1107 bool get_body (void);
1109 /* Release memory used to represent body of function.
1110 Use this only for functions that are released before being translated to
1111 target code (i.e. RTL). Functions that are compiled to RTL and beyond
1112 are free'd in final.c via free_after_compilation(). */
1113 void release_body (bool keep_arguments
= false);
1115 /* Return the DECL_STRUCT_FUNCTION of the function. */
1116 struct function
*get_fun () const;
1118 /* cgraph_node is no longer nested function; update cgraph accordingly. */
1121 /* Bring cgraph node local. */
1122 void make_local (void);
1124 /* Likewise indicate that a node is having address taken. */
1125 void mark_address_taken (void);
1127 /* Set finalization priority to PRIORITY. */
1128 void set_fini_priority (priority_type priority
);
1130 /* Return the finalization priority. */
1131 priority_type
get_fini_priority (void);
1133 /* Create edge from a given function to CALLEE in the cgraph. */
1134 cgraph_edge
*create_edge (cgraph_node
*callee
,
1135 gcall
*call_stmt
, profile_count count
,
1136 bool cloning_p
= false);
1138 /* Create an indirect edge with a yet-undetermined callee where the call
1139 statement destination is a formal parameter of the caller with index
1141 cgraph_edge
*create_indirect_edge (gcall
*call_stmt
, int ecf_flags
,
1142 profile_count count
,
1143 bool cloning_p
= false);
1145 /* Like cgraph_create_edge walk the clone tree and update all clones sharing
1146 same function body. If clones already have edge for OLD_STMT; only
1147 update the edge same way as cgraph_set_call_stmt_including_clones does. */
1148 void create_edge_including_clones (cgraph_node
*callee
,
1149 gimple
*old_stmt
, gcall
*stmt
,
1150 profile_count count
,
1151 cgraph_inline_failed_t reason
);
1153 /* Return the callgraph edge representing the GIMPLE_CALL statement
1155 cgraph_edge
*get_edge (gimple
*call_stmt
);
1157 /* Collect all callers of cgraph_node and its aliases that are known to lead
1158 to NODE (i.e. are not overwritable) and that are not thunks. */
1159 vec
<cgraph_edge
*> collect_callers (void);
1161 /* Remove all callers from the node. */
1162 void remove_callers (void);
1164 /* Remove all callees from the node. */
1165 void remove_callees (void);
1167 /* Return function availability. See cgraph.h for description of individual
1169 enum availability
get_availability (symtab_node
*ref
= NULL
);
1171 /* Set TREE_NOTHROW on cgraph_node's decl and on aliases of the node
1172 if any to NOTHROW. */
1173 bool set_nothrow_flag (bool nothrow
);
1175 /* SET DECL_IS_MALLOC on cgraph_node's decl and on aliases of the node
1177 bool set_malloc_flag (bool malloc_p
);
1179 /* If SET_CONST is true, mark function, aliases and thunks to be ECF_CONST.
1180 If SET_CONST if false, clear the flag.
1182 When setting the flag be careful about possible interposition and
1183 do not set the flag for functions that can be interposed and set pure
1184 flag for functions that can bind to other definition.
1186 Return true if any change was done. */
1188 bool set_const_flag (bool set_const
, bool looping
);
1190 /* Set DECL_PURE_P on cgraph_node's decl and on aliases of the node
1193 When setting the flag, be careful about possible interposition.
1194 Return true if any change was done. */
1196 bool set_pure_flag (bool pure
, bool looping
);
1198 /* Call callback on function and aliases associated to the function.
1199 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1202 bool call_for_symbol_and_aliases (bool (*callback
) (cgraph_node
*,
1204 void *data
, bool include_overwritable
);
1206 /* Call callback on cgraph_node, thunks and aliases associated to NODE.
1207 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1208 skipped. When EXCLUDE_VIRTUAL_THUNKS is true, virtual thunks are
1210 bool call_for_symbol_thunks_and_aliases (bool (*callback
) (cgraph_node
*node
,
1213 bool include_overwritable
,
1214 bool exclude_virtual_thunks
= false);
1216 /* Likewise indicate that a node is needed, i.e. reachable via some
1218 inline void mark_force_output (void);
1220 /* Return true when function can be marked local. */
1221 bool local_p (void);
1223 /* Return true if cgraph_node can be made local for API change.
1224 Extern inline functions and C++ COMDAT functions can be made local
1225 at the expense of possible code size growth if function is used in multiple
1226 compilation units. */
1227 bool can_be_local_p (void);
1229 /* Return true when cgraph_node cannot return or throw and thus
1230 it is safe to ignore its side effects for IPA analysis. */
1231 bool cannot_return_p (void);
1233 /* Return true when function cgraph_node and all its aliases are only called
1235 i.e. it is not externally visible, address was not taken and
1236 it is not used in any other non-standard way. */
1237 bool only_called_directly_p (void);
1239 /* Return true when function is only called directly or it has alias.
1240 i.e. it is not externally visible, address was not taken and
1241 it is not used in any other non-standard way. */
1242 inline bool only_called_directly_or_aliased_p (void);
1244 /* Return true when function cgraph_node can be expected to be removed
1245 from program when direct calls in this compilation unit are removed.
1247 As a special case COMDAT functions are
1248 cgraph_can_remove_if_no_direct_calls_p while the are not
1249 cgraph_only_called_directly_p (it is possible they are called from other
1252 This function behaves as cgraph_only_called_directly_p because eliminating
1253 all uses of COMDAT function does not make it necessarily disappear from
1254 the program unless we are compiling whole program or we do LTO. In this
1255 case we know we win since dynamic linking will not really discard the
1258 If WILL_INLINE is true, assume that function will be inlined into all the
1260 bool will_be_removed_from_program_if_no_direct_calls_p
1261 (bool will_inline
= false);
1263 /* Return true when function can be removed from callgraph
1264 if all direct calls and references are eliminated. The function does
1265 not take into account comdat groups. */
1266 bool can_remove_if_no_direct_calls_and_refs_p (void);
1268 /* Return true when function cgraph_node and its aliases can be removed from
1269 callgraph if all direct calls are eliminated.
1270 If WILL_INLINE is true, assume that function will be inlined into all the
1272 bool can_remove_if_no_direct_calls_p (bool will_inline
= false);
1274 /* Return true when callgraph node is a function with Gimple body defined
1275 in current unit. Functions can also be define externally or they
1276 can be thunks with no Gimple representation.
1278 Note that at WPA stage, the function body may not be present in memory. */
1279 inline bool has_gimple_body_p (void);
1281 /* Return true if this node represents a former, i.e. an expanded, thunk. */
1282 inline bool former_thunk_p (void);
1284 /* Return true if function should be optimized for size. */
1285 bool optimize_for_size_p (void);
1287 /* Dump the callgraph to file F. */
1288 static void dump_cgraph (FILE *f
);
1290 /* Dump the call graph to stderr. */
1292 void debug_cgraph (void)
1294 dump_cgraph (stderr
);
1297 /* Get unique identifier of the node. */
1298 inline int get_uid ()
1303 /* Get summary id of the node. */
1304 inline int get_summary_id ()
1306 return m_summary_id
;
1309 /* Record that DECL1 and DECL2 are semantically identical function
1311 static void record_function_versions (tree decl1
, tree decl2
);
1313 /* Remove the cgraph_function_version_info and cgraph_node for DECL. This
1314 DECL is a duplicate declaration. */
1315 static void delete_function_version_by_decl (tree decl
);
1317 /* Add the function FNDECL to the call graph.
1318 Unlike finalize_function, this function is intended to be used
1319 by middle end and allows insertion of new function at arbitrary point
1320 of compilation. The function can be either in high, low or SSA form
1323 The function is assumed to be reachable and have address taken (so no
1324 API breaking optimizations are performed on it).
1326 Main work done by this function is to enqueue the function for later
1327 processing to avoid need the passes to be re-entrant. */
1328 static void add_new_function (tree fndecl
, bool lowered
);
1330 /* Return callgraph node for given symbol and check it is a function. */
1331 static inline cgraph_node
*get (const_tree decl
)
1333 gcc_checking_assert (TREE_CODE (decl
) == FUNCTION_DECL
);
1334 return dyn_cast
<cgraph_node
*> (symtab_node::get (decl
));
1337 /* DECL has been parsed. Take it, queue it, compile it at the whim of the
1338 logic in effect. If NO_COLLECT is true, then our caller cannot stand to
1339 have the garbage collector run at the moment. We would need to either
1340 create a new GC context, or just not compile right now. */
1341 static void finalize_function (tree
, bool);
1343 /* Return cgraph node assigned to DECL. Create new one when needed. */
1344 static cgraph_node
* create (tree decl
);
1346 /* Try to find a call graph node for declaration DECL and if it does not
1347 exist or if it corresponds to an inline clone, create a new one. */
1348 static cgraph_node
* get_create (tree
);
1350 /* Return local info for the compiled function. */
1351 static cgraph_node
*local_info_node (tree decl
);
1353 /* Return RTL info for the compiled function. */
1354 static struct cgraph_rtl_info
*rtl_info (const_tree
);
1356 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
1357 Return NULL if there's no such node. */
1358 static cgraph_node
*get_for_asmname (tree asmname
);
1360 /* Attempt to mark ALIAS as an alias to DECL. Return alias node if
1361 successful and NULL otherwise.
1362 Same body aliases are output whenever the body of DECL is output,
1363 and cgraph_node::get (ALIAS) transparently
1364 returns cgraph_node::get (DECL). */
1365 static cgraph_node
* create_same_body_alias (tree alias
, tree decl
);
1367 /* Verify whole cgraph structure. */
1368 static void DEBUG_FUNCTION
verify_cgraph_nodes (void);
1370 /* Verify cgraph, if consistency checking is enabled. */
1371 static inline void checking_verify_cgraph_nodes (void);
1373 /* Worker to bring NODE local. */
1374 static bool make_local (cgraph_node
*node
, void *);
1376 /* Mark ALIAS as an alias to DECL. DECL_NODE is cgraph node representing
1377 the function body is associated
1378 with (not necessarily cgraph_node (DECL). */
1379 static cgraph_node
*create_alias (tree alias
, tree target
);
1381 /* Return true if NODE has thunk. */
1382 static bool has_thunk_p (cgraph_node
*node
, void *);
1384 cgraph_edge
*callees
;
1385 cgraph_edge
*callers
;
1386 /* List of edges representing indirect calls with a yet undetermined
1388 cgraph_edge
*indirect_calls
;
1389 /* For nested functions points to function the node is nested in. */
1390 cgraph_node
*origin
;
1391 /* Points to first nested function, if any. */
1392 cgraph_node
*nested
;
1393 /* Pointer to the next function with same origin, if any. */
1394 cgraph_node
*next_nested
;
1395 /* Pointer to the next clone. */
1396 cgraph_node
*next_sibling_clone
;
1397 cgraph_node
*prev_sibling_clone
;
1398 cgraph_node
*clones
;
1399 cgraph_node
*clone_of
;
1400 /* For functions with many calls sites it holds map from call expression
1401 to the edge to speed up cgraph_edge function. */
1402 hash_table
<cgraph_edge_hasher
> *GTY(()) call_site_hash
;
1403 /* Declaration node used to be clone of. */
1404 tree former_clone_of
;
1406 /* If this is a SIMD clone, this points to the SIMD specific
1407 information for it. */
1408 cgraph_simd_clone
*simdclone
;
1409 /* If this function has SIMD clones, this points to the first clone. */
1410 cgraph_node
*simd_clones
;
1412 /* Interprocedural passes scheduled to have their transform functions
1413 applied next time we execute local pass on them. We maintain it
1414 per-function in order to allow IPA passes to introduce new functions. */
1415 vec
<ipa_opt_pass
> GTY((skip
)) ipa_transforms_to_apply
;
1417 /* For inline clones this points to the function they will be
1419 cgraph_node
*inlined_to
;
1421 struct cgraph_rtl_info
*rtl
;
1422 cgraph_clone_info clone
;
1423 cgraph_thunk_info thunk
;
1425 /* Expected number of executions: calculated in profile.c. */
1426 profile_count count
;
1427 /* How to scale counts at materialization time; used to merge
1428 LTO units with different number of profile runs. */
1429 int count_materialization_scale
;
1430 /* ID assigned by the profiling. */
1431 unsigned int profile_id
;
1432 /* Time profiler: first run of function. */
1435 /* Set when decl is an abstract function pointed to by the
1436 ABSTRACT_DECL_ORIGIN of a reachable function. */
1437 unsigned used_as_abstract_origin
: 1;
1438 /* Set once the function is lowered (i.e. its CFG is built). */
1439 unsigned lowered
: 1;
1440 /* Set once the function has been instantiated and its callee
1442 unsigned process
: 1;
1443 /* How commonly executed the node is. Initialized during branch
1444 probabilities pass. */
1445 ENUM_BITFIELD (node_frequency
) frequency
: 2;
1446 /* True when function can only be called at startup (from static ctor). */
1447 unsigned only_called_at_startup
: 1;
1448 /* True when function can only be called at startup (from static dtor). */
1449 unsigned only_called_at_exit
: 1;
1450 /* True when function is the transactional clone of a function which
1451 is called only from inside transactions. */
1452 /* ?? We should be able to remove this. We have enough bits in
1453 cgraph to calculate it. */
1454 unsigned tm_clone
: 1;
1455 /* True if this decl is a dispatcher for function versions. */
1456 unsigned dispatcher_function
: 1;
1457 /* True if this decl calls a COMDAT-local function. This is set up in
1458 compute_fn_summary and inline_call. */
1459 unsigned calls_comdat_local
: 1;
1460 /* True if node has been created by merge operation in IPA-ICF. */
1461 unsigned icf_merged
: 1;
1462 /* True if call to node can't result in a call to free, munmap or
1463 other operation that could make previously non-trapping memory
1464 accesses trapping. */
1465 unsigned nonfreeing_fn
: 1;
1466 /* True if there was multiple COMDAT bodies merged by lto-symtab. */
1467 unsigned merged_comdat
: 1;
1468 /* True if function was created to be executed in parallel. */
1469 unsigned parallelized_function
: 1;
1470 /* True if function is part split out by ipa-split. */
1471 unsigned split_part
: 1;
1472 /* True if the function appears as possible target of indirect call. */
1473 unsigned indirect_call_target
: 1;
1474 /* Set when function is visible in current compilation unit only and
1475 its address is never taken. */
1477 /* False when there is something makes versioning impossible. */
1478 unsigned versionable
: 1;
1479 /* False when function calling convention and signature cannot be changed.
1480 This is the case when __builtin_apply_args is used. */
1481 unsigned can_change_signature
: 1;
1482 /* True when the function has been originally extern inline, but it is
1484 unsigned redefined_extern_inline
: 1;
1485 /* True if the function may enter serial irrevocable mode. */
1486 unsigned tm_may_enter_irr
: 1;
1487 /* True if this was a clone created by ipa-cp. */
1488 unsigned ipcp_clone
: 1;
1491 /* Unique id of the node. */
1494 /* Summary id that is recycled. */
1497 /* Worker for call_for_symbol_and_aliases. */
1498 bool call_for_symbol_and_aliases_1 (bool (*callback
) (cgraph_node
*,
1500 void *data
, bool include_overwritable
);
1503 /* A cgraph node set is a collection of cgraph nodes. A cgraph node
1504 can appear in multiple sets. */
1505 struct cgraph_node_set_def
1507 hash_map
<cgraph_node
*, size_t> *map
;
1508 vec
<cgraph_node
*> nodes
;
1511 typedef cgraph_node_set_def
*cgraph_node_set
;
1512 typedef struct varpool_node_set_def
*varpool_node_set
;
1514 struct varpool_node
;
1516 /* A varpool node set is a collection of varpool nodes. A varpool node
1517 can appear in multiple sets. */
1518 struct varpool_node_set_def
1520 hash_map
<varpool_node
*, size_t> * map
;
1521 vec
<varpool_node
*> nodes
;
1524 /* Iterator structure for cgraph node sets. */
1525 struct cgraph_node_set_iterator
1527 cgraph_node_set set
;
1531 /* Iterator structure for varpool node sets. */
1532 struct varpool_node_set_iterator
1534 varpool_node_set set
;
1538 /* Context of polymorphic call. It represent information about the type of
1539 instance that may reach the call. This is used by ipa-devirt walkers of the
1540 type inheritance graph. */
1542 class GTY(()) ipa_polymorphic_call_context
{
1544 /* The called object appears in an object of type OUTER_TYPE
1545 at offset OFFSET. When information is not 100% reliable, we
1546 use SPECULATIVE_OUTER_TYPE and SPECULATIVE_OFFSET. */
1547 HOST_WIDE_INT offset
;
1548 HOST_WIDE_INT speculative_offset
;
1550 tree speculative_outer_type
;
1551 /* True if outer object may be in construction or destruction. */
1552 unsigned maybe_in_construction
: 1;
1553 /* True if outer object may be of derived type. */
1554 unsigned maybe_derived_type
: 1;
1555 /* True if speculative outer object may be of derived type. We always
1556 speculate that construction does not happen. */
1557 unsigned speculative_maybe_derived_type
: 1;
1558 /* True if the context is invalid and all calls should be redirected
1559 to BUILTIN_UNREACHABLE. */
1560 unsigned invalid
: 1;
1561 /* True if the outer type is dynamic. */
1562 unsigned dynamic
: 1;
1564 /* Build empty "I know nothing" context. */
1565 ipa_polymorphic_call_context ();
1566 /* Build polymorphic call context for indirect call E. */
1567 ipa_polymorphic_call_context (cgraph_edge
*e
);
1568 /* Build polymorphic call context for IP invariant CST.
1569 If specified, OTR_TYPE specify the type of polymorphic call
1570 that takes CST+OFFSET as a parameter. */
1571 ipa_polymorphic_call_context (tree cst
, tree otr_type
= NULL
,
1572 HOST_WIDE_INT offset
= 0);
1573 /* Build context for pointer REF contained in FNDECL at statement STMT.
1574 if INSTANCE is non-NULL, return pointer to the object described by
1576 ipa_polymorphic_call_context (tree fndecl
, tree ref
, gimple
*stmt
,
1577 tree
*instance
= NULL
);
1579 /* Look for vtable stores or constructor calls to work out dynamic type
1580 of memory location. */
1581 bool get_dynamic_type (tree
, tree
, tree
, gimple
*, unsigned *);
1583 /* Make context non-speculative. */
1584 void clear_speculation ();
1586 /* Produce context specifying all derived types of OTR_TYPE. If OTR_TYPE is
1587 NULL, the context is set to dummy "I know nothing" setting. */
1588 void clear_outer_type (tree otr_type
= NULL
);
1590 /* Walk container types and modify context to point to actual class
1591 containing OTR_TYPE (if non-NULL) as base class.
1592 Return true if resulting context is valid.
1594 When CONSIDER_PLACEMENT_NEW is false, reject contexts that may be made
1595 valid only via allocation of new polymorphic type inside by means
1598 When CONSIDER_BASES is false, only look for actual fields, not base types
1600 bool restrict_to_inner_class (tree otr_type
,
1601 bool consider_placement_new
= true,
1602 bool consider_bases
= true);
1604 /* Adjust all offsets in contexts by given number of bits. */
1605 void offset_by (HOST_WIDE_INT
);
1606 /* Use when we cannot track dynamic type change. This speculatively assume
1607 type change is not happening. */
1608 void possible_dynamic_type_change (bool, tree otr_type
= NULL
);
1609 /* Assume that both THIS and a given context is valid and strengthen THIS
1610 if possible. Return true if any strengthening was made.
1611 If actual type the context is being used in is known, OTR_TYPE should be
1612 set accordingly. This improves quality of combined result. */
1613 bool combine_with (ipa_polymorphic_call_context
, tree otr_type
= NULL
);
1614 bool meet_with (ipa_polymorphic_call_context
, tree otr_type
= NULL
);
1616 /* Return TRUE if context is fully useless. */
1617 bool useless_p () const;
1618 /* Return TRUE if this context conveys the same information as X. */
1619 bool equal_to (const ipa_polymorphic_call_context
&x
) const;
1621 /* Dump human readable context to F. If NEWLINE is true, it will be
1622 terminated by a newline. */
1623 void dump (FILE *f
, bool newline
= true) const;
1624 void DEBUG_FUNCTION
debug () const;
1626 /* LTO streaming. */
1627 void stream_out (struct output_block
*) const;
1628 void stream_in (class lto_input_block
*, class data_in
*data_in
);
1631 bool combine_speculation_with (tree
, HOST_WIDE_INT
, bool, tree
);
1632 bool meet_speculation_with (tree
, HOST_WIDE_INT
, bool, tree
);
1633 void set_by_decl (tree
, HOST_WIDE_INT
);
1634 bool set_by_invariant (tree
, tree
, HOST_WIDE_INT
);
1635 bool speculation_consistent_p (tree
, HOST_WIDE_INT
, bool, tree
) const;
1636 void make_speculative (tree otr_type
= NULL
);
1639 /* Structure containing additional information about an indirect call. */
1641 class GTY(()) cgraph_indirect_call_info
1644 /* When agg_content is set, an offset where the call pointer is located
1645 within the aggregate. */
1646 HOST_WIDE_INT offset
;
1647 /* Context of the polymorphic call; use only when POLYMORPHIC flag is set. */
1648 ipa_polymorphic_call_context context
;
1649 /* OBJ_TYPE_REF_TOKEN of a polymorphic call (if polymorphic is set). */
1650 HOST_WIDE_INT otr_token
;
1651 /* Type of the object from OBJ_TYPE_REF_OBJECT. */
1653 /* Index of the parameter that is called. */
1655 /* ECF flags determined from the caller. */
1657 /* Profile_id of common target obtained from profile. */
1658 int common_target_id
;
1659 /* Probability that call will land in function with COMMON_TARGET_ID. */
1660 int common_target_probability
;
1662 /* Set when the call is a virtual call with the parameter being the
1663 associated object pointer rather than a simple direct call. */
1664 unsigned polymorphic
: 1;
1665 /* Set when the call is a call of a pointer loaded from contents of an
1666 aggregate at offset. */
1667 unsigned agg_contents
: 1;
1668 /* Set when this is a call through a member pointer. */
1669 unsigned member_ptr
: 1;
1670 /* When the agg_contents bit is set, this one determines whether the
1671 destination is loaded from a parameter passed by reference. */
1672 unsigned by_ref
: 1;
1673 /* When the agg_contents bit is set, this one determines whether we can
1674 deduce from the function body that the loaded value from the reference is
1675 never modified between the invocation of the function and the load
1677 unsigned guaranteed_unmodified
: 1;
1678 /* For polymorphic calls this specify whether the virtual table pointer
1679 may have changed in between function entry and the call. */
1680 unsigned vptr_changed
: 1;
1683 class GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller"),
1684 for_user
)) cgraph_edge
1687 friend struct cgraph_node
;
1688 friend class symbol_table
;
1690 /* Remove the edge in the cgraph. */
1693 /* Change field call_stmt of edge to NEW_STMT.
1694 If UPDATE_SPECULATIVE and E is any component of speculative
1695 edge, then update all components. */
1696 void set_call_stmt (gcall
*new_stmt
, bool update_speculative
= true);
1698 /* Redirect callee of the edge to N. The function does not update underlying
1700 void redirect_callee (cgraph_node
*n
);
1702 /* If the edge does not lead to a thunk, simply redirect it to N. Otherwise
1703 create one or more equivalent thunks for N and redirect E to the first in
1704 the chain. Note that it is then necessary to call
1705 n->expand_all_artificial_thunks once all callers are redirected. */
1706 void redirect_callee_duplicating_thunks (cgraph_node
*n
);
1708 /* Make an indirect edge with an unknown callee an ordinary edge leading to
1709 CALLEE. DELTA is an integer constant that is to be added to the this
1710 pointer (first parameter) to compensate for skipping
1711 a thunk adjustment. */
1712 cgraph_edge
*make_direct (cgraph_node
*callee
);
1714 /* Turn edge into speculative call calling N2. Update
1715 the profile so the direct call is taken COUNT times
1717 cgraph_edge
*make_speculative (cgraph_node
*n2
, profile_count direct_count
);
1719 /* Given speculative call edge, return all three components. */
1720 void speculative_call_info (cgraph_edge
*&direct
, cgraph_edge
*&indirect
,
1721 ipa_ref
*&reference
);
1723 /* Speculative call edge turned out to be direct call to CALLEE_DECL.
1724 Remove the speculative call sequence and return edge representing the call.
1725 It is up to caller to redirect the call as appropriate. */
1726 cgraph_edge
*resolve_speculation (tree callee_decl
= NULL
);
1728 /* If necessary, change the function declaration in the call statement
1729 associated with the edge so that it corresponds to the edge callee. */
1730 gimple
*redirect_call_stmt_to_callee (void);
1732 /* Create clone of edge in the node N represented
1733 by CALL_EXPR the callgraph. */
1734 cgraph_edge
* clone (cgraph_node
*n
, gcall
*call_stmt
, unsigned stmt_uid
,
1735 profile_count num
, profile_count den
,
1736 bool update_original
);
1738 /* Verify edge count and frequency. */
1739 bool verify_count ();
1741 /* Return true when call of edge cannot lead to return from caller
1742 and thus it is safe to ignore its side effects for IPA analysis
1743 when computing side effects of the caller. */
1744 bool cannot_lead_to_return_p (void);
1746 /* Return true when the edge represents a direct recursion. */
1747 bool recursive_p (void);
1749 /* Return true if the edge may be considered hot. */
1750 bool maybe_hot_p (void);
1752 /* Get unique identifier of the edge. */
1753 inline int get_uid ()
1758 /* Get summary id of the edge. */
1759 inline int get_summary_id ()
1761 return m_summary_id
;
1764 /* Rebuild cgraph edges for current function node. This needs to be run after
1765 passes that don't update the cgraph. */
1766 static unsigned int rebuild_edges (void);
1768 /* Rebuild cgraph references for current function node. This needs to be run
1769 after passes that don't update the cgraph. */
1770 static void rebuild_references (void);
1772 /* During LTO stream in this can be used to check whether call can possibly
1773 be internal to the current translation unit. */
1774 bool possibly_call_in_translation_unit_p (void);
1776 /* Expected number of executions: calculated in profile.c. */
1777 profile_count count
;
1778 cgraph_node
*caller
;
1779 cgraph_node
*callee
;
1780 cgraph_edge
*prev_caller
;
1781 cgraph_edge
*next_caller
;
1782 cgraph_edge
*prev_callee
;
1783 cgraph_edge
*next_callee
;
1785 /* Additional information about an indirect call. Not cleared when an edge
1787 cgraph_indirect_call_info
*indirect_info
;
1788 PTR
GTY ((skip (""))) aux
;
1789 /* When equal to CIF_OK, inline this call. Otherwise, points to the
1790 explanation why function was not inlined. */
1791 enum cgraph_inline_failed_t inline_failed
;
1792 /* The stmt_uid of call_stmt. This is used by LTO to recover the call_stmt
1793 when the function is serialized in. */
1794 unsigned int lto_stmt_uid
;
1795 /* Whether this edge was made direct by indirect inlining. */
1796 unsigned int indirect_inlining_edge
: 1;
1797 /* Whether this edge describes an indirect call with an undetermined
1799 unsigned int indirect_unknown_callee
: 1;
1800 /* Whether this edge is still a dangling */
1801 /* True if the corresponding CALL stmt cannot be inlined. */
1802 unsigned int call_stmt_cannot_inline_p
: 1;
1803 /* Can this call throw externally? */
1804 unsigned int can_throw_external
: 1;
1805 /* Edges with SPECULATIVE flag represents indirect calls that was
1806 speculatively turned into direct (i.e. by profile feedback).
1807 The final code sequence will have form:
1809 if (call_target == expected_fn)
1814 Every speculative call is represented by three components attached
1815 to a same call statement:
1816 1) a direct call (to expected_fn)
1817 2) an indirect call (to call_target)
1818 3) a IPA_REF_ADDR reference to expected_fn.
1820 Optimizers may later redirect direct call to clone, so 1) and 3)
1821 do not need to necessarily agree with destination. */
1822 unsigned int speculative
: 1;
1823 /* Set to true when caller is a constructor or destructor of polymorphic
1825 unsigned in_polymorphic_cdtor
: 1;
1827 /* Return true if call must bind to current definition. */
1828 bool binds_to_current_def_p ();
1830 /* Expected frequency of executions within the function.
1831 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
1832 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
1835 /* Expected frequency of executions within the function. */
1836 sreal
sreal_frequency ();
1838 /* Unique id of the edge. */
1841 /* Summary id that is recycled. */
1844 /* Remove the edge from the list of the callers of the callee. */
1845 void remove_caller (void);
1847 /* Remove the edge from the list of the callees of the caller. */
1848 void remove_callee (void);
1850 /* Set callee N of call graph edge and add it to the corresponding set of
1852 void set_callee (cgraph_node
*n
);
1854 /* Output flags of edge to a file F. */
1855 void dump_edge_flags (FILE *f
);
1857 /* Verify that call graph edge corresponds to DECL from the associated
1858 statement. Return true if the verification should fail. */
1859 bool verify_corresponds_to_fndecl (tree decl
);
1862 #define CGRAPH_FREQ_BASE 1000
1863 #define CGRAPH_FREQ_MAX 100000
1865 /* The varpool data structure.
1866 Each static variable decl has assigned varpool_node. */
1868 struct GTY((tag ("SYMTAB_VARIABLE"))) varpool_node
: public symtab_node
1870 /* Dump given varpool node to F. */
1871 void dump (FILE *f
);
1873 /* Dump given varpool node to stderr. */
1874 void DEBUG_FUNCTION
debug (void);
1876 /* Remove variable from symbol table. */
1879 /* Remove node initializer when it is no longer needed. */
1880 void remove_initializer (void);
1882 void analyze (void);
1884 /* Return variable availability. */
1885 availability
get_availability (symtab_node
*ref
= NULL
);
1887 /* When doing LTO, read variable's constructor from disk if
1888 it is not already present. */
1889 tree
get_constructor (void);
1891 /* Return true if variable has constructor that can be used for folding. */
1892 bool ctor_useable_for_folding_p (void);
1894 /* For given variable pool node, walk the alias chain to return the function
1895 the variable is alias of. Do not walk through thunks.
1896 When AVAILABILITY is non-NULL, get minimal availability in the chain.
1897 When REF is non-NULL, assume that reference happens in symbol REF
1898 when determining the availability. */
1899 inline varpool_node
*ultimate_alias_target
1900 (availability
*availability
= NULL
, symtab_node
*ref
= NULL
);
1902 /* Return node that alias is aliasing. */
1903 inline varpool_node
*get_alias_target (void);
1905 /* Output one variable, if necessary. Return whether we output it. */
1906 bool assemble_decl (void);
1908 /* For variables in named sections make sure get_variable_section
1909 is called before we switch to those sections. Then section
1910 conflicts between read-only and read-only requiring relocations
1911 sections can be resolved. */
1912 void finalize_named_section_flags (void);
1914 /* Call callback on varpool symbol and aliases associated to varpool symbol.
1915 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1917 bool call_for_symbol_and_aliases (bool (*callback
) (varpool_node
*, void *),
1919 bool include_overwritable
);
1921 /* Return true when variable should be considered externally visible. */
1922 bool externally_visible_p (void);
1924 /* Return true when all references to variable must be visible
1926 i.e. if the variable is not externally visible or not used in some magic
1927 way (asm statement or such).
1928 The magic uses are all summarized in force_output flag. */
1929 inline bool all_refs_explicit_p ();
1931 /* Return true when variable can be removed from variable pool
1932 if all direct calls are eliminated. */
1933 inline bool can_remove_if_no_refs_p (void);
1935 /* Add the variable DECL to the varpool.
1936 Unlike finalize_decl function is intended to be used
1937 by middle end and allows insertion of new variable at arbitrary point
1939 static void add (tree decl
);
1941 /* Return varpool node for given symbol and check it is a function. */
1942 static inline varpool_node
*get (const_tree decl
);
1944 /* Mark DECL as finalized. By finalizing the declaration, frontend instruct
1945 the middle end to output the variable to asm file, if needed or externally
1947 static void finalize_decl (tree decl
);
1949 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1950 Extra name aliases are output whenever DECL is output. */
1951 static varpool_node
* create_extra_name_alias (tree alias
, tree decl
);
1953 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1954 Extra name aliases are output whenever DECL is output. */
1955 static varpool_node
* create_alias (tree
, tree
);
1957 /* Dump the variable pool to F. */
1958 static void dump_varpool (FILE *f
);
1960 /* Dump the variable pool to stderr. */
1961 static void DEBUG_FUNCTION
debug_varpool (void);
1963 /* Allocate new callgraph node and insert it into basic data structures. */
1964 static varpool_node
*create_empty (void);
1966 /* Return varpool node assigned to DECL. Create new one when needed. */
1967 static varpool_node
*get_create (tree decl
);
1969 /* Given an assembler name, lookup node. */
1970 static varpool_node
*get_for_asmname (tree asmname
);
1972 /* Set when variable is scheduled to be assembled. */
1973 unsigned output
: 1;
1975 /* Set if the variable is dynamically initialized, except for
1976 function local statics. */
1977 unsigned dynamically_initialized
: 1;
1979 ENUM_BITFIELD(tls_model
) tls_model
: 3;
1981 /* Set if the variable is known to be used by single function only.
1982 This is computed by ipa_single_use pass and used by late optimizations
1983 in places where optimization would be valid for local static variable
1984 if we did not do any inter-procedural code movement. */
1985 unsigned used_by_single_function
: 1;
1988 /* Assemble thunks and aliases associated to varpool node. */
1989 void assemble_aliases (void);
1991 /* Worker for call_for_node_and_aliases. */
1992 bool call_for_symbol_and_aliases_1 (bool (*callback
) (varpool_node
*, void *),
1994 bool include_overwritable
);
1997 /* Every top level asm statement is put into a asm_node. */
1999 struct GTY(()) asm_node
{
2002 /* Next asm node. */
2004 /* String for this asm node. */
2006 /* Ordering of all cgraph nodes. */
2010 /* Report whether or not THIS symtab node is a function, aka cgraph_node. */
2015 is_a_helper
<cgraph_node
*>::test (symtab_node
*p
)
2017 return p
&& p
->type
== SYMTAB_FUNCTION
;
2020 /* Report whether or not THIS symtab node is a variable, aka varpool_node. */
2025 is_a_helper
<varpool_node
*>::test (symtab_node
*p
)
2027 return p
&& p
->type
== SYMTAB_VARIABLE
;
2030 typedef void (*cgraph_edge_hook
)(cgraph_edge
*, void *);
2031 typedef void (*cgraph_node_hook
)(cgraph_node
*, void *);
2032 typedef void (*varpool_node_hook
)(varpool_node
*, void *);
2033 typedef void (*cgraph_2edge_hook
)(cgraph_edge
*, cgraph_edge
*, void *);
2034 typedef void (*cgraph_2node_hook
)(cgraph_node
*, cgraph_node
*, void *);
2036 struct cgraph_edge_hook_list
;
2037 struct cgraph_node_hook_list
;
2038 struct varpool_node_hook_list
;
2039 struct cgraph_2edge_hook_list
;
2040 struct cgraph_2node_hook_list
;
2042 /* Map from a symbol to initialization/finalization priorities. */
2043 struct GTY(()) symbol_priority_map
{
2050 /* Frontend is parsing and finalizing functions. */
2052 /* Callgraph is being constructed. It is safe to add new functions. */
2054 /* Callgraph is being streamed-in at LTO time. */
2056 /* Callgraph is built and early IPA passes are being run. */
2058 /* Callgraph is built and all functions are transformed to SSA form. */
2060 /* All inline decisions are done; it is now possible to remove extern inline
2061 functions and virtual call targets. */
2062 IPA_SSA_AFTER_INLINING
,
2063 /* Functions are now ordered and being passed to RTL expanders. */
2065 /* All cgraph expansion is done. */
2069 struct asmname_hasher
: ggc_ptr_hash
<symtab_node
>
2071 typedef const_tree compare_type
;
2073 static hashval_t
hash (symtab_node
*n
);
2074 static bool equal (symtab_node
*n
, const_tree t
);
2077 class GTY((tag ("SYMTAB"))) symbol_table
2080 friend struct symtab_node
;
2081 friend struct cgraph_node
;
2082 friend struct cgraph_edge
;
2085 cgraph_count (0), cgraph_max_uid (1), cgraph_max_summary_id (0),
2086 edges_count (0), edges_max_uid (1), edges_max_summary_id (0),
2087 cgraph_released_summary_ids (), edge_released_summary_ids (),
2088 nodes (NULL
), asmnodes (NULL
), asm_last_node (NULL
),
2089 order (0), global_info_ready (false), state (PARSING
),
2090 function_flags_ready (false), cpp_implicit_aliases_done (false),
2091 section_hash (NULL
), assembler_name_hash (NULL
), init_priority_hash (NULL
),
2092 dump_file (NULL
), ipa_clones_dump_file (NULL
), cloned_nodes (),
2093 m_first_edge_removal_hook (NULL
), m_first_cgraph_removal_hook (NULL
),
2094 m_first_edge_duplicated_hook (NULL
), m_first_cgraph_duplicated_hook (NULL
),
2095 m_first_cgraph_insertion_hook (NULL
), m_first_varpool_insertion_hook (NULL
),
2096 m_first_varpool_removal_hook (NULL
)
2100 /* Initialize callgraph dump file. */
2101 void initialize (void);
2103 /* Register a top-level asm statement ASM_STR. */
2104 inline asm_node
*finalize_toplevel_asm (tree asm_str
);
2106 /* Analyze the whole compilation unit once it is parsed completely. */
2107 void finalize_compilation_unit (void);
2109 /* C++ frontend produce same body aliases all over the place, even before PCH
2110 gets streamed out. It relies on us linking the aliases with their function
2111 in order to do the fixups, but ipa-ref is not PCH safe. Consequently we
2112 first produce aliases without links, but once C++ FE is sure it won't
2113 stream PCH we build the links via this function. */
2114 void process_same_body_aliases (void);
2116 /* Perform simple optimizations based on callgraph. */
2117 void compile (void);
2119 /* Process CGRAPH_NEW_FUNCTIONS and perform actions necessary to add these
2120 functions into callgraph in a way so they look like ordinary reachable
2121 functions inserted into callgraph already at construction time. */
2122 void process_new_functions (void);
2124 /* Once all functions from compilation unit are in memory, produce all clones
2125 and update all calls. We might also do this on demand if we don't want to
2126 bring all functions to memory prior compilation, but current WHOPR
2127 implementation does that and it is bit easier to keep everything right
2129 void materialize_all_clones (void);
2131 /* Register a symbol NODE. */
2132 inline void register_symbol (symtab_node
*node
);
2135 clear_asm_symbols (void)
2138 asm_last_node
= NULL
;
2141 /* Perform reachability analysis and reclaim all unreachable nodes. */
2142 bool remove_unreachable_nodes (FILE *file
);
2144 /* Optimization of function bodies might've rendered some variables as
2145 unnecessary so we want to avoid these from being compiled. Re-do
2146 reachability starting from variables that are either externally visible
2147 or was referred from the asm output routines. */
2148 void remove_unreferenced_decls (void);
2150 /* Unregister a symbol NODE. */
2151 inline void unregister (symtab_node
*node
);
2153 /* Allocate new callgraph node and insert it into basic data structures. */
2154 cgraph_node
*create_empty (void);
2156 /* Release a callgraph NODE. */
2157 void release_symbol (cgraph_node
*node
);
2159 /* Output all variables enqueued to be assembled. */
2160 bool output_variables (void);
2162 /* Weakrefs may be associated to external decls and thus not output
2163 at expansion time. Emit all necessary aliases. */
2164 void output_weakrefs (void);
2166 /* Return first static symbol with definition. */
2167 inline symtab_node
*first_symbol (void);
2169 /* Return first assembler symbol. */
2171 first_asm_symbol (void)
2176 /* Return first static symbol with definition. */
2177 inline symtab_node
*first_defined_symbol (void);
2179 /* Return first variable. */
2180 inline varpool_node
*first_variable (void);
2182 /* Return next variable after NODE. */
2183 inline varpool_node
*next_variable (varpool_node
*node
);
2185 /* Return first static variable with initializer. */
2186 inline varpool_node
*first_static_initializer (void);
2188 /* Return next static variable with initializer after NODE. */
2189 inline varpool_node
*next_static_initializer (varpool_node
*node
);
2191 /* Return first static variable with definition. */
2192 inline varpool_node
*first_defined_variable (void);
2194 /* Return next static variable with definition after NODE. */
2195 inline varpool_node
*next_defined_variable (varpool_node
*node
);
2197 /* Return first function with body defined. */
2198 inline cgraph_node
*first_defined_function (void);
2200 /* Return next function with body defined after NODE. */
2201 inline cgraph_node
*next_defined_function (cgraph_node
*node
);
2203 /* Return first function. */
2204 inline cgraph_node
*first_function (void);
2206 /* Return next function. */
2207 inline cgraph_node
*next_function (cgraph_node
*node
);
2209 /* Return first function with body defined. */
2210 cgraph_node
*first_function_with_gimple_body (void);
2212 /* Return next reachable static variable with initializer after NODE. */
2213 inline cgraph_node
*next_function_with_gimple_body (cgraph_node
*node
);
2215 /* Register HOOK to be called with DATA on each removed edge. */
2216 cgraph_edge_hook_list
*add_edge_removal_hook (cgraph_edge_hook hook
,
2219 /* Remove ENTRY from the list of hooks called on removing edges. */
2220 void remove_edge_removal_hook (cgraph_edge_hook_list
*entry
);
2222 /* Register HOOK to be called with DATA on each removed node. */
2223 cgraph_node_hook_list
*add_cgraph_removal_hook (cgraph_node_hook hook
,
2226 /* Remove ENTRY from the list of hooks called on removing nodes. */
2227 void remove_cgraph_removal_hook (cgraph_node_hook_list
*entry
);
2229 /* Register HOOK to be called with DATA on each removed node. */
2230 varpool_node_hook_list
*add_varpool_removal_hook (varpool_node_hook hook
,
2233 /* Remove ENTRY from the list of hooks called on removing nodes. */
2234 void remove_varpool_removal_hook (varpool_node_hook_list
*entry
);
2236 /* Register HOOK to be called with DATA on each inserted node. */
2237 cgraph_node_hook_list
*add_cgraph_insertion_hook (cgraph_node_hook hook
,
2240 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2241 void remove_cgraph_insertion_hook (cgraph_node_hook_list
*entry
);
2243 /* Register HOOK to be called with DATA on each inserted node. */
2244 varpool_node_hook_list
*add_varpool_insertion_hook (varpool_node_hook hook
,
2247 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2248 void remove_varpool_insertion_hook (varpool_node_hook_list
*entry
);
2250 /* Register HOOK to be called with DATA on each duplicated edge. */
2251 cgraph_2edge_hook_list
*add_edge_duplication_hook (cgraph_2edge_hook hook
,
2253 /* Remove ENTRY from the list of hooks called on duplicating edges. */
2254 void remove_edge_duplication_hook (cgraph_2edge_hook_list
*entry
);
2256 /* Register HOOK to be called with DATA on each duplicated node. */
2257 cgraph_2node_hook_list
*add_cgraph_duplication_hook (cgraph_2node_hook hook
,
2260 /* Remove ENTRY from the list of hooks called on duplicating nodes. */
2261 void remove_cgraph_duplication_hook (cgraph_2node_hook_list
*entry
);
2263 /* Call all edge removal hooks. */
2264 void call_edge_removal_hooks (cgraph_edge
*e
);
2266 /* Call all node insertion hooks. */
2267 void call_cgraph_insertion_hooks (cgraph_node
*node
);
2269 /* Call all node removal hooks. */
2270 void call_cgraph_removal_hooks (cgraph_node
*node
);
2272 /* Call all node duplication hooks. */
2273 void call_cgraph_duplication_hooks (cgraph_node
*node
, cgraph_node
*node2
);
2275 /* Call all edge duplication hooks. */
2276 void call_edge_duplication_hooks (cgraph_edge
*cs1
, cgraph_edge
*cs2
);
2278 /* Call all node removal hooks. */
2279 void call_varpool_removal_hooks (varpool_node
*node
);
2281 /* Call all node insertion hooks. */
2282 void call_varpool_insertion_hooks (varpool_node
*node
);
2284 /* Arrange node to be first in its entry of assembler_name_hash. */
2285 void symtab_prevail_in_asm_name_hash (symtab_node
*node
);
2287 /* Initialize asm name hash unless. */
2288 void symtab_initialize_asm_name_hash (void);
2290 /* Set the DECL_ASSEMBLER_NAME and update symtab hashtables. */
2291 void change_decl_assembler_name (tree decl
, tree name
);
2293 /* Dump symbol table to F. */
2294 void dump (FILE *f
);
2296 /* Dump symbol table to F in graphviz format. */
2297 void dump_graphviz (FILE *f
);
2299 /* Dump symbol table to stderr. */
2300 void DEBUG_FUNCTION
debug (void);
2302 /* Assign a new summary ID for the callgraph NODE. */
2303 inline int assign_summary_id (cgraph_node
*node
)
2305 if (!cgraph_released_summary_ids
.is_empty ())
2306 node
->m_summary_id
= cgraph_released_summary_ids
.pop ();
2308 node
->m_summary_id
= cgraph_max_summary_id
++;
2310 return node
->m_summary_id
;
2313 /* Assign a new summary ID for the callgraph EDGE. */
2314 inline int assign_summary_id (cgraph_edge
*edge
)
2316 if (!edge_released_summary_ids
.is_empty ())
2317 edge
->m_summary_id
= edge_released_summary_ids
.pop ();
2319 edge
->m_summary_id
= edges_max_summary_id
++;
2321 return edge
->m_summary_id
;
2324 /* Return true if assembler names NAME1 and NAME2 leads to the same symbol
2326 static bool assembler_names_equal_p (const char *name1
, const char *name2
);
2330 int cgraph_max_summary_id
;
2334 int edges_max_summary_id
;
2336 /* Vector of released summary IDS for cgraph nodes. */
2337 vec
<int> GTY ((skip
)) cgraph_released_summary_ids
;
2339 /* Vector of released summary IDS for cgraph nodes. */
2340 vec
<int> GTY ((skip
)) edge_released_summary_ids
;
2342 /* Return symbol used to separate symbol name from suffix. */
2343 static char symbol_suffix_separator ();
2345 symtab_node
* GTY(()) nodes
;
2346 asm_node
* GTY(()) asmnodes
;
2347 asm_node
* GTY(()) asm_last_node
;
2349 /* The order index of the next symtab node to be created. This is
2350 used so that we can sort the cgraph nodes in order by when we saw
2351 them, to support -fno-toplevel-reorder. */
2354 /* Set when whole unit has been analyzed so we can access global info. */
2355 bool global_info_ready
;
2356 /* What state callgraph is in right now. */
2357 enum symtab_state state
;
2358 /* Set when the cgraph is fully build and the basic flags are computed. */
2359 bool function_flags_ready
;
2361 bool cpp_implicit_aliases_done
;
2363 /* Hash table used to hold sections. */
2364 hash_table
<section_name_hasher
> *GTY(()) section_hash
;
2366 /* Hash table used to convert assembler names into nodes. */
2367 hash_table
<asmname_hasher
> *assembler_name_hash
;
2369 /* Hash table used to hold init priorities. */
2370 hash_map
<symtab_node
*, symbol_priority_map
> *init_priority_hash
;
2372 FILE* GTY ((skip
)) dump_file
;
2374 FILE* GTY ((skip
)) ipa_clones_dump_file
;
2376 hash_set
<const cgraph_node
*> GTY ((skip
)) cloned_nodes
;
2379 /* Allocate new callgraph node. */
2380 inline cgraph_node
* allocate_cgraph_symbol (void);
2382 /* Allocate a cgraph_edge structure and fill it with data according to the
2383 parameters of which only CALLEE can be NULL (when creating an indirect
2384 call edge). CLONING_P should be set if properties that are copied from an
2385 original edge should not be calculated. */
2386 cgraph_edge
*create_edge (cgraph_node
*caller
, cgraph_node
*callee
,
2387 gcall
*call_stmt
, profile_count count
,
2388 bool indir_unknown_callee
, bool cloning_p
);
2390 /* Put the edge onto the free list. */
2391 void free_edge (cgraph_edge
*e
);
2393 /* Insert NODE to assembler name hash. */
2394 void insert_to_assembler_name_hash (symtab_node
*node
, bool with_clones
);
2396 /* Remove NODE from assembler name hash. */
2397 void unlink_from_assembler_name_hash (symtab_node
*node
, bool with_clones
);
2399 /* Hash asmnames ignoring the user specified marks. */
2400 static hashval_t
decl_assembler_name_hash (const_tree asmname
);
2402 /* Compare ASMNAME with the DECL_ASSEMBLER_NAME of DECL. */
2403 static bool decl_assembler_name_equal (tree decl
, const_tree asmname
);
2405 friend struct asmname_hasher
;
2407 /* List of hooks triggered when an edge is removed. */
2408 cgraph_edge_hook_list
* GTY((skip
)) m_first_edge_removal_hook
;
2409 /* List of hooks trigger_red when a cgraph node is removed. */
2410 cgraph_node_hook_list
* GTY((skip
)) m_first_cgraph_removal_hook
;
2411 /* List of hooks triggered when an edge is duplicated. */
2412 cgraph_2edge_hook_list
* GTY((skip
)) m_first_edge_duplicated_hook
;
2413 /* List of hooks triggered when a node is duplicated. */
2414 cgraph_2node_hook_list
* GTY((skip
)) m_first_cgraph_duplicated_hook
;
2415 /* List of hooks triggered when an function is inserted. */
2416 cgraph_node_hook_list
* GTY((skip
)) m_first_cgraph_insertion_hook
;
2417 /* List of hooks triggered when an variable is inserted. */
2418 varpool_node_hook_list
* GTY((skip
)) m_first_varpool_insertion_hook
;
2419 /* List of hooks triggered when a node is removed. */
2420 varpool_node_hook_list
* GTY((skip
)) m_first_varpool_removal_hook
;
2423 extern GTY(()) symbol_table
*symtab
;
2425 extern vec
<cgraph_node
*> cgraph_new_nodes
;
2428 asmname_hasher::hash (symtab_node
*n
)
2430 return symbol_table::decl_assembler_name_hash
2431 (DECL_ASSEMBLER_NAME (n
->decl
));
2435 asmname_hasher::equal (symtab_node
*n
, const_tree t
)
2437 return symbol_table::decl_assembler_name_equal (n
->decl
, t
);
2441 void cgraph_c_finalize (void);
2442 void release_function_body (tree
);
2443 cgraph_indirect_call_info
*cgraph_allocate_init_indirect_info (void);
2445 void cgraph_update_edges_for_call_stmt (gimple
*, tree
, gimple
*);
2446 bool cgraph_function_possibly_inlined_p (tree
);
2448 const char* cgraph_inline_failed_string (cgraph_inline_failed_t
);
2449 cgraph_inline_failed_type_t
cgraph_inline_failed_type (cgraph_inline_failed_t
);
2451 /* In cgraphunit.c */
2452 void cgraphunit_c_finalize (void);
2454 /* Initialize datastructures so DECL is a function in lowered gimple form.
2455 IN_SSA is true if the gimple is in SSA. */
2456 basic_block
init_lowered_empty_function (tree
, bool, profile_count
);
2458 tree
thunk_adjust (gimple_stmt_iterator
*, tree
, bool, HOST_WIDE_INT
, tree
,
2460 /* In cgraphclones.c */
2462 tree
clone_function_name_numbered (const char *name
, const char *suffix
);
2463 tree
clone_function_name_numbered (tree decl
, const char *suffix
);
2464 tree
clone_function_name (const char *name
, const char *suffix
,
2465 unsigned long number
);
2466 tree
clone_function_name (tree decl
, const char *suffix
,
2467 unsigned long number
);
2468 tree
clone_function_name (tree decl
, const char *suffix
);
2470 void tree_function_versioning (tree
, tree
, vec
<ipa_replace_map
*, va_gc
> *,
2471 ipa_param_adjustments
*,
2472 bool, bitmap
, basic_block
);
2474 void dump_callgraph_transformation (const cgraph_node
*original
,
2475 const cgraph_node
*clone
,
2476 const char *suffix
);
2477 /* In cgraphbuild.c */
2478 int compute_call_stmt_bb_frequency (tree
, basic_block bb
);
2479 void record_references_in_initializer (tree
, bool);
2482 void cgraph_build_static_cdtor (char which
, tree body
, int priority
);
2483 bool ipa_discover_variable_flags (void);
2486 tree
ctor_for_folding (tree
);
2488 /* In ipa-inline-analysis.c */
2489 void initialize_inline_failed (struct cgraph_edge
*);
2490 bool speculation_useful_p (struct cgraph_edge
*e
, bool anticipate_inlining
);
2492 /* Return true when the symbol is real symbol, i.e. it is not inline clone
2493 or abstract function kept for debug info purposes only. */
2495 symtab_node::real_symbol_p (void)
2499 if (DECL_ABSTRACT_P (decl
))
2501 if (transparent_alias
&& definition
)
2503 if (!is_a
<cgraph_node
*> (this))
2505 cnode
= dyn_cast
<cgraph_node
*> (this);
2506 if (cnode
->inlined_to
)
2511 /* Return true if DECL should have entry in symbol table if used.
2512 Those are functions and static & external variables. */
2515 decl_in_symtab_p (const_tree decl
)
2517 return (TREE_CODE (decl
) == FUNCTION_DECL
2518 || (TREE_CODE (decl
) == VAR_DECL
2519 && (TREE_STATIC (decl
) || DECL_EXTERNAL (decl
))));
2523 symtab_node::in_same_comdat_group_p (symtab_node
*target
)
2525 symtab_node
*source
= this;
2527 if (cgraph_node
*cn
= dyn_cast
<cgraph_node
*> (target
))
2530 source
= cn
->inlined_to
;
2532 if (cgraph_node
*cn
= dyn_cast
<cgraph_node
*> (target
))
2535 target
= cn
->inlined_to
;
2538 return source
->get_comdat_group () == target
->get_comdat_group ();
2541 /* Return node that alias is aliasing. */
2543 inline symtab_node
*
2544 symtab_node::get_alias_target (void)
2546 ipa_ref
*ref
= NULL
;
2547 iterate_reference (0, ref
);
2548 gcc_checking_assert (ref
->use
== IPA_REF_ALIAS
);
2549 return ref
->referred
;
2552 /* Return next reachable static symbol with initializer after the node. */
2554 inline symtab_node
*
2555 symtab_node::next_defined_symbol (void)
2557 symtab_node
*node1
= next
;
2559 for (; node1
; node1
= node1
->next
)
2560 if (node1
->definition
)
2566 /* Iterates I-th reference in the list, REF is also set. */
2569 symtab_node::iterate_reference (unsigned i
, ipa_ref
*&ref
)
2571 vec_safe_iterate (ref_list
.references
, i
, &ref
);
2576 /* Iterates I-th referring item in the list, REF is also set. */
2579 symtab_node::iterate_referring (unsigned i
, ipa_ref
*&ref
)
2581 ref_list
.referring
.iterate (i
, &ref
);
2586 /* Iterates I-th referring alias item in the list, REF is also set. */
2589 symtab_node::iterate_direct_aliases (unsigned i
, ipa_ref
*&ref
)
2591 ref_list
.referring
.iterate (i
, &ref
);
2593 if (ref
&& ref
->use
!= IPA_REF_ALIAS
)
2599 /* Return true if list contains an alias. */
2602 symtab_node::has_aliases_p (void)
2604 ipa_ref
*ref
= NULL
;
2606 return (iterate_direct_aliases (0, ref
) != NULL
);
2609 /* Return true when RESOLUTION indicate that linker will use
2610 the symbol from non-LTO object files. */
2613 resolution_used_from_other_file_p (enum ld_plugin_symbol_resolution resolution
)
2615 return (resolution
== LDPR_PREVAILING_DEF
2616 || resolution
== LDPR_PREEMPTED_REG
2617 || resolution
== LDPR_RESOLVED_EXEC
2618 || resolution
== LDPR_RESOLVED_DYN
);
2621 /* Return true when symtab_node is known to be used from other (non-LTO)
2622 object file. Known only when doing LTO via linker plugin. */
2625 symtab_node::used_from_object_file_p (void)
2627 if (!TREE_PUBLIC (decl
) || DECL_EXTERNAL (decl
))
2629 if (resolution_used_from_other_file_p (resolution
))
2634 /* Return varpool node for given symbol and check it is a function. */
2636 inline varpool_node
*
2637 varpool_node::get (const_tree decl
)
2639 gcc_checking_assert (TREE_CODE (decl
) == VAR_DECL
);
2640 return dyn_cast
<varpool_node
*> (symtab_node::get (decl
));
2643 /* Register a symbol NODE. */
2646 symbol_table::register_symbol (symtab_node
*node
)
2649 node
->previous
= NULL
;
2652 nodes
->previous
= node
;
2655 node
->order
= order
++;
2658 /* Register a top-level asm statement ASM_STR. */
2661 symbol_table::finalize_toplevel_asm (tree asm_str
)
2665 node
= ggc_cleared_alloc
<asm_node
> ();
2666 node
->asm_str
= asm_str
;
2667 node
->order
= order
++;
2670 if (asmnodes
== NULL
)
2673 asm_last_node
->next
= node
;
2675 asm_last_node
= node
;
2679 /* Unregister a symbol NODE. */
2681 symbol_table::unregister (symtab_node
*node
)
2684 node
->previous
->next
= node
->next
;
2689 node
->next
->previous
= node
->previous
;
2692 node
->previous
= NULL
;
2695 /* Release a callgraph NODE with UID and put in to the list of free nodes. */
2698 symbol_table::release_symbol (cgraph_node
*node
)
2701 if (node
->m_summary_id
!= -1)
2702 cgraph_released_summary_ids
.safe_push (node
->m_summary_id
);
2706 /* Allocate new callgraph node. */
2708 inline cgraph_node
*
2709 symbol_table::allocate_cgraph_symbol (void)
2713 node
= ggc_cleared_alloc
<cgraph_node
> ();
2714 node
->type
= SYMTAB_FUNCTION
;
2715 node
->m_summary_id
= -1;
2716 node
->m_uid
= cgraph_max_uid
++;
2721 /* Return first static symbol with definition. */
2722 inline symtab_node
*
2723 symbol_table::first_symbol (void)
2728 /* Walk all symbols. */
2729 #define FOR_EACH_SYMBOL(node) \
2730 for ((node) = symtab->first_symbol (); (node); (node) = (node)->next)
2732 /* Return first static symbol with definition. */
2733 inline symtab_node
*
2734 symbol_table::first_defined_symbol (void)
2738 for (node
= nodes
; node
; node
= node
->next
)
2739 if (node
->definition
)
2745 /* Walk all symbols with definitions in current unit. */
2746 #define FOR_EACH_DEFINED_SYMBOL(node) \
2747 for ((node) = symtab->first_defined_symbol (); (node); \
2748 (node) = node->next_defined_symbol ())
2750 /* Return first variable. */
2751 inline varpool_node
*
2752 symbol_table::first_variable (void)
2755 for (node
= nodes
; node
; node
= node
->next
)
2756 if (varpool_node
*vnode
= dyn_cast
<varpool_node
*> (node
))
2761 /* Return next variable after NODE. */
2762 inline varpool_node
*
2763 symbol_table::next_variable (varpool_node
*node
)
2765 symtab_node
*node1
= node
->next
;
2766 for (; node1
; node1
= node1
->next
)
2767 if (varpool_node
*vnode1
= dyn_cast
<varpool_node
*> (node1
))
2771 /* Walk all variables. */
2772 #define FOR_EACH_VARIABLE(node) \
2773 for ((node) = symtab->first_variable (); \
2775 (node) = symtab->next_variable ((node)))
2777 /* Return first static variable with initializer. */
2778 inline varpool_node
*
2779 symbol_table::first_static_initializer (void)
2782 for (node
= nodes
; node
; node
= node
->next
)
2784 varpool_node
*vnode
= dyn_cast
<varpool_node
*> (node
);
2785 if (vnode
&& DECL_INITIAL (node
->decl
))
2791 /* Return next static variable with initializer after NODE. */
2792 inline varpool_node
*
2793 symbol_table::next_static_initializer (varpool_node
*node
)
2795 symtab_node
*node1
= node
->next
;
2796 for (; node1
; node1
= node1
->next
)
2798 varpool_node
*vnode1
= dyn_cast
<varpool_node
*> (node1
);
2799 if (vnode1
&& DECL_INITIAL (node1
->decl
))
2805 /* Walk all static variables with initializer set. */
2806 #define FOR_EACH_STATIC_INITIALIZER(node) \
2807 for ((node) = symtab->first_static_initializer (); (node); \
2808 (node) = symtab->next_static_initializer (node))
2810 /* Return first static variable with definition. */
2811 inline varpool_node
*
2812 symbol_table::first_defined_variable (void)
2815 for (node
= nodes
; node
; node
= node
->next
)
2817 varpool_node
*vnode
= dyn_cast
<varpool_node
*> (node
);
2818 if (vnode
&& vnode
->definition
)
2824 /* Return next static variable with definition after NODE. */
2825 inline varpool_node
*
2826 symbol_table::next_defined_variable (varpool_node
*node
)
2828 symtab_node
*node1
= node
->next
;
2829 for (; node1
; node1
= node1
->next
)
2831 varpool_node
*vnode1
= dyn_cast
<varpool_node
*> (node1
);
2832 if (vnode1
&& vnode1
->definition
)
2837 /* Walk all variables with definitions in current unit. */
2838 #define FOR_EACH_DEFINED_VARIABLE(node) \
2839 for ((node) = symtab->first_defined_variable (); (node); \
2840 (node) = symtab->next_defined_variable (node))
2842 /* Return first function with body defined. */
2843 inline cgraph_node
*
2844 symbol_table::first_defined_function (void)
2847 for (node
= nodes
; node
; node
= node
->next
)
2849 cgraph_node
*cn
= dyn_cast
<cgraph_node
*> (node
);
2850 if (cn
&& cn
->definition
)
2856 /* Return next function with body defined after NODE. */
2857 inline cgraph_node
*
2858 symbol_table::next_defined_function (cgraph_node
*node
)
2860 symtab_node
*node1
= node
->next
;
2861 for (; node1
; node1
= node1
->next
)
2863 cgraph_node
*cn1
= dyn_cast
<cgraph_node
*> (node1
);
2864 if (cn1
&& cn1
->definition
)
2870 /* Walk all functions with body defined. */
2871 #define FOR_EACH_DEFINED_FUNCTION(node) \
2872 for ((node) = symtab->first_defined_function (); (node); \
2873 (node) = symtab->next_defined_function ((node)))
2875 /* Return first function. */
2876 inline cgraph_node
*
2877 symbol_table::first_function (void)
2880 for (node
= nodes
; node
; node
= node
->next
)
2881 if (cgraph_node
*cn
= dyn_cast
<cgraph_node
*> (node
))
2886 /* Return next function. */
2887 inline cgraph_node
*
2888 symbol_table::next_function (cgraph_node
*node
)
2890 symtab_node
*node1
= node
->next
;
2891 for (; node1
; node1
= node1
->next
)
2892 if (cgraph_node
*cn1
= dyn_cast
<cgraph_node
*> (node1
))
2897 /* Return first function with body defined. */
2898 inline cgraph_node
*
2899 symbol_table::first_function_with_gimple_body (void)
2902 for (node
= nodes
; node
; node
= node
->next
)
2904 cgraph_node
*cn
= dyn_cast
<cgraph_node
*> (node
);
2905 if (cn
&& cn
->has_gimple_body_p ())
2911 /* Return next reachable static variable with initializer after NODE. */
2912 inline cgraph_node
*
2913 symbol_table::next_function_with_gimple_body (cgraph_node
*node
)
2915 symtab_node
*node1
= node
->next
;
2916 for (; node1
; node1
= node1
->next
)
2918 cgraph_node
*cn1
= dyn_cast
<cgraph_node
*> (node1
);
2919 if (cn1
&& cn1
->has_gimple_body_p ())
2925 /* Walk all functions. */
2926 #define FOR_EACH_FUNCTION(node) \
2927 for ((node) = symtab->first_function (); (node); \
2928 (node) = symtab->next_function ((node)))
2930 /* Return true when callgraph node is a function with Gimple body defined
2931 in current unit. Functions can also be define externally or they
2932 can be thunks with no Gimple representation.
2934 Note that at WPA stage, the function body may not be present in memory. */
2937 cgraph_node::has_gimple_body_p (void)
2939 return definition
&& !thunk
.thunk_p
&& !alias
;
2942 /* Return true if this node represents a former, i.e. an expanded, thunk. */
2945 cgraph_node::former_thunk_p (void)
2947 return (!thunk
.thunk_p
2948 && (thunk
.fixed_offset
2949 || thunk
.virtual_offset_p
2950 || thunk
.indirect_offset
));
2953 /* Walk all functions with body defined. */
2954 #define FOR_EACH_FUNCTION_WITH_GIMPLE_BODY(node) \
2955 for ((node) = symtab->first_function_with_gimple_body (); (node); \
2956 (node) = symtab->next_function_with_gimple_body (node))
2958 /* Uniquize all constants that appear in memory.
2959 Each constant in memory thus far output is recorded
2960 in `const_desc_table'. */
2962 struct GTY((for_user
)) constant_descriptor_tree
{
2963 /* A MEM for the constant. */
2966 /* The value of the constant. */
2969 /* Hash of value. Computing the hash from value each time
2970 hashfn is called can't work properly, as that means recursive
2971 use of the hash table during hash table expansion. */
2975 /* Return true when function is only called directly or it has alias.
2976 i.e. it is not externally visible, address was not taken and
2977 it is not used in any other non-standard way. */
2980 cgraph_node::only_called_directly_or_aliased_p (void)
2982 gcc_assert (!inlined_to
);
2983 return (!force_output
&& !address_taken
2985 && !used_from_other_partition
2986 && !DECL_VIRTUAL_P (decl
)
2987 && !DECL_STATIC_CONSTRUCTOR (decl
)
2988 && !DECL_STATIC_DESTRUCTOR (decl
)
2989 && !used_from_object_file_p ()
2990 && !externally_visible
);
2993 /* Return true when function can be removed from callgraph
2994 if all direct calls are eliminated. */
2997 cgraph_node::can_remove_if_no_direct_calls_and_refs_p (void)
2999 gcc_checking_assert (!inlined_to
);
3000 /* Extern inlines can always go, we will use the external definition. */
3001 if (DECL_EXTERNAL (decl
))
3003 /* When function is needed, we cannot remove it. */
3004 if (force_output
|| used_from_other_partition
)
3006 if (DECL_STATIC_CONSTRUCTOR (decl
)
3007 || DECL_STATIC_DESTRUCTOR (decl
))
3009 /* Only COMDAT functions can be removed if externally visible. */
3010 if (externally_visible
3011 && (!DECL_COMDAT (decl
)
3013 || used_from_object_file_p ()))
3018 /* Verify cgraph, if consistency checking is enabled. */
3021 cgraph_node::checking_verify_cgraph_nodes (void)
3024 cgraph_node::verify_cgraph_nodes ();
3027 /* Return true when variable can be removed from variable pool
3028 if all direct calls are eliminated. */
3031 varpool_node::can_remove_if_no_refs_p (void)
3033 if (DECL_EXTERNAL (decl
))
3035 return (!force_output
&& !used_from_other_partition
3036 && ((DECL_COMDAT (decl
)
3038 && !used_from_object_file_p ())
3039 || !externally_visible
3040 || DECL_HAS_VALUE_EXPR_P (decl
)));
3043 /* Return true when all references to variable must be visible in ipa_ref_list.
3044 i.e. if the variable is not externally visible or not used in some magic
3045 way (asm statement or such).
3046 The magic uses are all summarized in force_output flag. */
3049 varpool_node::all_refs_explicit_p ()
3052 && !externally_visible
3053 && !used_from_other_partition
3057 struct tree_descriptor_hasher
: ggc_ptr_hash
<constant_descriptor_tree
>
3059 static hashval_t
hash (constant_descriptor_tree
*);
3060 static bool equal (constant_descriptor_tree
*, constant_descriptor_tree
*);
3063 /* Constant pool accessor function. */
3064 hash_table
<tree_descriptor_hasher
> *constant_pool_htab (void);
3066 /* Return node that alias is aliasing. */
3068 inline cgraph_node
*
3069 cgraph_node::get_alias_target (void)
3071 return dyn_cast
<cgraph_node
*> (symtab_node::get_alias_target ());
3074 /* Return node that alias is aliasing. */
3076 inline varpool_node
*
3077 varpool_node::get_alias_target (void)
3079 return dyn_cast
<varpool_node
*> (symtab_node::get_alias_target ());
3082 /* Walk the alias chain to return the symbol NODE is alias of.
3083 If NODE is not an alias, return NODE.
3084 When AVAILABILITY is non-NULL, get minimal availability in the chain.
3085 When REF is non-NULL, assume that reference happens in symbol REF
3086 when determining the availability. */
3088 inline symtab_node
*
3089 symtab_node::ultimate_alias_target (enum availability
*availability
,
3095 *availability
= get_availability (ref
);
3099 return ultimate_alias_target_1 (availability
, ref
);
3102 /* Given function symbol, walk the alias chain to return the function node
3103 is alias of. Do not walk through thunks.
3104 When AVAILABILITY is non-NULL, get minimal availability in the chain.
3105 When REF is non-NULL, assume that reference happens in symbol REF
3106 when determining the availability. */
3108 inline cgraph_node
*
3109 cgraph_node::ultimate_alias_target (enum availability
*availability
,
3112 cgraph_node
*n
= dyn_cast
<cgraph_node
*>
3113 (symtab_node::ultimate_alias_target (availability
, ref
));
3114 if (!n
&& availability
)
3115 *availability
= AVAIL_NOT_AVAILABLE
;
3119 /* For given variable pool node, walk the alias chain to return the function
3120 the variable is alias of. Do not walk through thunks.
3121 When AVAILABILITY is non-NULL, get minimal availability in the chain.
3122 When REF is non-NULL, assume that reference happens in symbol REF
3123 when determining the availability. */
3125 inline varpool_node
*
3126 varpool_node::ultimate_alias_target (availability
*availability
,
3129 varpool_node
*n
= dyn_cast
<varpool_node
*>
3130 (symtab_node::ultimate_alias_target (availability
, ref
));
3132 if (!n
&& availability
)
3133 *availability
= AVAIL_NOT_AVAILABLE
;
3137 /* Set callee N of call graph edge and add it to the corresponding set of
3141 cgraph_edge::set_callee (cgraph_node
*n
)
3145 n
->callers
->prev_caller
= this;
3146 next_caller
= n
->callers
;
3151 /* Redirect callee of the edge to N. The function does not update underlying
3155 cgraph_edge::redirect_callee (cgraph_node
*n
)
3157 /* Remove from callers list of the current callee. */
3160 /* Insert to callers list of the new callee. */
3164 /* Return true when the edge represents a direct recursion. */
3167 cgraph_edge::recursive_p (void)
3169 cgraph_node
*c
= callee
->ultimate_alias_target ();
3170 if (caller
->inlined_to
)
3171 return caller
->inlined_to
->decl
== c
->decl
;
3173 return caller
->decl
== c
->decl
;
3176 /* Remove the edge from the list of the callers of the callee. */
3179 cgraph_edge::remove_callee (void)
3181 gcc_assert (!indirect_unknown_callee
);
3183 prev_caller
->next_caller
= next_caller
;
3185 next_caller
->prev_caller
= prev_caller
;
3187 callee
->callers
= next_caller
;
3190 /* Return true if call must bind to current definition. */
3193 cgraph_edge::binds_to_current_def_p ()
3196 return callee
->binds_to_current_def_p (caller
);
3201 /* Expected frequency of executions within the function.
3202 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
3203 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
3206 cgraph_edge::frequency ()
3208 return count
.to_cgraph_frequency (caller
->inlined_to
3209 ? caller
->inlined_to
->count
3214 /* Return true if the TM_CLONE bit is set for a given FNDECL. */
3216 decl_is_tm_clone (const_tree fndecl
)
3218 cgraph_node
*n
= cgraph_node::get (fndecl
);
3224 /* Likewise indicate that a node is needed, i.e. reachable via some
3228 cgraph_node::mark_force_output (void)
3231 gcc_checking_assert (!inlined_to
);
3234 /* Return true if function should be optimized for size. */
3237 cgraph_node::optimize_for_size_p (void)
3239 if (opt_for_fn (decl
, optimize_size
))
3241 if (frequency
== NODE_FREQUENCY_UNLIKELY_EXECUTED
)
3247 /* Return symtab_node for NODE or create one if it is not present
3250 inline symtab_node
*
3251 symtab_node::get_create (tree node
)
3253 if (TREE_CODE (node
) == VAR_DECL
)
3254 return varpool_node::get_create (node
);
3256 return cgraph_node::get_create (node
);
3259 /* Return availability of NODE when referenced from REF. */
3261 inline enum availability
3262 symtab_node::get_availability (symtab_node
*ref
)
3264 if (is_a
<cgraph_node
*> (this))
3265 return dyn_cast
<cgraph_node
*> (this)->get_availability (ref
);
3267 return dyn_cast
<varpool_node
*> (this)->get_availability (ref
);
3270 /* Call callback on symtab node and aliases associated to this node.
3271 When INCLUDE_OVERWRITABLE is false, overwritable symbols are skipped. */
3274 symtab_node::call_for_symbol_and_aliases (bool (*callback
) (symtab_node
*,
3277 bool include_overwritable
)
3279 if (include_overwritable
3280 || get_availability () > AVAIL_INTERPOSABLE
)
3282 if (callback (this, data
))
3285 if (has_aliases_p ())
3286 return call_for_symbol_and_aliases_1 (callback
, data
, include_overwritable
);
3290 /* Call callback on function and aliases associated to the function.
3291 When INCLUDE_OVERWRITABLE is false, overwritable symbols are
3295 cgraph_node::call_for_symbol_and_aliases (bool (*callback
) (cgraph_node
*,
3298 bool include_overwritable
)
3300 if (include_overwritable
3301 || get_availability () > AVAIL_INTERPOSABLE
)
3303 if (callback (this, data
))
3306 if (has_aliases_p ())
3307 return call_for_symbol_and_aliases_1 (callback
, data
, include_overwritable
);
3311 /* Call callback on varpool symbol and aliases associated to varpool symbol.
3312 When INCLUDE_OVERWRITABLE is false, overwritable symbols are
3316 varpool_node::call_for_symbol_and_aliases (bool (*callback
) (varpool_node
*,
3319 bool include_overwritable
)
3321 if (include_overwritable
3322 || get_availability () > AVAIL_INTERPOSABLE
)
3324 if (callback (this, data
))
3327 if (has_aliases_p ())
3328 return call_for_symbol_and_aliases_1 (callback
, data
, include_overwritable
);
3332 /* Return true if reference may be used in address compare. */
3335 ipa_ref::address_matters_p ()
3337 if (use
!= IPA_REF_ADDR
)
3339 /* Addresses taken from virtual tables are never compared. */
3340 if (is_a
<varpool_node
*> (referring
)
3341 && DECL_VIRTUAL_P (referring
->decl
))
3343 return referred
->address_can_be_compared_p ();
3346 /* Build polymorphic call context for indirect call E. */
3349 ipa_polymorphic_call_context::ipa_polymorphic_call_context (cgraph_edge
*e
)
3351 gcc_checking_assert (e
->indirect_info
->polymorphic
);
3352 *this = e
->indirect_info
->context
;
3355 /* Build empty "I know nothing" context. */
3358 ipa_polymorphic_call_context::ipa_polymorphic_call_context ()
3360 clear_speculation ();
3361 clear_outer_type ();
3365 /* Make context non-speculative. */
3368 ipa_polymorphic_call_context::clear_speculation ()
3370 speculative_outer_type
= NULL
;
3371 speculative_offset
= 0;
3372 speculative_maybe_derived_type
= false;
3375 /* Produce context specifying all derived types of OTR_TYPE. If OTR_TYPE is
3376 NULL, the context is set to dummy "I know nothing" setting. */
3379 ipa_polymorphic_call_context::clear_outer_type (tree otr_type
)
3381 outer_type
= otr_type
? TYPE_MAIN_VARIANT (otr_type
) : NULL
;
3383 maybe_derived_type
= true;
3384 maybe_in_construction
= true;
3388 /* Adjust all offsets in contexts by OFF bits. */
3391 ipa_polymorphic_call_context::offset_by (HOST_WIDE_INT off
)
3395 if (speculative_outer_type
)
3396 speculative_offset
+= off
;
3399 /* Return TRUE if context is fully useless. */
3402 ipa_polymorphic_call_context::useless_p () const
3404 return (!outer_type
&& !speculative_outer_type
);
3407 /* When using fprintf (or similar), problems can arise with
3408 transient generated strings. Many string-generation APIs
3409 only support one result being alive at once (e.g. by
3410 returning a pointer to a statically-allocated buffer).
3412 If there is more than one generated string within one
3413 fprintf call: the first string gets evicted or overwritten
3414 by the second, before fprintf is fully evaluated.
3417 This function provides a workaround for this, by providing
3418 a simple way to create copies of these transient strings,
3419 without the need to have explicit cleanup:
3421 fprintf (dumpfile, "string 1: %s string 2:%s\n",
3422 xstrdup_for_dump (EXPR_1),
3423 xstrdup_for_dump (EXPR_2));
3425 This is actually a simple wrapper around ggc_strdup, but
3426 the name documents the intent. We require that no GC can occur
3427 within the fprintf call. */
3429 static inline const char *
3430 xstrdup_for_dump (const char *transient_str
)
3432 return ggc_strdup (transient_str
);
3435 /* During LTO stream-in this predicate can be used to check whether node
3436 in question prevails in the linking to save some memory usage. */
3438 symtab_node::prevailing_p (void)
3440 return definition
&& ((!TREE_PUBLIC (decl
) && !DECL_EXTERNAL (decl
))
3441 || previous_sharing_asm_name
== NULL
);
3444 extern GTY(()) symbol_table
*saved_symtab
;
3448 namespace selftest
{
3450 /* An RAII-style class for use in selftests for temporarily using a different
3451 symbol_table, so that such tests can be isolated from each other. */
3453 class symbol_table_test
3456 /* Constructor. Override "symtab". */
3457 symbol_table_test ();
3459 /* Destructor. Restore the saved_symtab. */
3460 ~symbol_table_test ();
3463 } // namespace selftest
3465 #endif /* CHECKING_P */
3467 #endif /* GCC_CGRAPH_H */