* testsuite/26_numerics/headers/cmath/hypot.cc: XFAIL on AIX.
[official-gcc.git] / gcc / cgraph.h
blob3feed7a8d8057b60afb7bd5ed9e4d0cba2ee2548
1 /* Callgraph handling code.
2 Copyright (C) 2003-2016 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
10 version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
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/>. */
21 #ifndef GCC_CGRAPH_H
22 #define GCC_CGRAPH_H
24 #include "ipa-ref.h"
25 #include "plugin-api.h"
27 class ipa_opt_pass_d;
28 typedef ipa_opt_pass_d *ipa_opt_pass;
30 /* Symbol table consists of functions and variables.
31 TODO: add labels and CONST_DECLs. */
32 enum symtab_type
34 SYMTAB_SYMBOL,
35 SYMTAB_FUNCTION,
36 SYMTAB_VARIABLE
39 /* Section names are stored as reference counted strings in GGC safe hashtable
40 (to make them survive through PCH). */
42 struct GTY((for_user)) section_hash_entry
44 int ref_count;
45 char *name; /* As long as this datastructure stays in GGC, we can not put
46 string at the tail of structure of GGC dies in horrible
47 way */
50 struct section_name_hasher : ggc_ptr_hash<section_hash_entry>
52 typedef const char *compare_type;
54 static hashval_t hash (section_hash_entry *);
55 static bool equal (section_hash_entry *, const char *);
58 enum availability
60 /* Not yet set by cgraph_function_body_availability. */
61 AVAIL_UNSET,
62 /* Function body/variable initializer is unknown. */
63 AVAIL_NOT_AVAILABLE,
64 /* Function body/variable initializer is known but might be replaced
65 by a different one from other compilation unit and thus needs to
66 be dealt with a care. Like AVAIL_NOT_AVAILABLE it can have
67 arbitrary side effects on escaping variables and functions, while
68 like AVAILABLE it might access static variables. */
69 AVAIL_INTERPOSABLE,
70 /* Function body/variable initializer is known and will be used in final
71 program. */
72 AVAIL_AVAILABLE,
73 /* Function body/variable initializer is known and all it's uses are
74 explicitly visible within current unit (ie it's address is never taken and
75 it is not exported to other units). Currently used only for functions. */
76 AVAIL_LOCAL
79 /* Classification of symbols WRT partitioning. */
80 enum symbol_partitioning_class
82 /* External declarations are ignored by partitioning algorithms and they are
83 added into the boundary later via compute_ltrans_boundary. */
84 SYMBOL_EXTERNAL,
85 /* Partitioned symbols are pur into one of partitions. */
86 SYMBOL_PARTITION,
87 /* Duplicated symbols (such as comdat or constant pool references) are
88 copied into every node needing them via add_symbol_to_partition. */
89 SYMBOL_DUPLICATE
92 /* Base of all entries in the symbol table.
93 The symtab_node is inherited by cgraph and varpol nodes. */
94 class GTY((desc ("%h.type"), tag ("SYMTAB_SYMBOL"),
95 chain_next ("%h.next"), chain_prev ("%h.previous")))
96 symtab_node
98 public:
99 /* Return name. */
100 const char *name () const;
102 /* Return asm name. */
103 const char * asm_name () const;
105 /* Add node into symbol table. This function is not used directly, but via
106 cgraph/varpool node creation routines. */
107 void register_symbol (void);
109 /* Remove symbol from symbol table. */
110 void remove (void);
112 /* Dump symtab node to F. */
113 void dump (FILE *f);
115 /* Dump symtab node to stderr. */
116 void DEBUG_FUNCTION debug (void);
118 /* Verify consistency of node. */
119 void DEBUG_FUNCTION verify (void);
121 /* Return ipa reference from this symtab_node to
122 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
123 of the use and STMT the statement (if it exists). */
124 ipa_ref *create_reference (symtab_node *referred_node,
125 enum ipa_ref_use use_type);
127 /* Return ipa reference from this symtab_node to
128 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
129 of the use and STMT the statement (if it exists). */
130 ipa_ref *create_reference (symtab_node *referred_node,
131 enum ipa_ref_use use_type, gimple *stmt);
133 /* If VAL is a reference to a function or a variable, add a reference from
134 this symtab_node to the corresponding symbol table node. USE_TYPE specify
135 type of the use and STMT the statement (if it exists). Return the new
136 reference or NULL if none was created. */
137 ipa_ref *maybe_create_reference (tree val, enum ipa_ref_use use_type,
138 gimple *stmt);
140 /* Clone all references from symtab NODE to this symtab_node. */
141 void clone_references (symtab_node *node);
143 /* Remove all stmt references in non-speculative references.
144 Those are not maintained during inlining & clonning.
145 The exception are speculative references that are updated along
146 with callgraph edges associated with them. */
147 void clone_referring (symtab_node *node);
149 /* Clone reference REF to this symtab_node and set its stmt to STMT. */
150 ipa_ref *clone_reference (ipa_ref *ref, gimple *stmt);
152 /* Find the structure describing a reference to REFERRED_NODE
153 and associated with statement STMT. */
154 ipa_ref *find_reference (symtab_node *referred_node, gimple *stmt,
155 unsigned int lto_stmt_uid);
157 /* Remove all references that are associated with statement STMT. */
158 void remove_stmt_references (gimple *stmt);
160 /* Remove all stmt references in non-speculative references.
161 Those are not maintained during inlining & clonning.
162 The exception are speculative references that are updated along
163 with callgraph edges associated with them. */
164 void clear_stmts_in_references (void);
166 /* Remove all references in ref list. */
167 void remove_all_references (void);
169 /* Remove all referring items in ref list. */
170 void remove_all_referring (void);
172 /* Dump references in ref list to FILE. */
173 void dump_references (FILE *file);
175 /* Dump referring in list to FILE. */
176 void dump_referring (FILE *);
178 /* Get number of references for this node. */
179 inline unsigned num_references (void)
181 return ref_list.references ? ref_list.references->length () : 0;
184 /* Iterates I-th reference in the list, REF is also set. */
185 ipa_ref *iterate_reference (unsigned i, ipa_ref *&ref);
187 /* Iterates I-th referring item in the list, REF is also set. */
188 ipa_ref *iterate_referring (unsigned i, ipa_ref *&ref);
190 /* Iterates I-th referring alias item in the list, REF is also set. */
191 ipa_ref *iterate_direct_aliases (unsigned i, ipa_ref *&ref);
193 /* Return true if symtab node and TARGET represents
194 semantically equivalent symbols. */
195 bool semantically_equivalent_p (symtab_node *target);
197 /* Classify symbol symtab node for partitioning. */
198 enum symbol_partitioning_class get_partitioning_class (void);
200 /* Return comdat group. */
201 tree get_comdat_group ()
203 return x_comdat_group;
206 /* Return comdat group as identifier_node. */
207 tree get_comdat_group_id ()
209 if (x_comdat_group && TREE_CODE (x_comdat_group) != IDENTIFIER_NODE)
210 x_comdat_group = DECL_ASSEMBLER_NAME (x_comdat_group);
211 return x_comdat_group;
214 /* Set comdat group. */
215 void set_comdat_group (tree group)
217 gcc_checking_assert (!group || TREE_CODE (group) == IDENTIFIER_NODE
218 || DECL_P (group));
219 x_comdat_group = group;
222 /* Return section as string. */
223 const char * get_section ()
225 if (!x_section)
226 return NULL;
227 return x_section->name;
230 /* Remove node from same comdat group. */
231 void remove_from_same_comdat_group (void);
233 /* Add this symtab_node to the same comdat group that OLD is in. */
234 void add_to_same_comdat_group (symtab_node *old_node);
236 /* Dissolve the same_comdat_group list in which NODE resides. */
237 void dissolve_same_comdat_group_list (void);
239 /* Return true when symtab_node is known to be used from other (non-LTO)
240 object file. Known only when doing LTO via linker plugin. */
241 bool used_from_object_file_p (void);
243 /* Walk the alias chain to return the symbol NODE is alias of.
244 If NODE is not an alias, return NODE.
245 When AVAILABILITY is non-NULL, get minimal availability in the chain.
246 When REF is non-NULL, assume that reference happens in symbol REF
247 when determining the availability. */
248 symtab_node *ultimate_alias_target (enum availability *avail = NULL,
249 struct symtab_node *ref = NULL);
251 /* Return next reachable static symbol with initializer after NODE. */
252 inline symtab_node *next_defined_symbol (void);
254 /* Add reference recording that symtab node is alias of TARGET.
255 If TRANSPARENT is true make the alias to be transparent alias.
256 The function can fail in the case of aliasing cycles; in this case
257 it returns false. */
258 bool resolve_alias (symtab_node *target, bool transparent = false);
260 /* C++ FE sometimes change linkage flags after producing same
261 body aliases. */
262 void fixup_same_cpp_alias_visibility (symtab_node *target);
264 /* Call callback on symtab node and aliases associated to this node.
265 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
266 skipped. */
267 bool call_for_symbol_and_aliases (bool (*callback) (symtab_node *, void *),
268 void *data,
269 bool include_overwrite);
271 /* If node can not be interposable by static or dynamic linker to point to
272 different definition, return this symbol. Otherwise look for alias with
273 such property and if none exists, introduce new one. */
274 symtab_node *noninterposable_alias (void);
276 /* Return node that alias is aliasing. */
277 inline symtab_node *get_alias_target (void);
279 /* Set section for symbol and its aliases. */
280 void set_section (const char *section);
282 /* Set section, do not recurse into aliases.
283 When one wants to change section of symbol and its aliases,
284 use set_section. */
285 void set_section_for_node (const char *section);
287 /* Set initialization priority to PRIORITY. */
288 void set_init_priority (priority_type priority);
290 /* Return the initialization priority. */
291 priority_type get_init_priority ();
293 /* Return availability of NODE when referenced from REF. */
294 enum availability get_availability (symtab_node *ref = NULL);
296 /* Return true if NODE binds to current definition in final executable
297 when referenced from REF. If REF is NULL return conservative value
298 for any reference. */
299 bool binds_to_current_def_p (symtab_node *ref = NULL);
301 /* Make DECL local. */
302 void make_decl_local (void);
304 /* Copy visibility from N. */
305 void copy_visibility_from (symtab_node *n);
307 /* Return desired alignment of the definition. This is NOT alignment useful
308 to access THIS, because THIS may be interposable and DECL_ALIGN should
309 be used instead. It however must be guaranteed when output definition
310 of THIS. */
311 unsigned int definition_alignment ();
313 /* Return true if alignment can be increased. */
314 bool can_increase_alignment_p ();
316 /* Increase alignment of symbol to ALIGN. */
317 void increase_alignment (unsigned int align);
319 /* Return true if list contains an alias. */
320 bool has_aliases_p (void);
322 /* Return true when the symbol is real symbol, i.e. it is not inline clone
323 or abstract function kept for debug info purposes only. */
324 bool real_symbol_p (void);
326 /* Determine if symbol declaration is needed. That is, visible to something
327 either outside this translation unit, something magic in the system
328 configury. This function is used just during symbol creation. */
329 bool needed_p (void);
331 /* Return true when there are references to the node. */
332 bool referred_to_p (bool include_self = true);
334 /* Return true if symbol can be discarded by linker from the binary.
335 Assume that symbol is used (so there is no need to take into account
336 garbage collecting linkers)
338 This can happen for comdats, commons and weaks when they are previaled
339 by other definition at static linking time. */
340 inline bool
341 can_be_discarded_p (void)
343 return (DECL_EXTERNAL (decl)
344 || ((get_comdat_group ()
345 || DECL_COMMON (decl)
346 || (DECL_SECTION_NAME (decl) && DECL_WEAK (decl)))
347 && ((resolution != LDPR_PREVAILING_DEF
348 && resolution != LDPR_PREVAILING_DEF_IRONLY_EXP)
349 || flag_incremental_link)
350 && resolution != LDPR_PREVAILING_DEF_IRONLY));
353 /* Return true if NODE is local to a particular COMDAT group, and must not
354 be named from outside the COMDAT. This is used for C++ decloned
355 constructors. */
356 inline bool comdat_local_p (void)
358 return (same_comdat_group && !TREE_PUBLIC (decl));
361 /* Return true if ONE and TWO are part of the same COMDAT group. */
362 inline bool in_same_comdat_group_p (symtab_node *target);
364 /* Return true if symbol is known to be nonzero. */
365 bool nonzero_address ();
367 /* Return 0 if symbol is known to have different address than S2,
368 Return 1 if symbol is known to have same address as S2,
369 return 2 otherwise.
371 If MEMORY_ACCESSED is true, assume that both memory pointer to THIS
372 and S2 is going to be accessed. This eliminates the situations when
373 either THIS or S2 is NULL and is seful for comparing bases when deciding
374 about memory aliasing. */
375 int equal_address_to (symtab_node *s2, bool memory_accessed = false);
377 /* Return true if symbol's address may possibly be compared to other
378 symbol's address. */
379 bool address_matters_p ();
381 /* Return true if NODE's address can be compared. This use properties
382 of NODE only and does not look if the address is actually taken in
383 interesting way. For that use ADDRESS_MATTERS_P instead. */
384 bool address_can_be_compared_p (void);
386 /* Return symbol table node associated with DECL, if any,
387 and NULL otherwise. */
388 static inline symtab_node *get (const_tree decl)
390 /* Check that we are called for sane type of object - functions
391 and static or external variables. */
392 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL
393 || (TREE_CODE (decl) == VAR_DECL
394 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl)
395 || in_lto_p)));
396 /* Check that the mapping is sane - perhaps this check can go away,
397 but at the moment frontends tends to corrupt the mapping by calling
398 memcpy/memset on the tree nodes. */
399 gcc_checking_assert (!decl->decl_with_vis.symtab_node
400 || decl->decl_with_vis.symtab_node->decl == decl);
401 return decl->decl_with_vis.symtab_node;
404 /* Try to find a symtab node for declaration DECL and if it does not
405 exist or if it corresponds to an inline clone, create a new one. */
406 static inline symtab_node * get_create (tree node);
408 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
409 Return NULL if there's no such node. */
410 static symtab_node *get_for_asmname (const_tree asmname);
412 /* Dump symbol table to F. */
413 static void dump_table (FILE *);
415 /* Dump symbol table to stderr. */
416 static inline DEBUG_FUNCTION void debug_symtab (void)
418 dump_table (stderr);
421 /* Verify symbol table for internal consistency. */
422 static DEBUG_FUNCTION void verify_symtab_nodes (void);
424 /* Perform internal consistency checks, if they are enabled. */
425 static inline void checking_verify_symtab_nodes (void);
427 /* Type of the symbol. */
428 ENUM_BITFIELD (symtab_type) type : 8;
430 /* The symbols resolution. */
431 ENUM_BITFIELD (ld_plugin_symbol_resolution) resolution : 8;
433 /*** Flags representing the symbol type. ***/
435 /* True when symbol corresponds to a definition in current unit.
436 set via finalize_function or finalize_decl */
437 unsigned definition : 1;
438 /* True when symbol is an alias.
439 Set by ssemble_alias. */
440 unsigned alias : 1;
441 /* When true the alias is translated into its target symbol either by GCC
442 or assembler (it also may just be a duplicate declaration of the same
443 linker name).
445 Currently transparent aliases come in three different flavors
446 - aliases having the same assembler name as their target (aka duplicated
447 declarations). In this case the assembler names compare via
448 assembler_names_equal_p and weakref is false
449 - aliases that are renamed at a time being output to final file
450 by varasm.c. For those DECL_ASSEMBLER_NAME have
451 IDENTIFIER_TRANSPARENT_ALIAS set and thus also their assembler
452 name must be unique.
453 Weakrefs belong to this cateogry when we target assembler without
454 .weakref directive.
455 - weakrefs that are renamed by assembler via .weakref directive.
456 In this case the alias may or may not be definition (depending if
457 target declaration was seen by the compiler), weakref is set.
458 Unless we are before renaming statics, assembler names are different.
460 Given that we now support duplicate declarations, the second option is
461 redundant and will be removed. */
462 unsigned transparent_alias : 1;
463 /* True when alias is a weakref. */
464 unsigned weakref : 1;
465 /* C++ frontend produce same body aliases and extra name aliases for
466 virtual functions and vtables that are obviously equivalent.
467 Those aliases are bit special, especially because C++ frontend
468 visibility code is so ugly it can not get them right at first time
469 and their visibility needs to be copied from their "masters" at
470 the end of parsing. */
471 unsigned cpp_implicit_alias : 1;
472 /* Set once the definition was analyzed. The list of references and
473 other properties are built during analysis. */
474 unsigned analyzed : 1;
475 /* Set for write-only variables. */
476 unsigned writeonly : 1;
477 /* Visibility of symbol was used for further optimization; do not
478 permit further changes. */
479 unsigned refuse_visibility_changes : 1;
481 /*** Visibility and linkage flags. ***/
483 /* Set when function is visible by other units. */
484 unsigned externally_visible : 1;
485 /* Don't reorder to other symbols having this set. */
486 unsigned no_reorder : 1;
487 /* The symbol will be assumed to be used in an invisible way (like
488 by an toplevel asm statement). */
489 unsigned force_output : 1;
490 /* Like FORCE_OUTPUT, but in the case it is ABI requiring the symbol to be
491 exported. Unlike FORCE_OUTPUT this flag gets cleared to symbols promoted
492 to static and it does not inhibit optimization. */
493 unsigned forced_by_abi : 1;
494 /* True when the name is known to be unique and thus it does not need mangling. */
495 unsigned unique_name : 1;
496 /* Specify whether the section was set by user or by
497 compiler via -ffunction-sections. */
498 unsigned implicit_section : 1;
499 /* True when body and other characteristics have been removed by
500 symtab_remove_unreachable_nodes. */
501 unsigned body_removed : 1;
503 /*** WHOPR Partitioning flags.
504 These flags are used at ltrans stage when only part of the callgraph is
505 available. ***/
507 /* Set when variable is used from other LTRANS partition. */
508 unsigned used_from_other_partition : 1;
509 /* Set when function is available in the other LTRANS partition.
510 During WPA output it is used to mark nodes that are present in
511 multiple partitions. */
512 unsigned in_other_partition : 1;
516 /*** other flags. ***/
518 /* Set when symbol has address taken. */
519 unsigned address_taken : 1;
520 /* Set when init priority is set. */
521 unsigned in_init_priority_hash : 1;
523 /* Set when symbol needs to be streamed into LTO bytecode for LTO, or in case
524 of offloading, for separate compilation for a different target. */
525 unsigned need_lto_streaming : 1;
527 /* Set when symbol can be streamed into bytecode for offloading. */
528 unsigned offloadable : 1;
531 /* Ordering of all symtab entries. */
532 int order;
534 /* Declaration representing the symbol. */
535 tree decl;
537 /* Linked list of symbol table entries starting with symtab_nodes. */
538 symtab_node *next;
539 symtab_node *previous;
541 /* Linked list of symbols with the same asm name. There may be multiple
542 entries for single symbol name during LTO, because symbols are renamed
543 only after partitioning.
545 Because inline clones are kept in the assembler name has, they also produce
546 duplicate entries.
548 There are also several long standing bugs where frontends and builtin
549 code produce duplicated decls. */
550 symtab_node *next_sharing_asm_name;
551 symtab_node *previous_sharing_asm_name;
553 /* Circular list of nodes in the same comdat group if non-NULL. */
554 symtab_node *same_comdat_group;
556 /* Vectors of referring and referenced entities. */
557 ipa_ref_list ref_list;
559 /* Alias target. May be either DECL pointer or ASSEMBLER_NAME pointer
560 depending to what was known to frontend on the creation time.
561 Once alias is resolved, this pointer become NULL. */
562 tree alias_target;
564 /* File stream where this node is being written to. */
565 struct lto_file_decl_data * lto_file_data;
567 PTR GTY ((skip)) aux;
569 /* Comdat group the symbol is in. Can be private if GGC allowed that. */
570 tree x_comdat_group;
572 /* Section name. Again can be private, if allowed. */
573 section_hash_entry *x_section;
575 protected:
576 /* Dump base fields of symtab nodes to F. Not to be used directly. */
577 void dump_base (FILE *);
579 /* Verify common part of symtab node. */
580 bool DEBUG_FUNCTION verify_base (void);
582 /* Remove node from symbol table. This function is not used directly, but via
583 cgraph/varpool node removal routines. */
584 void unregister (void);
586 /* Return the initialization and finalization priority information for
587 DECL. If there is no previous priority information, a freshly
588 allocated structure is returned. */
589 struct symbol_priority_map *priority_info (void);
591 /* Worker for call_for_symbol_and_aliases_1. */
592 bool call_for_symbol_and_aliases_1 (bool (*callback) (symtab_node *, void *),
593 void *data,
594 bool include_overwrite);
595 private:
596 /* Worker for set_section. */
597 static bool set_section (symtab_node *n, void *s);
599 /* Worker for symtab_resolve_alias. */
600 static bool set_implicit_section (symtab_node *n, void *);
602 /* Worker searching noninterposable alias. */
603 static bool noninterposable_alias (symtab_node *node, void *data);
605 /* Worker for ultimate_alias_target. */
606 symtab_node *ultimate_alias_target_1 (enum availability *avail = NULL,
607 symtab_node *ref = NULL);
610 inline void
611 symtab_node::checking_verify_symtab_nodes (void)
613 if (flag_checking)
614 symtab_node::verify_symtab_nodes ();
617 /* Walk all aliases for NODE. */
618 #define FOR_EACH_ALIAS(node, alias) \
619 for (unsigned x_i = 0; node->iterate_direct_aliases (x_i, alias); x_i++)
621 /* This is the information that is put into the cgraph local structure
622 to recover a function. */
623 struct lto_file_decl_data;
625 extern const char * const cgraph_availability_names[];
626 extern const char * const ld_plugin_symbol_resolution_names[];
627 extern const char * const tls_model_names[];
629 /* Information about thunk, used only for same body aliases. */
631 struct GTY(()) cgraph_thunk_info {
632 /* Information about the thunk. */
633 HOST_WIDE_INT fixed_offset;
634 HOST_WIDE_INT virtual_value;
635 tree alias;
636 bool this_adjusting;
637 bool virtual_offset_p;
638 bool add_pointer_bounds_args;
639 /* Set to true when alias node is thunk. */
640 bool thunk_p;
643 /* Information about the function collected locally.
644 Available after function is analyzed. */
646 struct GTY(()) cgraph_local_info {
647 /* Set when function is visible in current compilation unit only and
648 its address is never taken. */
649 unsigned local : 1;
651 /* False when there is something makes versioning impossible. */
652 unsigned versionable : 1;
654 /* False when function calling convention and signature can not be changed.
655 This is the case when __builtin_apply_args is used. */
656 unsigned can_change_signature : 1;
658 /* True when the function has been originally extern inline, but it is
659 redefined now. */
660 unsigned redefined_extern_inline : 1;
662 /* True if the function may enter serial irrevocable mode. */
663 unsigned tm_may_enter_irr : 1;
666 /* Information about the function that needs to be computed globally
667 once compilation is finished. Available only with -funit-at-a-time. */
669 struct GTY(()) cgraph_global_info {
670 /* For inline clones this points to the function they will be
671 inlined into. */
672 cgraph_node *inlined_to;
675 /* Represent which DECL tree (or reference to such tree)
676 will be replaced by another tree while versioning. */
677 struct GTY(()) ipa_replace_map
679 /* The tree that will be replaced. */
680 tree old_tree;
681 /* The new (replacing) tree. */
682 tree new_tree;
683 /* Parameter number to replace, when old_tree is NULL. */
684 int parm_num;
685 /* True when a substitution should be done, false otherwise. */
686 bool replace_p;
687 /* True when we replace a reference to old_tree. */
688 bool ref_p;
691 struct GTY(()) cgraph_clone_info
693 vec<ipa_replace_map *, va_gc> *tree_map;
694 bitmap args_to_skip;
695 bitmap combined_args_to_skip;
698 enum cgraph_simd_clone_arg_type
700 SIMD_CLONE_ARG_TYPE_VECTOR,
701 SIMD_CLONE_ARG_TYPE_UNIFORM,
702 /* These are only for integer/pointer arguments passed by value. */
703 SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP,
704 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP,
705 /* These 6 are only for reference type arguments or arguments passed
706 by reference. */
707 SIMD_CLONE_ARG_TYPE_LINEAR_REF_CONSTANT_STEP,
708 SIMD_CLONE_ARG_TYPE_LINEAR_REF_VARIABLE_STEP,
709 SIMD_CLONE_ARG_TYPE_LINEAR_UVAL_CONSTANT_STEP,
710 SIMD_CLONE_ARG_TYPE_LINEAR_UVAL_VARIABLE_STEP,
711 SIMD_CLONE_ARG_TYPE_LINEAR_VAL_CONSTANT_STEP,
712 SIMD_CLONE_ARG_TYPE_LINEAR_VAL_VARIABLE_STEP,
713 SIMD_CLONE_ARG_TYPE_MASK
716 /* Function arguments in the original function of a SIMD clone.
717 Supplementary data for `struct simd_clone'. */
719 struct GTY(()) cgraph_simd_clone_arg {
720 /* Original function argument as it originally existed in
721 DECL_ARGUMENTS. */
722 tree orig_arg;
724 /* orig_arg's function (or for extern functions type from
725 TYPE_ARG_TYPES). */
726 tree orig_type;
728 /* If argument is a vector, this holds the vector version of
729 orig_arg that after adjusting the argument types will live in
730 DECL_ARGUMENTS. Otherwise, this is NULL.
732 This basically holds:
733 vector(simdlen) __typeof__(orig_arg) new_arg. */
734 tree vector_arg;
736 /* vector_arg's type (or for extern functions new vector type. */
737 tree vector_type;
739 /* If argument is a vector, this holds the array where the simd
740 argument is held while executing the simd clone function. This
741 is a local variable in the cloned function. Its content is
742 copied from vector_arg upon entry to the clone.
744 This basically holds:
745 __typeof__(orig_arg) simd_array[simdlen]. */
746 tree simd_array;
748 /* A SIMD clone's argument can be either linear (constant or
749 variable), uniform, or vector. */
750 enum cgraph_simd_clone_arg_type arg_type;
752 /* For arg_type SIMD_CLONE_ARG_TYPE_LINEAR_*CONSTANT_STEP this is
753 the constant linear step, if arg_type is
754 SIMD_CLONE_ARG_TYPE_LINEAR_*VARIABLE_STEP, this is index of
755 the uniform argument holding the step, otherwise 0. */
756 HOST_WIDE_INT linear_step;
758 /* Variable alignment if available, otherwise 0. */
759 unsigned int alignment;
762 /* Specific data for a SIMD function clone. */
764 struct GTY(()) cgraph_simd_clone {
765 /* Number of words in the SIMD lane associated with this clone. */
766 unsigned int simdlen;
768 /* Number of annotated function arguments in `args'. This is
769 usually the number of named arguments in FNDECL. */
770 unsigned int nargs;
772 /* Max hardware vector size in bits for integral vectors. */
773 unsigned int vecsize_int;
775 /* Max hardware vector size in bits for floating point vectors. */
776 unsigned int vecsize_float;
778 /* Machine mode of the mask argument(s), if they are to be passed
779 as bitmasks in integer argument(s). VOIDmode if masks are passed
780 as vectors of characteristic type. */
781 machine_mode mask_mode;
783 /* The mangling character for a given vector size. This is used
784 to determine the ISA mangling bit as specified in the Intel
785 Vector ABI. */
786 unsigned char vecsize_mangle;
788 /* True if this is the masked, in-branch version of the clone,
789 otherwise false. */
790 unsigned int inbranch : 1;
792 /* True if this is a Cilk Plus variant. */
793 unsigned int cilk_elemental : 1;
795 /* Doubly linked list of SIMD clones. */
796 cgraph_node *prev_clone, *next_clone;
798 /* Original cgraph node the SIMD clones were created for. */
799 cgraph_node *origin;
801 /* Annotated function arguments for the original function. */
802 cgraph_simd_clone_arg GTY((length ("%h.nargs"))) args[1];
805 /* Function Multiversioning info. */
806 struct GTY((for_user)) cgraph_function_version_info {
807 /* The cgraph_node for which the function version info is stored. */
808 cgraph_node *this_node;
809 /* Chains all the semantically identical function versions. The
810 first function in this chain is the version_info node of the
811 default function. */
812 cgraph_function_version_info *prev;
813 /* If this version node corresponds to a dispatcher for function
814 versions, this points to the version info node of the default
815 function, the first node in the chain. */
816 cgraph_function_version_info *next;
817 /* If this node corresponds to a function version, this points
818 to the dispatcher function decl, which is the function that must
819 be called to execute the right function version at run-time.
821 If this cgraph node is a dispatcher (if dispatcher_function is
822 true, in the cgraph_node struct) for function versions, this
823 points to resolver function, which holds the function body of the
824 dispatcher. The dispatcher decl is an alias to the resolver
825 function decl. */
826 tree dispatcher_resolver;
829 #define DEFCIFCODE(code, type, string) CIF_ ## code,
830 /* Reasons for inlining failures. */
832 enum cgraph_inline_failed_t {
833 #include "cif-code.def"
834 CIF_N_REASONS
837 enum cgraph_inline_failed_type_t
839 CIF_FINAL_NORMAL = 0,
840 CIF_FINAL_ERROR
843 struct cgraph_edge;
845 struct cgraph_edge_hasher : ggc_ptr_hash<cgraph_edge>
847 typedef gimple *compare_type;
849 static hashval_t hash (cgraph_edge *);
850 static hashval_t hash (gimple *);
851 static bool equal (cgraph_edge *, gimple *);
854 /* The cgraph data structure.
855 Each function decl has assigned cgraph_node listing callees and callers. */
857 struct GTY((tag ("SYMTAB_FUNCTION"))) cgraph_node : public symtab_node {
858 public:
859 /* Remove the node from cgraph and all inline clones inlined into it.
860 Skip however removal of FORBIDDEN_NODE and return true if it needs to be
861 removed. This allows to call the function from outer loop walking clone
862 tree. */
863 bool remove_symbol_and_inline_clones (cgraph_node *forbidden_node = NULL);
865 /* Record all references from cgraph_node that are taken
866 in statement STMT. */
867 void record_stmt_references (gimple *stmt);
869 /* Like cgraph_set_call_stmt but walk the clone tree and update all
870 clones sharing the same function body.
871 When WHOLE_SPECULATIVE_EDGES is true, all three components of
872 speculative edge gets updated. Otherwise we update only direct
873 call. */
874 void set_call_stmt_including_clones (gimple *old_stmt, gcall *new_stmt,
875 bool update_speculative = true);
877 /* Walk the alias chain to return the function cgraph_node is alias of.
878 Walk through thunk, too.
879 When AVAILABILITY is non-NULL, get minimal availability in the chain.
880 When REF is non-NULL, assume that reference happens in symbol REF
881 when determining the availability. */
882 cgraph_node *function_symbol (enum availability *avail = NULL,
883 struct symtab_node *ref = NULL);
885 /* Walk the alias chain to return the function cgraph_node is alias of.
886 Walk through non virtual thunks, too. Thus we return either a function
887 or a virtual thunk node.
888 When AVAILABILITY is non-NULL, get minimal availability in the chain.
889 When REF is non-NULL, assume that reference happens in symbol REF
890 when determining the availability. */
891 cgraph_node *function_or_virtual_thunk_symbol
892 (enum availability *avail = NULL,
893 struct symtab_node *ref = NULL);
895 /* Create node representing clone of N executed COUNT times. Decrease
896 the execution counts from original node too.
897 The new clone will have decl set to DECL that may or may not be the same
898 as decl of N.
900 When UPDATE_ORIGINAL is true, the counts are subtracted from the original
901 function's profile to reflect the fact that part of execution is handled
902 by node.
903 When CALL_DUPLICATOIN_HOOK is true, the ipa passes are acknowledged about
904 the new clone. Otherwise the caller is responsible for doing so later.
906 If the new node is being inlined into another one, NEW_INLINED_TO should be
907 the outline function the new one is (even indirectly) inlined to.
908 All hooks will see this in node's global.inlined_to, when invoked.
909 Can be NULL if the node is not inlined. SUFFIX is string that is appended
910 to the original name. */
911 cgraph_node *create_clone (tree decl, gcov_type count, int freq,
912 bool update_original,
913 vec<cgraph_edge *> redirect_callers,
914 bool call_duplication_hook,
915 cgraph_node *new_inlined_to,
916 bitmap args_to_skip, const char *suffix = NULL);
918 /* Create callgraph node clone with new declaration. The actual body will
919 be copied later at compilation stage. */
920 cgraph_node *create_virtual_clone (vec<cgraph_edge *> redirect_callers,
921 vec<ipa_replace_map *, va_gc> *tree_map,
922 bitmap args_to_skip, const char * suffix);
924 /* cgraph node being removed from symbol table; see if its entry can be
925 replaced by other inline clone. */
926 cgraph_node *find_replacement (void);
928 /* Create a new cgraph node which is the new version of
929 callgraph node. REDIRECT_CALLERS holds the callers
930 edges which should be redirected to point to
931 NEW_VERSION. ALL the callees edges of the node
932 are cloned to the new version node. Return the new
933 version node.
935 If non-NULL BLOCK_TO_COPY determine what basic blocks
936 was copied to prevent duplications of calls that are dead
937 in the clone.
939 SUFFIX is string that is appended to the original name. */
941 cgraph_node *create_version_clone (tree new_decl,
942 vec<cgraph_edge *> redirect_callers,
943 bitmap bbs_to_copy,
944 const char *suffix = NULL);
946 /* Perform function versioning.
947 Function versioning includes copying of the tree and
948 a callgraph update (creating a new cgraph node and updating
949 its callees and callers).
951 REDIRECT_CALLERS varray includes the edges to be redirected
952 to the new version.
954 TREE_MAP is a mapping of tree nodes we want to replace with
955 new ones (according to results of prior analysis).
957 If non-NULL ARGS_TO_SKIP determine function parameters to remove
958 from new version.
959 If SKIP_RETURN is true, the new version will return void.
960 If non-NULL BLOCK_TO_COPY determine what basic blocks to copy.
961 If non_NULL NEW_ENTRY determine new entry BB of the clone.
963 Return the new version's cgraph node. */
964 cgraph_node *create_version_clone_with_body
965 (vec<cgraph_edge *> redirect_callers,
966 vec<ipa_replace_map *, va_gc> *tree_map, bitmap args_to_skip,
967 bool skip_return, bitmap bbs_to_copy, basic_block new_entry_block,
968 const char *clone_name);
970 /* Insert a new cgraph_function_version_info node into cgraph_fnver_htab
971 corresponding to cgraph_node. */
972 cgraph_function_version_info *insert_new_function_version (void);
974 /* Get the cgraph_function_version_info node corresponding to node. */
975 cgraph_function_version_info *function_version (void);
977 /* Discover all functions and variables that are trivially needed, analyze
978 them as well as all functions and variables referred by them */
979 void analyze (void);
981 /* Add thunk alias into callgraph. The alias declaration is ALIAS and it
982 aliases DECL with an adjustments made into the first parameter.
983 See comments in thunk_adjust for detail on the parameters. */
984 cgraph_node * create_thunk (tree alias, tree, bool this_adjusting,
985 HOST_WIDE_INT fixed_offset,
986 HOST_WIDE_INT virtual_value,
987 tree virtual_offset,
988 tree real_alias);
991 /* Return node that alias is aliasing. */
992 inline cgraph_node *get_alias_target (void);
994 /* Given function symbol, walk the alias chain to return the function node
995 is alias of. Do not walk through thunks.
996 When AVAILABILITY is non-NULL, get minimal availability in the chain.
997 When REF is non-NULL, assume that reference happens in symbol REF
998 when determining the availability. */
1000 cgraph_node *ultimate_alias_target (availability *availability = NULL,
1001 symtab_node *ref = NULL);
1003 /* Expand thunk NODE to gimple if possible.
1004 When FORCE_GIMPLE_THUNK is true, gimple thunk is created and
1005 no assembler is produced.
1006 When OUTPUT_ASM_THUNK is true, also produce assembler for
1007 thunks that are not lowered. */
1008 bool expand_thunk (bool output_asm_thunks, bool force_gimple_thunk);
1010 /* Call expand_thunk on all callers that are thunks and analyze those
1011 nodes that were expanded. */
1012 void expand_all_artificial_thunks ();
1014 /* Assemble thunks and aliases associated to node. */
1015 void assemble_thunks_and_aliases (void);
1017 /* Expand function specified by node. */
1018 void expand (void);
1020 /* As an GCC extension we allow redefinition of the function. The
1021 semantics when both copies of bodies differ is not well defined.
1022 We replace the old body with new body so in unit at a time mode
1023 we always use new body, while in normal mode we may end up with
1024 old body inlined into some functions and new body expanded and
1025 inlined in others. */
1026 void reset (void);
1028 /* Creates a wrapper from cgraph_node to TARGET node. Thunk is used for this
1029 kind of wrapper method. */
1030 void create_wrapper (cgraph_node *target);
1032 /* Verify cgraph nodes of the cgraph node. */
1033 void DEBUG_FUNCTION verify_node (void);
1035 /* Remove function from symbol table. */
1036 void remove (void);
1038 /* Dump call graph node to file F. */
1039 void dump (FILE *f);
1041 /* Dump call graph node to stderr. */
1042 void DEBUG_FUNCTION debug (void);
1044 /* When doing LTO, read cgraph_node's body from disk if it is not already
1045 present. */
1046 bool get_untransformed_body (void);
1048 /* Prepare function body. When doing LTO, read cgraph_node's body from disk
1049 if it is not already present. When some IPA transformations are scheduled,
1050 apply them. */
1051 bool get_body (void);
1053 /* Release memory used to represent body of function.
1054 Use this only for functions that are released before being translated to
1055 target code (i.e. RTL). Functions that are compiled to RTL and beyond
1056 are free'd in final.c via free_after_compilation(). */
1057 void release_body (bool keep_arguments = false);
1059 /* Return the DECL_STRUCT_FUNCTION of the function. */
1060 struct function *get_fun (void);
1062 /* cgraph_node is no longer nested function; update cgraph accordingly. */
1063 void unnest (void);
1065 /* Bring cgraph node local. */
1066 void make_local (void);
1068 /* Likewise indicate that a node is having address taken. */
1069 void mark_address_taken (void);
1071 /* Set fialization priority to PRIORITY. */
1072 void set_fini_priority (priority_type priority);
1074 /* Return the finalization priority. */
1075 priority_type get_fini_priority (void);
1077 /* Create edge from a given function to CALLEE in the cgraph. */
1078 cgraph_edge *create_edge (cgraph_node *callee,
1079 gcall *call_stmt, gcov_type count,
1080 int freq);
1082 /* Create an indirect edge with a yet-undetermined callee where the call
1083 statement destination is a formal parameter of the caller with index
1084 PARAM_INDEX. */
1085 cgraph_edge *create_indirect_edge (gcall *call_stmt, int ecf_flags,
1086 gcov_type count, int freq,
1087 bool compute_indirect_info = true);
1089 /* Like cgraph_create_edge walk the clone tree and update all clones sharing
1090 same function body. If clones already have edge for OLD_STMT; only
1091 update the edge same way as cgraph_set_call_stmt_including_clones does. */
1092 void create_edge_including_clones (cgraph_node *callee,
1093 gimple *old_stmt, gcall *stmt,
1094 gcov_type count,
1095 int freq,
1096 cgraph_inline_failed_t reason);
1098 /* Return the callgraph edge representing the GIMPLE_CALL statement
1099 CALL_STMT. */
1100 cgraph_edge *get_edge (gimple *call_stmt);
1102 /* Collect all callers of cgraph_node and its aliases that are known to lead
1103 to NODE (i.e. are not overwritable) and that are not thunks. */
1104 vec<cgraph_edge *> collect_callers (void);
1106 /* Remove all callers from the node. */
1107 void remove_callers (void);
1109 /* Remove all callees from the node. */
1110 void remove_callees (void);
1112 /* Return function availability. See cgraph.h for description of individual
1113 return values. */
1114 enum availability get_availability (symtab_node *ref = NULL);
1116 /* Set TREE_NOTHROW on cgraph_node's decl and on aliases of the node
1117 if any to NOTHROW. */
1118 bool set_nothrow_flag (bool nothrow);
1120 /* If SET_CONST is true, mark function, aliases and thunks to be ECF_CONST.
1121 If SET_CONST if false, clear the flag.
1123 When setting the flag be careful about possible interposition and
1124 do not set the flag for functions that can be interposet and set pure
1125 flag for functions that can bind to other definition.
1127 Return true if any change was done. */
1129 bool set_const_flag (bool set_const, bool looping);
1131 /* Set DECL_PURE_P on cgraph_node's decl and on aliases of the node
1132 if any to PURE.
1134 When setting the flag, be careful about possible interposition.
1135 Return true if any change was done. */
1137 bool set_pure_flag (bool pure, bool looping);
1139 /* Call callback on function and aliases associated to the function.
1140 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1141 skipped. */
1143 bool call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
1144 void *),
1145 void *data, bool include_overwritable);
1147 /* Call callback on cgraph_node, thunks and aliases associated to NODE.
1148 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1149 skipped. When EXCLUDE_VIRTUAL_THUNKS is true, virtual thunks are
1150 skipped. */
1151 bool call_for_symbol_thunks_and_aliases (bool (*callback) (cgraph_node *node,
1152 void *data),
1153 void *data,
1154 bool include_overwritable,
1155 bool exclude_virtual_thunks = false);
1157 /* Likewise indicate that a node is needed, i.e. reachable via some
1158 external means. */
1159 inline void mark_force_output (void);
1161 /* Return true when function can be marked local. */
1162 bool local_p (void);
1164 /* Return true if cgraph_node can be made local for API change.
1165 Extern inline functions and C++ COMDAT functions can be made local
1166 at the expense of possible code size growth if function is used in multiple
1167 compilation units. */
1168 bool can_be_local_p (void);
1170 /* Return true when cgraph_node can not return or throw and thus
1171 it is safe to ignore its side effects for IPA analysis. */
1172 bool cannot_return_p (void);
1174 /* Return true when function cgraph_node and all its aliases are only called
1175 directly.
1176 i.e. it is not externally visible, address was not taken and
1177 it is not used in any other non-standard way. */
1178 bool only_called_directly_p (void);
1180 /* Return true when function is only called directly or it has alias.
1181 i.e. it is not externally visible, address was not taken and
1182 it is not used in any other non-standard way. */
1183 inline bool only_called_directly_or_aliased_p (void);
1185 /* Return true when function cgraph_node can be expected to be removed
1186 from program when direct calls in this compilation unit are removed.
1188 As a special case COMDAT functions are
1189 cgraph_can_remove_if_no_direct_calls_p while the are not
1190 cgraph_only_called_directly_p (it is possible they are called from other
1191 unit)
1193 This function behaves as cgraph_only_called_directly_p because eliminating
1194 all uses of COMDAT function does not make it necessarily disappear from
1195 the program unless we are compiling whole program or we do LTO. In this
1196 case we know we win since dynamic linking will not really discard the
1197 linkonce section.
1199 If WILL_INLINE is true, assume that function will be inlined into all the
1200 direct calls. */
1201 bool will_be_removed_from_program_if_no_direct_calls_p
1202 (bool will_inline = false);
1204 /* Return true when function can be removed from callgraph
1205 if all direct calls and references are eliminated. The function does
1206 not take into account comdat groups. */
1207 bool can_remove_if_no_direct_calls_and_refs_p (void);
1209 /* Return true when function cgraph_node and its aliases can be removed from
1210 callgraph if all direct calls are eliminated.
1211 If WILL_INLINE is true, assume that function will be inlined into all the
1212 direct calls. */
1213 bool can_remove_if_no_direct_calls_p (bool will_inline = false);
1215 /* Return true when callgraph node is a function with Gimple body defined
1216 in current unit. Functions can also be define externally or they
1217 can be thunks with no Gimple representation.
1219 Note that at WPA stage, the function body may not be present in memory. */
1220 inline bool has_gimple_body_p (void);
1222 /* Return true if function should be optimized for size. */
1223 bool optimize_for_size_p (void);
1225 /* Dump the callgraph to file F. */
1226 static void dump_cgraph (FILE *f);
1228 /* Dump the call graph to stderr. */
1229 static inline
1230 void debug_cgraph (void)
1232 dump_cgraph (stderr);
1235 /* Record that DECL1 and DECL2 are semantically identical function
1236 versions. */
1237 static void record_function_versions (tree decl1, tree decl2);
1239 /* Remove the cgraph_function_version_info and cgraph_node for DECL. This
1240 DECL is a duplicate declaration. */
1241 static void delete_function_version (tree decl);
1243 /* Add the function FNDECL to the call graph.
1244 Unlike finalize_function, this function is intended to be used
1245 by middle end and allows insertion of new function at arbitrary point
1246 of compilation. The function can be either in high, low or SSA form
1247 GIMPLE.
1249 The function is assumed to be reachable and have address taken (so no
1250 API breaking optimizations are performed on it).
1252 Main work done by this function is to enqueue the function for later
1253 processing to avoid need the passes to be re-entrant. */
1254 static void add_new_function (tree fndecl, bool lowered);
1256 /* Return callgraph node for given symbol and check it is a function. */
1257 static inline cgraph_node *get (const_tree decl)
1259 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL);
1260 return dyn_cast <cgraph_node *> (symtab_node::get (decl));
1263 /* DECL has been parsed. Take it, queue it, compile it at the whim of the
1264 logic in effect. If NO_COLLECT is true, then our caller cannot stand to
1265 have the garbage collector run at the moment. We would need to either
1266 create a new GC context, or just not compile right now. */
1267 static void finalize_function (tree, bool);
1269 /* Return cgraph node assigned to DECL. Create new one when needed. */
1270 static cgraph_node * create (tree decl);
1272 /* Try to find a call graph node for declaration DECL and if it does not
1273 exist or if it corresponds to an inline clone, create a new one. */
1274 static cgraph_node * get_create (tree);
1276 /* Return local info for the compiled function. */
1277 static cgraph_local_info *local_info (tree decl);
1279 /* Return local info for the compiled function. */
1280 static struct cgraph_rtl_info *rtl_info (tree);
1282 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
1283 Return NULL if there's no such node. */
1284 static cgraph_node *get_for_asmname (tree asmname);
1286 /* Attempt to mark ALIAS as an alias to DECL. Return alias node if
1287 successful and NULL otherwise.
1288 Same body aliases are output whenever the body of DECL is output,
1289 and cgraph_node::get (ALIAS) transparently
1290 returns cgraph_node::get (DECL). */
1291 static cgraph_node * create_same_body_alias (tree alias, tree decl);
1293 /* Verify whole cgraph structure. */
1294 static void DEBUG_FUNCTION verify_cgraph_nodes (void);
1296 /* Verify cgraph, if consistency checking is enabled. */
1297 static inline void checking_verify_cgraph_nodes (void);
1299 /* Worker to bring NODE local. */
1300 static bool make_local (cgraph_node *node, void *);
1302 /* Mark ALIAS as an alias to DECL. DECL_NODE is cgraph node representing
1303 the function body is associated
1304 with (not necessarily cgraph_node (DECL). */
1305 static cgraph_node *create_alias (tree alias, tree target);
1307 /* Return true if NODE has thunk. */
1308 static bool has_thunk_p (cgraph_node *node, void *);
1310 cgraph_edge *callees;
1311 cgraph_edge *callers;
1312 /* List of edges representing indirect calls with a yet undetermined
1313 callee. */
1314 cgraph_edge *indirect_calls;
1315 /* For nested functions points to function the node is nested in. */
1316 cgraph_node *origin;
1317 /* Points to first nested function, if any. */
1318 cgraph_node *nested;
1319 /* Pointer to the next function with same origin, if any. */
1320 cgraph_node *next_nested;
1321 /* Pointer to the next clone. */
1322 cgraph_node *next_sibling_clone;
1323 cgraph_node *prev_sibling_clone;
1324 cgraph_node *clones;
1325 cgraph_node *clone_of;
1326 /* If instrumentation_clone is 1 then instrumented_version points
1327 to the original function used to make instrumented version.
1328 Otherwise points to instrumented version of the function. */
1329 cgraph_node *instrumented_version;
1330 /* If instrumentation_clone is 1 then orig_decl is the original
1331 function declaration. */
1332 tree orig_decl;
1333 /* For functions with many calls sites it holds map from call expression
1334 to the edge to speed up cgraph_edge function. */
1335 hash_table<cgraph_edge_hasher> *GTY(()) call_site_hash;
1336 /* Declaration node used to be clone of. */
1337 tree former_clone_of;
1339 /* If this is a SIMD clone, this points to the SIMD specific
1340 information for it. */
1341 cgraph_simd_clone *simdclone;
1342 /* If this function has SIMD clones, this points to the first clone. */
1343 cgraph_node *simd_clones;
1345 /* Interprocedural passes scheduled to have their transform functions
1346 applied next time we execute local pass on them. We maintain it
1347 per-function in order to allow IPA passes to introduce new functions. */
1348 vec<ipa_opt_pass> GTY((skip)) ipa_transforms_to_apply;
1350 cgraph_local_info local;
1351 cgraph_global_info global;
1352 struct cgraph_rtl_info *rtl;
1353 cgraph_clone_info clone;
1354 cgraph_thunk_info thunk;
1356 /* Expected number of executions: calculated in profile.c. */
1357 gcov_type count;
1358 /* How to scale counts at materialization time; used to merge
1359 LTO units with different number of profile runs. */
1360 int count_materialization_scale;
1361 /* Unique id of the node. */
1362 int uid;
1363 /* Summary unique id of the node. */
1364 int summary_uid;
1365 /* ID assigned by the profiling. */
1366 unsigned int profile_id;
1367 /* Time profiler: first run of function. */
1368 int tp_first_run;
1370 /* Set when decl is an abstract function pointed to by the
1371 ABSTRACT_DECL_ORIGIN of a reachable function. */
1372 unsigned used_as_abstract_origin : 1;
1373 /* Set once the function is lowered (i.e. its CFG is built). */
1374 unsigned lowered : 1;
1375 /* Set once the function has been instantiated and its callee
1376 lists created. */
1377 unsigned process : 1;
1378 /* How commonly executed the node is. Initialized during branch
1379 probabilities pass. */
1380 ENUM_BITFIELD (node_frequency) frequency : 2;
1381 /* True when function can only be called at startup (from static ctor). */
1382 unsigned only_called_at_startup : 1;
1383 /* True when function can only be called at startup (from static dtor). */
1384 unsigned only_called_at_exit : 1;
1385 /* True when function is the transactional clone of a function which
1386 is called only from inside transactions. */
1387 /* ?? We should be able to remove this. We have enough bits in
1388 cgraph to calculate it. */
1389 unsigned tm_clone : 1;
1390 /* True if this decl is a dispatcher for function versions. */
1391 unsigned dispatcher_function : 1;
1392 /* True if this decl calls a COMDAT-local function. This is set up in
1393 compute_inline_parameters and inline_call. */
1394 unsigned calls_comdat_local : 1;
1395 /* True if node has been created by merge operation in IPA-ICF. */
1396 unsigned icf_merged: 1;
1397 /* True when function is clone created for Pointer Bounds Checker
1398 instrumentation. */
1399 unsigned instrumentation_clone : 1;
1400 /* True if call to node can't result in a call to free, munmap or
1401 other operation that could make previously non-trapping memory
1402 accesses trapping. */
1403 unsigned nonfreeing_fn : 1;
1404 /* True if there was multiple COMDAT bodies merged by lto-symtab. */
1405 unsigned merged_comdat : 1;
1406 /* True if function was created to be executed in parallel. */
1407 unsigned parallelized_function : 1;
1408 /* True if function is part split out by ipa-split. */
1409 unsigned split_part : 1;
1410 /* True if the function appears as possible target of indirect call. */
1411 unsigned indirect_call_target : 1;
1413 private:
1414 /* Worker for call_for_symbol_and_aliases. */
1415 bool call_for_symbol_and_aliases_1 (bool (*callback) (cgraph_node *,
1416 void *),
1417 void *data, bool include_overwritable);
1420 /* A cgraph node set is a collection of cgraph nodes. A cgraph node
1421 can appear in multiple sets. */
1422 struct cgraph_node_set_def
1424 hash_map<cgraph_node *, size_t> *map;
1425 vec<cgraph_node *> nodes;
1428 typedef cgraph_node_set_def *cgraph_node_set;
1429 typedef struct varpool_node_set_def *varpool_node_set;
1431 class varpool_node;
1433 /* A varpool node set is a collection of varpool nodes. A varpool node
1434 can appear in multiple sets. */
1435 struct varpool_node_set_def
1437 hash_map<varpool_node *, size_t> * map;
1438 vec<varpool_node *> nodes;
1441 /* Iterator structure for cgraph node sets. */
1442 struct cgraph_node_set_iterator
1444 cgraph_node_set set;
1445 unsigned index;
1448 /* Iterator structure for varpool node sets. */
1449 struct varpool_node_set_iterator
1451 varpool_node_set set;
1452 unsigned index;
1455 /* Context of polymorphic call. It represent information about the type of
1456 instance that may reach the call. This is used by ipa-devirt walkers of the
1457 type inheritance graph. */
1459 class GTY(()) ipa_polymorphic_call_context {
1460 public:
1461 /* The called object appears in an object of type OUTER_TYPE
1462 at offset OFFSET. When information is not 100% reliable, we
1463 use SPECULATIVE_OUTER_TYPE and SPECULATIVE_OFFSET. */
1464 HOST_WIDE_INT offset;
1465 HOST_WIDE_INT speculative_offset;
1466 tree outer_type;
1467 tree speculative_outer_type;
1468 /* True if outer object may be in construction or destruction. */
1469 unsigned maybe_in_construction : 1;
1470 /* True if outer object may be of derived type. */
1471 unsigned maybe_derived_type : 1;
1472 /* True if speculative outer object may be of derived type. We always
1473 speculate that construction does not happen. */
1474 unsigned speculative_maybe_derived_type : 1;
1475 /* True if the context is invalid and all calls should be redirected
1476 to BUILTIN_UNREACHABLE. */
1477 unsigned invalid : 1;
1478 /* True if the outer type is dynamic. */
1479 unsigned dynamic : 1;
1481 /* Build empty "I know nothing" context. */
1482 ipa_polymorphic_call_context ();
1483 /* Build polymorphic call context for indirect call E. */
1484 ipa_polymorphic_call_context (cgraph_edge *e);
1485 /* Build polymorphic call context for IP invariant CST.
1486 If specified, OTR_TYPE specify the type of polymorphic call
1487 that takes CST+OFFSET as a prameter. */
1488 ipa_polymorphic_call_context (tree cst, tree otr_type = NULL,
1489 HOST_WIDE_INT offset = 0);
1490 /* Build context for pointer REF contained in FNDECL at statement STMT.
1491 if INSTANCE is non-NULL, return pointer to the object described by
1492 the context. */
1493 ipa_polymorphic_call_context (tree fndecl, tree ref, gimple *stmt,
1494 tree *instance = NULL);
1496 /* Look for vtable stores or constructor calls to work out dynamic type
1497 of memory location. */
1498 bool get_dynamic_type (tree, tree, tree, gimple *);
1500 /* Make context non-speculative. */
1501 void clear_speculation ();
1503 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
1504 NULL, the context is set to dummy "I know nothing" setting. */
1505 void clear_outer_type (tree otr_type = NULL);
1507 /* Walk container types and modify context to point to actual class
1508 containing OTR_TYPE (if non-NULL) as base class.
1509 Return true if resulting context is valid.
1511 When CONSIDER_PLACEMENT_NEW is false, reject contexts that may be made
1512 valid only via alocation of new polymorphic type inside by means
1513 of placement new.
1515 When CONSIDER_BASES is false, only look for actual fields, not base types
1516 of TYPE. */
1517 bool restrict_to_inner_class (tree otr_type,
1518 bool consider_placement_new = true,
1519 bool consider_bases = true);
1521 /* Adjust all offsets in contexts by given number of bits. */
1522 void offset_by (HOST_WIDE_INT);
1523 /* Use when we can not track dynamic type change. This speculatively assume
1524 type change is not happening. */
1525 void possible_dynamic_type_change (bool, tree otr_type = NULL);
1526 /* Assume that both THIS and a given context is valid and strenghten THIS
1527 if possible. Return true if any strenghtening was made.
1528 If actual type the context is being used in is known, OTR_TYPE should be
1529 set accordingly. This improves quality of combined result. */
1530 bool combine_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1531 bool meet_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1533 /* Return TRUE if context is fully useless. */
1534 bool useless_p () const;
1535 /* Return TRUE if this context conveys the same information as X. */
1536 bool equal_to (const ipa_polymorphic_call_context &x) const;
1538 /* Dump human readable context to F. If NEWLINE is true, it will be
1539 terminated by a newline. */
1540 void dump (FILE *f, bool newline = true) const;
1541 void DEBUG_FUNCTION debug () const;
1543 /* LTO streaming. */
1544 void stream_out (struct output_block *) const;
1545 void stream_in (struct lto_input_block *, struct data_in *data_in);
1547 private:
1548 bool combine_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1549 bool meet_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1550 void set_by_decl (tree, HOST_WIDE_INT);
1551 bool set_by_invariant (tree, tree, HOST_WIDE_INT);
1552 bool speculation_consistent_p (tree, HOST_WIDE_INT, bool, tree) const;
1553 void make_speculative (tree otr_type = NULL);
1556 /* Structure containing additional information about an indirect call. */
1558 struct GTY(()) cgraph_indirect_call_info
1560 /* When agg_content is set, an offset where the call pointer is located
1561 within the aggregate. */
1562 HOST_WIDE_INT offset;
1563 /* Context of the polymorphic call; use only when POLYMORPHIC flag is set. */
1564 ipa_polymorphic_call_context context;
1565 /* OBJ_TYPE_REF_TOKEN of a polymorphic call (if polymorphic is set). */
1566 HOST_WIDE_INT otr_token;
1567 /* Type of the object from OBJ_TYPE_REF_OBJECT. */
1568 tree otr_type;
1569 /* Index of the parameter that is called. */
1570 int param_index;
1571 /* ECF flags determined from the caller. */
1572 int ecf_flags;
1573 /* Profile_id of common target obtrained from profile. */
1574 int common_target_id;
1575 /* Probability that call will land in function with COMMON_TARGET_ID. */
1576 int common_target_probability;
1578 /* Set when the call is a virtual call with the parameter being the
1579 associated object pointer rather than a simple direct call. */
1580 unsigned polymorphic : 1;
1581 /* Set when the call is a call of a pointer loaded from contents of an
1582 aggregate at offset. */
1583 unsigned agg_contents : 1;
1584 /* Set when this is a call through a member pointer. */
1585 unsigned member_ptr : 1;
1586 /* When the agg_contents bit is set, this one determines whether the
1587 destination is loaded from a parameter passed by reference. */
1588 unsigned by_ref : 1;
1589 /* When the agg_contents bit is set, this one determines whether we can
1590 deduce from the function body that the loaded value from the reference is
1591 never modified between the invocation of the function and the load
1592 point. */
1593 unsigned guaranteed_unmodified : 1;
1594 /* For polymorphic calls this specify whether the virtual table pointer
1595 may have changed in between function entry and the call. */
1596 unsigned vptr_changed : 1;
1599 struct GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller"),
1600 for_user)) cgraph_edge {
1601 friend class cgraph_node;
1603 /* Remove the edge in the cgraph. */
1604 void remove (void);
1606 /* Change field call_stmt of edge to NEW_STMT.
1607 If UPDATE_SPECULATIVE and E is any component of speculative
1608 edge, then update all components. */
1609 void set_call_stmt (gcall *new_stmt, bool update_speculative = true);
1611 /* Redirect callee of the edge to N. The function does not update underlying
1612 call expression. */
1613 void redirect_callee (cgraph_node *n);
1615 /* If the edge does not lead to a thunk, simply redirect it to N. Otherwise
1616 create one or more equivalent thunks for N and redirect E to the first in
1617 the chain. Note that it is then necessary to call
1618 n->expand_all_artificial_thunks once all callers are redirected. */
1619 void redirect_callee_duplicating_thunks (cgraph_node *n);
1621 /* Make an indirect edge with an unknown callee an ordinary edge leading to
1622 CALLEE. DELTA is an integer constant that is to be added to the this
1623 pointer (first parameter) to compensate for skipping
1624 a thunk adjustment. */
1625 cgraph_edge *make_direct (cgraph_node *callee);
1627 /* Turn edge into speculative call calling N2. Update
1628 the profile so the direct call is taken COUNT times
1629 with FREQUENCY. */
1630 cgraph_edge *make_speculative (cgraph_node *n2, gcov_type direct_count,
1631 int direct_frequency);
1633 /* Given speculative call edge, return all three components. */
1634 void speculative_call_info (cgraph_edge *&direct, cgraph_edge *&indirect,
1635 ipa_ref *&reference);
1637 /* Speculative call edge turned out to be direct call to CALLE_DECL.
1638 Remove the speculative call sequence and return edge representing the call.
1639 It is up to caller to redirect the call as appropriate. */
1640 cgraph_edge *resolve_speculation (tree callee_decl = NULL);
1642 /* If necessary, change the function declaration in the call statement
1643 associated with the edge so that it corresponds to the edge callee. */
1644 gimple *redirect_call_stmt_to_callee (void);
1646 /* Create clone of edge in the node N represented
1647 by CALL_EXPR the callgraph. */
1648 cgraph_edge * clone (cgraph_node *n, gcall *call_stmt, unsigned stmt_uid,
1649 gcov_type count_scale, int freq_scale, bool update_original);
1651 /* Verify edge count and frequency. */
1652 bool verify_count_and_frequency ();
1654 /* Return true when call of edge can not lead to return from caller
1655 and thus it is safe to ignore its side effects for IPA analysis
1656 when computing side effects of the caller. */
1657 bool cannot_lead_to_return_p (void);
1659 /* Return true when the edge represents a direct recursion. */
1660 bool recursive_p (void);
1662 /* Return true if the call can be hot. */
1663 bool maybe_hot_p (void);
1665 /* Rebuild cgraph edges for current function node. This needs to be run after
1666 passes that don't update the cgraph. */
1667 static unsigned int rebuild_edges (void);
1669 /* Rebuild cgraph references for current function node. This needs to be run
1670 after passes that don't update the cgraph. */
1671 static void rebuild_references (void);
1673 /* Expected number of executions: calculated in profile.c. */
1674 gcov_type count;
1675 cgraph_node *caller;
1676 cgraph_node *callee;
1677 cgraph_edge *prev_caller;
1678 cgraph_edge *next_caller;
1679 cgraph_edge *prev_callee;
1680 cgraph_edge *next_callee;
1681 gcall *call_stmt;
1682 /* Additional information about an indirect call. Not cleared when an edge
1683 becomes direct. */
1684 cgraph_indirect_call_info *indirect_info;
1685 PTR GTY ((skip (""))) aux;
1686 /* When equal to CIF_OK, inline this call. Otherwise, points to the
1687 explanation why function was not inlined. */
1688 enum cgraph_inline_failed_t inline_failed;
1689 /* The stmt_uid of call_stmt. This is used by LTO to recover the call_stmt
1690 when the function is serialized in. */
1691 unsigned int lto_stmt_uid;
1692 /* Expected frequency of executions within the function.
1693 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
1694 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
1695 int frequency;
1696 /* Unique id of the edge. */
1697 int uid;
1698 /* Whether this edge was made direct by indirect inlining. */
1699 unsigned int indirect_inlining_edge : 1;
1700 /* Whether this edge describes an indirect call with an undetermined
1701 callee. */
1702 unsigned int indirect_unknown_callee : 1;
1703 /* Whether this edge is still a dangling */
1704 /* True if the corresponding CALL stmt cannot be inlined. */
1705 unsigned int call_stmt_cannot_inline_p : 1;
1706 /* Can this call throw externally? */
1707 unsigned int can_throw_external : 1;
1708 /* Edges with SPECULATIVE flag represents indirect calls that was
1709 speculatively turned into direct (i.e. by profile feedback).
1710 The final code sequence will have form:
1712 if (call_target == expected_fn)
1713 expected_fn ();
1714 else
1715 call_target ();
1717 Every speculative call is represented by three components attached
1718 to a same call statement:
1719 1) a direct call (to expected_fn)
1720 2) an indirect call (to call_target)
1721 3) a IPA_REF_ADDR refrence to expected_fn.
1723 Optimizers may later redirect direct call to clone, so 1) and 3)
1724 do not need to necesarily agree with destination. */
1725 unsigned int speculative : 1;
1726 /* Set to true when caller is a constructor or destructor of polymorphic
1727 type. */
1728 unsigned in_polymorphic_cdtor : 1;
1730 /* Return true if call must bind to current definition. */
1731 bool binds_to_current_def_p ();
1733 private:
1734 /* Remove the edge from the list of the callers of the callee. */
1735 void remove_caller (void);
1737 /* Remove the edge from the list of the callees of the caller. */
1738 void remove_callee (void);
1740 /* Set callee N of call graph edge and add it to the corresponding set of
1741 callers. */
1742 void set_callee (cgraph_node *n);
1744 /* Output flags of edge to a file F. */
1745 void dump_edge_flags (FILE *f);
1747 /* Verify that call graph edge corresponds to DECL from the associated
1748 statement. Return true if the verification should fail. */
1749 bool verify_corresponds_to_fndecl (tree decl);
1752 #define CGRAPH_FREQ_BASE 1000
1753 #define CGRAPH_FREQ_MAX 100000
1755 /* The varpool data structure.
1756 Each static variable decl has assigned varpool_node. */
1758 class GTY((tag ("SYMTAB_VARIABLE"))) varpool_node : public symtab_node {
1759 public:
1760 /* Dump given varpool node to F. */
1761 void dump (FILE *f);
1763 /* Dump given varpool node to stderr. */
1764 void DEBUG_FUNCTION debug (void);
1766 /* Remove variable from symbol table. */
1767 void remove (void);
1769 /* Remove node initializer when it is no longer needed. */
1770 void remove_initializer (void);
1772 void analyze (void);
1774 /* Return variable availability. */
1775 availability get_availability (symtab_node *ref = NULL);
1777 /* When doing LTO, read variable's constructor from disk if
1778 it is not already present. */
1779 tree get_constructor (void);
1781 /* Return true if variable has constructor that can be used for folding. */
1782 bool ctor_useable_for_folding_p (void);
1784 /* For given variable pool node, walk the alias chain to return the function
1785 the variable is alias of. Do not walk through thunks.
1786 When AVAILABILITY is non-NULL, get minimal availability in the chain.
1787 When REF is non-NULL, assume that reference happens in symbol REF
1788 when determining the availability. */
1789 inline varpool_node *ultimate_alias_target
1790 (availability *availability = NULL, symtab_node *ref = NULL);
1792 /* Return node that alias is aliasing. */
1793 inline varpool_node *get_alias_target (void);
1795 /* Output one variable, if necessary. Return whether we output it. */
1796 bool assemble_decl (void);
1798 /* For variables in named sections make sure get_variable_section
1799 is called before we switch to those sections. Then section
1800 conflicts between read-only and read-only requiring relocations
1801 sections can be resolved. */
1802 void finalize_named_section_flags (void);
1804 /* Call calback on varpool symbol and aliases associated to varpool symbol.
1805 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1806 skipped. */
1807 bool call_for_symbol_and_aliases (bool (*callback) (varpool_node *, void *),
1808 void *data,
1809 bool include_overwritable);
1811 /* Return true when variable should be considered externally visible. */
1812 bool externally_visible_p (void);
1814 /* Return true when all references to variable must be visible
1815 in ipa_ref_list.
1816 i.e. if the variable is not externally visible or not used in some magic
1817 way (asm statement or such).
1818 The magic uses are all summarized in force_output flag. */
1819 inline bool all_refs_explicit_p ();
1821 /* Return true when variable can be removed from variable pool
1822 if all direct calls are eliminated. */
1823 inline bool can_remove_if_no_refs_p (void);
1825 /* Add the variable DECL to the varpool.
1826 Unlike finalize_decl function is intended to be used
1827 by middle end and allows insertion of new variable at arbitrary point
1828 of compilation. */
1829 static void add (tree decl);
1831 /* Return varpool node for given symbol and check it is a function. */
1832 static inline varpool_node *get (const_tree decl);
1834 /* Mark DECL as finalized. By finalizing the declaration, frontend instruct
1835 the middle end to output the variable to asm file, if needed or externally
1836 visible. */
1837 static void finalize_decl (tree decl);
1839 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1840 Extra name aliases are output whenever DECL is output. */
1841 static varpool_node * create_extra_name_alias (tree alias, tree decl);
1843 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1844 Extra name aliases are output whenever DECL is output. */
1845 static varpool_node * create_alias (tree, tree);
1847 /* Dump the variable pool to F. */
1848 static void dump_varpool (FILE *f);
1850 /* Dump the variable pool to stderr. */
1851 static void DEBUG_FUNCTION debug_varpool (void);
1853 /* Allocate new callgraph node and insert it into basic data structures. */
1854 static varpool_node *create_empty (void);
1856 /* Return varpool node assigned to DECL. Create new one when needed. */
1857 static varpool_node *get_create (tree decl);
1859 /* Given an assembler name, lookup node. */
1860 static varpool_node *get_for_asmname (tree asmname);
1862 /* Set when variable is scheduled to be assembled. */
1863 unsigned output : 1;
1865 /* Set when variable has statically initialized pointer
1866 or is a static bounds variable and needs initalization. */
1867 unsigned need_bounds_init : 1;
1869 /* Set if the variable is dynamically initialized, except for
1870 function local statics. */
1871 unsigned dynamically_initialized : 1;
1873 ENUM_BITFIELD(tls_model) tls_model : 3;
1875 /* Set if the variable is known to be used by single function only.
1876 This is computed by ipa_signle_use pass and used by late optimizations
1877 in places where optimization would be valid for local static variable
1878 if we did not do any inter-procedural code movement. */
1879 unsigned used_by_single_function : 1;
1881 private:
1882 /* Assemble thunks and aliases associated to varpool node. */
1883 void assemble_aliases (void);
1885 /* Worker for call_for_node_and_aliases. */
1886 bool call_for_symbol_and_aliases_1 (bool (*callback) (varpool_node *, void *),
1887 void *data,
1888 bool include_overwritable);
1891 /* Every top level asm statement is put into a asm_node. */
1893 struct GTY(()) asm_node {
1896 /* Next asm node. */
1897 asm_node *next;
1898 /* String for this asm node. */
1899 tree asm_str;
1900 /* Ordering of all cgraph nodes. */
1901 int order;
1904 /* Report whether or not THIS symtab node is a function, aka cgraph_node. */
1906 template <>
1907 template <>
1908 inline bool
1909 is_a_helper <cgraph_node *>::test (symtab_node *p)
1911 return p && p->type == SYMTAB_FUNCTION;
1914 /* Report whether or not THIS symtab node is a vriable, aka varpool_node. */
1916 template <>
1917 template <>
1918 inline bool
1919 is_a_helper <varpool_node *>::test (symtab_node *p)
1921 return p && p->type == SYMTAB_VARIABLE;
1924 /* Macros to access the next item in the list of free cgraph nodes and
1925 edges. */
1926 #define NEXT_FREE_NODE(NODE) dyn_cast<cgraph_node *> ((NODE)->next)
1927 #define SET_NEXT_FREE_NODE(NODE,NODE2) ((NODE))->next = NODE2
1928 #define NEXT_FREE_EDGE(EDGE) (EDGE)->prev_caller
1930 typedef void (*cgraph_edge_hook)(cgraph_edge *, void *);
1931 typedef void (*cgraph_node_hook)(cgraph_node *, void *);
1932 typedef void (*varpool_node_hook)(varpool_node *, void *);
1933 typedef void (*cgraph_2edge_hook)(cgraph_edge *, cgraph_edge *, void *);
1934 typedef void (*cgraph_2node_hook)(cgraph_node *, cgraph_node *, void *);
1936 struct cgraph_edge_hook_list;
1937 struct cgraph_node_hook_list;
1938 struct varpool_node_hook_list;
1939 struct cgraph_2edge_hook_list;
1940 struct cgraph_2node_hook_list;
1942 /* Map from a symbol to initialization/finalization priorities. */
1943 struct GTY(()) symbol_priority_map {
1944 priority_type init;
1945 priority_type fini;
1948 enum symtab_state
1950 /* Frontend is parsing and finalizing functions. */
1951 PARSING,
1952 /* Callgraph is being constructed. It is safe to add new functions. */
1953 CONSTRUCTION,
1954 /* Callgraph is being streamed-in at LTO time. */
1955 LTO_STREAMING,
1956 /* Callgraph is built and early IPA passes are being run. */
1957 IPA,
1958 /* Callgraph is built and all functions are transformed to SSA form. */
1959 IPA_SSA,
1960 /* All inline decisions are done; it is now possible to remove extern inline
1961 functions and virtual call targets. */
1962 IPA_SSA_AFTER_INLINING,
1963 /* Functions are now ordered and being passed to RTL expanders. */
1964 EXPANSION,
1965 /* All cgraph expansion is done. */
1966 FINISHED
1969 struct asmname_hasher : ggc_ptr_hash <symtab_node>
1971 typedef const_tree compare_type;
1973 static hashval_t hash (symtab_node *n);
1974 static bool equal (symtab_node *n, const_tree t);
1977 class GTY((tag ("SYMTAB"))) symbol_table
1979 public:
1980 friend class symtab_node;
1981 friend class cgraph_node;
1982 friend class cgraph_edge;
1984 symbol_table (): cgraph_max_summary_uid (1)
1988 /* Initialize callgraph dump file. */
1989 void initialize (void);
1991 /* Register a top-level asm statement ASM_STR. */
1992 inline asm_node *finalize_toplevel_asm (tree asm_str);
1994 /* Analyze the whole compilation unit once it is parsed completely. */
1995 void finalize_compilation_unit (void);
1997 /* C++ frontend produce same body aliases all over the place, even before PCH
1998 gets streamed out. It relies on us linking the aliases with their function
1999 in order to do the fixups, but ipa-ref is not PCH safe. Consequentely we
2000 first produce aliases without links, but once C++ FE is sure he won't sream
2001 PCH we build the links via this function. */
2002 void process_same_body_aliases (void);
2004 /* Perform simple optimizations based on callgraph. */
2005 void compile (void);
2007 /* Process CGRAPH_NEW_FUNCTIONS and perform actions necessary to add these
2008 functions into callgraph in a way so they look like ordinary reachable
2009 functions inserted into callgraph already at construction time. */
2010 void process_new_functions (void);
2012 /* Once all functions from compilation unit are in memory, produce all clones
2013 and update all calls. We might also do this on demand if we don't want to
2014 bring all functions to memory prior compilation, but current WHOPR
2015 implementation does that and it is bit easier to keep everything right
2016 in this order. */
2017 void materialize_all_clones (void);
2019 /* Register a symbol NODE. */
2020 inline void register_symbol (symtab_node *node);
2022 inline void
2023 clear_asm_symbols (void)
2025 asmnodes = NULL;
2026 asm_last_node = NULL;
2029 /* Perform reachability analysis and reclaim all unreachable nodes. */
2030 bool remove_unreachable_nodes (FILE *file);
2032 /* Optimization of function bodies might've rendered some variables as
2033 unnecessary so we want to avoid these from being compiled. Re-do
2034 reachability starting from variables that are either externally visible
2035 or was referred from the asm output routines. */
2036 void remove_unreferenced_decls (void);
2038 /* Unregister a symbol NODE. */
2039 inline void unregister (symtab_node *node);
2041 /* Allocate new callgraph node and insert it into basic data structures. */
2042 cgraph_node *create_empty (void);
2044 /* Release a callgraph NODE with UID and put in to the list
2045 of free nodes. */
2046 void release_symbol (cgraph_node *node, int uid);
2048 /* Output all variables enqueued to be assembled. */
2049 bool output_variables (void);
2051 /* Weakrefs may be associated to external decls and thus not output
2052 at expansion time. Emit all necessary aliases. */
2053 void output_weakrefs (void);
2055 /* Return first static symbol with definition. */
2056 inline symtab_node *first_symbol (void);
2058 /* Return first assembler symbol. */
2059 inline asm_node *
2060 first_asm_symbol (void)
2062 return asmnodes;
2065 /* Return first static symbol with definition. */
2066 inline symtab_node *first_defined_symbol (void);
2068 /* Return first variable. */
2069 inline varpool_node *first_variable (void);
2071 /* Return next variable after NODE. */
2072 inline varpool_node *next_variable (varpool_node *node);
2074 /* Return first static variable with initializer. */
2075 inline varpool_node *first_static_initializer (void);
2077 /* Return next static variable with initializer after NODE. */
2078 inline varpool_node *next_static_initializer (varpool_node *node);
2080 /* Return first static variable with definition. */
2081 inline varpool_node *first_defined_variable (void);
2083 /* Return next static variable with definition after NODE. */
2084 inline varpool_node *next_defined_variable (varpool_node *node);
2086 /* Return first function with body defined. */
2087 inline cgraph_node *first_defined_function (void);
2089 /* Return next function with body defined after NODE. */
2090 inline cgraph_node *next_defined_function (cgraph_node *node);
2092 /* Return first function. */
2093 inline cgraph_node *first_function (void);
2095 /* Return next function. */
2096 inline cgraph_node *next_function (cgraph_node *node);
2098 /* Return first function with body defined. */
2099 cgraph_node *first_function_with_gimple_body (void);
2101 /* Return next reachable static variable with initializer after NODE. */
2102 inline cgraph_node *next_function_with_gimple_body (cgraph_node *node);
2104 /* Register HOOK to be called with DATA on each removed edge. */
2105 cgraph_edge_hook_list *add_edge_removal_hook (cgraph_edge_hook hook,
2106 void *data);
2108 /* Remove ENTRY from the list of hooks called on removing edges. */
2109 void remove_edge_removal_hook (cgraph_edge_hook_list *entry);
2111 /* Register HOOK to be called with DATA on each removed node. */
2112 cgraph_node_hook_list *add_cgraph_removal_hook (cgraph_node_hook hook,
2113 void *data);
2115 /* Remove ENTRY from the list of hooks called on removing nodes. */
2116 void remove_cgraph_removal_hook (cgraph_node_hook_list *entry);
2118 /* Register HOOK to be called with DATA on each removed node. */
2119 varpool_node_hook_list *add_varpool_removal_hook (varpool_node_hook hook,
2120 void *data);
2122 /* Remove ENTRY from the list of hooks called on removing nodes. */
2123 void remove_varpool_removal_hook (varpool_node_hook_list *entry);
2125 /* Register HOOK to be called with DATA on each inserted node. */
2126 cgraph_node_hook_list *add_cgraph_insertion_hook (cgraph_node_hook hook,
2127 void *data);
2129 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2130 void remove_cgraph_insertion_hook (cgraph_node_hook_list *entry);
2132 /* Register HOOK to be called with DATA on each inserted node. */
2133 varpool_node_hook_list *add_varpool_insertion_hook (varpool_node_hook hook,
2134 void *data);
2136 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2137 void remove_varpool_insertion_hook (varpool_node_hook_list *entry);
2139 /* Register HOOK to be called with DATA on each duplicated edge. */
2140 cgraph_2edge_hook_list *add_edge_duplication_hook (cgraph_2edge_hook hook,
2141 void *data);
2142 /* Remove ENTRY from the list of hooks called on duplicating edges. */
2143 void remove_edge_duplication_hook (cgraph_2edge_hook_list *entry);
2145 /* Register HOOK to be called with DATA on each duplicated node. */
2146 cgraph_2node_hook_list *add_cgraph_duplication_hook (cgraph_2node_hook hook,
2147 void *data);
2149 /* Remove ENTRY from the list of hooks called on duplicating nodes. */
2150 void remove_cgraph_duplication_hook (cgraph_2node_hook_list *entry);
2152 /* Call all edge removal hooks. */
2153 void call_edge_removal_hooks (cgraph_edge *e);
2155 /* Call all node insertion hooks. */
2156 void call_cgraph_insertion_hooks (cgraph_node *node);
2158 /* Call all node removal hooks. */
2159 void call_cgraph_removal_hooks (cgraph_node *node);
2161 /* Call all node duplication hooks. */
2162 void call_cgraph_duplication_hooks (cgraph_node *node, cgraph_node *node2);
2164 /* Call all edge duplication hooks. */
2165 void call_edge_duplication_hooks (cgraph_edge *cs1, cgraph_edge *cs2);
2167 /* Call all node removal hooks. */
2168 void call_varpool_removal_hooks (varpool_node *node);
2170 /* Call all node insertion hooks. */
2171 void call_varpool_insertion_hooks (varpool_node *node);
2173 /* Arrange node to be first in its entry of assembler_name_hash. */
2174 void symtab_prevail_in_asm_name_hash (symtab_node *node);
2176 /* Initalize asm name hash unless. */
2177 void symtab_initialize_asm_name_hash (void);
2179 /* Set the DECL_ASSEMBLER_NAME and update symtab hashtables. */
2180 void change_decl_assembler_name (tree decl, tree name);
2182 /* Return true if assembler names NAME1 and NAME2 leads to the same symbol
2183 name. */
2184 static bool assembler_names_equal_p (const char *name1, const char *name2);
2186 int cgraph_count;
2187 int cgraph_max_uid;
2188 int cgraph_max_summary_uid;
2190 int edges_count;
2191 int edges_max_uid;
2193 symtab_node* GTY(()) nodes;
2194 asm_node* GTY(()) asmnodes;
2195 asm_node* GTY(()) asm_last_node;
2196 cgraph_node* GTY(()) free_nodes;
2198 /* Head of a linked list of unused (freed) call graph edges.
2199 Do not GTY((delete)) this list so UIDs gets reliably recycled. */
2200 cgraph_edge * GTY(()) free_edges;
2202 /* The order index of the next symtab node to be created. This is
2203 used so that we can sort the cgraph nodes in order by when we saw
2204 them, to support -fno-toplevel-reorder. */
2205 int order;
2207 /* Set when whole unit has been analyzed so we can access global info. */
2208 bool global_info_ready;
2209 /* What state callgraph is in right now. */
2210 enum symtab_state state;
2211 /* Set when the cgraph is fully build and the basic flags are computed. */
2212 bool function_flags_ready;
2214 bool cpp_implicit_aliases_done;
2216 /* Hash table used to hold sectoons. */
2217 hash_table<section_name_hasher> *GTY(()) section_hash;
2219 /* Hash table used to convert assembler names into nodes. */
2220 hash_table<asmname_hasher> *assembler_name_hash;
2222 /* Hash table used to hold init priorities. */
2223 hash_map<symtab_node *, symbol_priority_map> *init_priority_hash;
2225 FILE* GTY ((skip)) dump_file;
2227 /* Return symbol used to separate symbol name from suffix. */
2228 static char symbol_suffix_separator ();
2230 FILE* GTY ((skip)) ipa_clones_dump_file;
2232 hash_set <const cgraph_node *> GTY ((skip)) cloned_nodes;
2234 private:
2235 /* Allocate new callgraph node. */
2236 inline cgraph_node * allocate_cgraph_symbol (void);
2238 /* Allocate a cgraph_edge structure and fill it with data according to the
2239 parameters of which only CALLEE can be NULL (when creating an indirect call
2240 edge). */
2241 cgraph_edge *create_edge (cgraph_node *caller, cgraph_node *callee,
2242 gcall *call_stmt, gcov_type count, int freq,
2243 bool indir_unknown_callee);
2245 /* Put the edge onto the free list. */
2246 void free_edge (cgraph_edge *e);
2248 /* Insert NODE to assembler name hash. */
2249 void insert_to_assembler_name_hash (symtab_node *node, bool with_clones);
2251 /* Remove NODE from assembler name hash. */
2252 void unlink_from_assembler_name_hash (symtab_node *node, bool with_clones);
2254 /* Hash asmnames ignoring the user specified marks. */
2255 static hashval_t decl_assembler_name_hash (const_tree asmname);
2257 /* Compare ASMNAME with the DECL_ASSEMBLER_NAME of DECL. */
2258 static bool decl_assembler_name_equal (tree decl, const_tree asmname);
2260 friend struct asmname_hasher;
2262 /* List of hooks triggered when an edge is removed. */
2263 cgraph_edge_hook_list * GTY((skip)) m_first_edge_removal_hook;
2264 /* List of hooks triggem_red when a cgraph node is removed. */
2265 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_removal_hook;
2266 /* List of hooks triggered when an edge is duplicated. */
2267 cgraph_2edge_hook_list * GTY((skip)) m_first_edge_duplicated_hook;
2268 /* List of hooks triggered when a node is duplicated. */
2269 cgraph_2node_hook_list * GTY((skip)) m_first_cgraph_duplicated_hook;
2270 /* List of hooks triggered when an function is inserted. */
2271 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_insertion_hook;
2272 /* List of hooks triggered when an variable is inserted. */
2273 varpool_node_hook_list * GTY((skip)) m_first_varpool_insertion_hook;
2274 /* List of hooks triggered when a node is removed. */
2275 varpool_node_hook_list * GTY((skip)) m_first_varpool_removal_hook;
2278 extern GTY(()) symbol_table *symtab;
2280 extern vec<cgraph_node *> cgraph_new_nodes;
2282 inline hashval_t
2283 asmname_hasher::hash (symtab_node *n)
2285 return symbol_table::decl_assembler_name_hash
2286 (DECL_ASSEMBLER_NAME (n->decl));
2289 inline bool
2290 asmname_hasher::equal (symtab_node *n, const_tree t)
2292 return symbol_table::decl_assembler_name_equal (n->decl, t);
2295 /* In cgraph.c */
2296 void cgraph_c_finalize (void);
2297 void release_function_body (tree);
2298 cgraph_indirect_call_info *cgraph_allocate_init_indirect_info (void);
2300 void cgraph_update_edges_for_call_stmt (gimple *, tree, gimple *);
2301 bool cgraph_function_possibly_inlined_p (tree);
2303 const char* cgraph_inline_failed_string (cgraph_inline_failed_t);
2304 cgraph_inline_failed_type_t cgraph_inline_failed_type (cgraph_inline_failed_t);
2306 extern bool gimple_check_call_matching_types (gimple *, tree, bool);
2308 /* In cgraphunit.c */
2309 void cgraphunit_c_finalize (void);
2311 /* Initialize datastructures so DECL is a function in lowered gimple form.
2312 IN_SSA is true if the gimple is in SSA. */
2313 basic_block init_lowered_empty_function (tree, bool, gcov_type);
2315 tree thunk_adjust (gimple_stmt_iterator *, tree, bool, HOST_WIDE_INT, tree);
2316 /* In cgraphclones.c */
2318 tree clone_function_name_1 (const char *, const char *);
2319 tree clone_function_name (tree decl, const char *);
2321 void tree_function_versioning (tree, tree, vec<ipa_replace_map *, va_gc> *,
2322 bool, bitmap, bool, bitmap, basic_block);
2324 void dump_callgraph_transformation (const cgraph_node *original,
2325 const cgraph_node *clone,
2326 const char *suffix);
2328 /* In cgraphbuild.c */
2329 int compute_call_stmt_bb_frequency (tree, basic_block bb);
2330 void record_references_in_initializer (tree, bool);
2332 /* In ipa.c */
2333 void cgraph_build_static_cdtor (char which, tree body, int priority);
2334 bool ipa_discover_readonly_nonaddressable_vars (void);
2336 /* In varpool.c */
2337 tree ctor_for_folding (tree);
2339 /* In tree-chkp.c */
2340 extern bool chkp_function_instrumented_p (tree fndecl);
2342 /* Return true when the symbol is real symbol, i.e. it is not inline clone
2343 or abstract function kept for debug info purposes only. */
2344 inline bool
2345 symtab_node::real_symbol_p (void)
2347 cgraph_node *cnode;
2349 if (DECL_ABSTRACT_P (decl))
2350 return false;
2351 if (transparent_alias && definition)
2352 return false;
2353 if (!is_a <cgraph_node *> (this))
2354 return true;
2355 cnode = dyn_cast <cgraph_node *> (this);
2356 if (cnode->global.inlined_to)
2357 return false;
2358 return true;
2361 /* Return true if DECL should have entry in symbol table if used.
2362 Those are functions and static & external veriables*/
2364 static inline bool
2365 decl_in_symtab_p (const_tree decl)
2367 return (TREE_CODE (decl) == FUNCTION_DECL
2368 || (TREE_CODE (decl) == VAR_DECL
2369 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl))));
2372 inline bool
2373 symtab_node::in_same_comdat_group_p (symtab_node *target)
2375 symtab_node *source = this;
2377 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2379 if (cn->global.inlined_to)
2380 source = cn->global.inlined_to;
2382 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2384 if (cn->global.inlined_to)
2385 target = cn->global.inlined_to;
2388 return source->get_comdat_group () == target->get_comdat_group ();
2391 /* Return node that alias is aliasing. */
2393 inline symtab_node *
2394 symtab_node::get_alias_target (void)
2396 ipa_ref *ref = NULL;
2397 iterate_reference (0, ref);
2398 if (ref->use == IPA_REF_CHKP)
2399 iterate_reference (1, ref);
2400 gcc_checking_assert (ref->use == IPA_REF_ALIAS);
2401 return ref->referred;
2404 /* Return next reachable static symbol with initializer after the node. */
2406 inline symtab_node *
2407 symtab_node::next_defined_symbol (void)
2409 symtab_node *node1 = next;
2411 for (; node1; node1 = node1->next)
2412 if (node1->definition)
2413 return node1;
2415 return NULL;
2418 /* Iterates I-th reference in the list, REF is also set. */
2420 inline ipa_ref *
2421 symtab_node::iterate_reference (unsigned i, ipa_ref *&ref)
2423 vec_safe_iterate (ref_list.references, i, &ref);
2425 return ref;
2428 /* Iterates I-th referring item in the list, REF is also set. */
2430 inline ipa_ref *
2431 symtab_node::iterate_referring (unsigned i, ipa_ref *&ref)
2433 ref_list.referring.iterate (i, &ref);
2435 return ref;
2438 /* Iterates I-th referring alias item in the list, REF is also set. */
2440 inline ipa_ref *
2441 symtab_node::iterate_direct_aliases (unsigned i, ipa_ref *&ref)
2443 ref_list.referring.iterate (i, &ref);
2445 if (ref && ref->use != IPA_REF_ALIAS)
2446 return NULL;
2448 return ref;
2451 /* Return true if list contains an alias. */
2453 inline bool
2454 symtab_node::has_aliases_p (void)
2456 ipa_ref *ref = NULL;
2458 return (iterate_direct_aliases (0, ref) != NULL);
2461 /* Return true when RESOLUTION indicate that linker will use
2462 the symbol from non-LTO object files. */
2464 inline bool
2465 resolution_used_from_other_file_p (enum ld_plugin_symbol_resolution resolution)
2467 return (resolution == LDPR_PREVAILING_DEF
2468 || resolution == LDPR_PREEMPTED_REG
2469 || resolution == LDPR_RESOLVED_EXEC
2470 || resolution == LDPR_RESOLVED_DYN);
2473 /* Return true when symtab_node is known to be used from other (non-LTO)
2474 object file. Known only when doing LTO via linker plugin. */
2476 inline bool
2477 symtab_node::used_from_object_file_p (void)
2479 if (!TREE_PUBLIC (decl) || DECL_EXTERNAL (decl))
2480 return false;
2481 if (resolution_used_from_other_file_p (resolution))
2482 return true;
2483 return false;
2486 /* Return varpool node for given symbol and check it is a function. */
2488 inline varpool_node *
2489 varpool_node::get (const_tree decl)
2491 gcc_checking_assert (TREE_CODE (decl) == VAR_DECL);
2492 return dyn_cast<varpool_node *> (symtab_node::get (decl));
2495 /* Register a symbol NODE. */
2497 inline void
2498 symbol_table::register_symbol (symtab_node *node)
2500 node->next = nodes;
2501 node->previous = NULL;
2503 if (nodes)
2504 nodes->previous = node;
2505 nodes = node;
2507 node->order = order++;
2510 /* Register a top-level asm statement ASM_STR. */
2512 asm_node *
2513 symbol_table::finalize_toplevel_asm (tree asm_str)
2515 asm_node *node;
2517 node = ggc_cleared_alloc<asm_node> ();
2518 node->asm_str = asm_str;
2519 node->order = order++;
2520 node->next = NULL;
2522 if (asmnodes == NULL)
2523 asmnodes = node;
2524 else
2525 asm_last_node->next = node;
2527 asm_last_node = node;
2528 return node;
2531 /* Unregister a symbol NODE. */
2532 inline void
2533 symbol_table::unregister (symtab_node *node)
2535 if (node->previous)
2536 node->previous->next = node->next;
2537 else
2538 nodes = node->next;
2540 if (node->next)
2541 node->next->previous = node->previous;
2543 node->next = NULL;
2544 node->previous = NULL;
2547 /* Release a callgraph NODE with UID and put in to the list of free nodes. */
2549 inline void
2550 symbol_table::release_symbol (cgraph_node *node, int uid)
2552 cgraph_count--;
2554 /* Clear out the node to NULL all pointers and add the node to the free
2555 list. */
2556 memset (node, 0, sizeof (*node));
2557 node->type = SYMTAB_FUNCTION;
2558 node->uid = uid;
2559 SET_NEXT_FREE_NODE (node, free_nodes);
2560 free_nodes = node;
2563 /* Allocate new callgraph node. */
2565 inline cgraph_node *
2566 symbol_table::allocate_cgraph_symbol (void)
2568 cgraph_node *node;
2570 if (free_nodes)
2572 node = free_nodes;
2573 free_nodes = NEXT_FREE_NODE (node);
2575 else
2577 node = ggc_cleared_alloc<cgraph_node> ();
2578 node->uid = cgraph_max_uid++;
2581 node->summary_uid = cgraph_max_summary_uid++;
2582 return node;
2586 /* Return first static symbol with definition. */
2587 inline symtab_node *
2588 symbol_table::first_symbol (void)
2590 return nodes;
2593 /* Walk all symbols. */
2594 #define FOR_EACH_SYMBOL(node) \
2595 for ((node) = symtab->first_symbol (); (node); (node) = (node)->next)
2597 /* Return first static symbol with definition. */
2598 inline symtab_node *
2599 symbol_table::first_defined_symbol (void)
2601 symtab_node *node;
2603 for (node = nodes; node; node = node->next)
2604 if (node->definition)
2605 return node;
2607 return NULL;
2610 /* Walk all symbols with definitions in current unit. */
2611 #define FOR_EACH_DEFINED_SYMBOL(node) \
2612 for ((node) = symtab->first_defined_symbol (); (node); \
2613 (node) = node->next_defined_symbol ())
2615 /* Return first variable. */
2616 inline varpool_node *
2617 symbol_table::first_variable (void)
2619 symtab_node *node;
2620 for (node = nodes; node; node = node->next)
2621 if (varpool_node *vnode = dyn_cast <varpool_node *> (node))
2622 return vnode;
2623 return NULL;
2626 /* Return next variable after NODE. */
2627 inline varpool_node *
2628 symbol_table::next_variable (varpool_node *node)
2630 symtab_node *node1 = node->next;
2631 for (; node1; node1 = node1->next)
2632 if (varpool_node *vnode1 = dyn_cast <varpool_node *> (node1))
2633 return vnode1;
2634 return NULL;
2636 /* Walk all variables. */
2637 #define FOR_EACH_VARIABLE(node) \
2638 for ((node) = symtab->first_variable (); \
2639 (node); \
2640 (node) = symtab->next_variable ((node)))
2642 /* Return first static variable with initializer. */
2643 inline varpool_node *
2644 symbol_table::first_static_initializer (void)
2646 symtab_node *node;
2647 for (node = nodes; node; node = node->next)
2649 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2650 if (vnode && DECL_INITIAL (node->decl))
2651 return vnode;
2653 return NULL;
2656 /* Return next static variable with initializer after NODE. */
2657 inline varpool_node *
2658 symbol_table::next_static_initializer (varpool_node *node)
2660 symtab_node *node1 = node->next;
2661 for (; node1; node1 = node1->next)
2663 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2664 if (vnode1 && DECL_INITIAL (node1->decl))
2665 return vnode1;
2667 return NULL;
2670 /* Walk all static variables with initializer set. */
2671 #define FOR_EACH_STATIC_INITIALIZER(node) \
2672 for ((node) = symtab->first_static_initializer (); (node); \
2673 (node) = symtab->next_static_initializer (node))
2675 /* Return first static variable with definition. */
2676 inline varpool_node *
2677 symbol_table::first_defined_variable (void)
2679 symtab_node *node;
2680 for (node = nodes; node; node = node->next)
2682 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2683 if (vnode && vnode->definition)
2684 return vnode;
2686 return NULL;
2689 /* Return next static variable with definition after NODE. */
2690 inline varpool_node *
2691 symbol_table::next_defined_variable (varpool_node *node)
2693 symtab_node *node1 = node->next;
2694 for (; node1; node1 = node1->next)
2696 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2697 if (vnode1 && vnode1->definition)
2698 return vnode1;
2700 return NULL;
2702 /* Walk all variables with definitions in current unit. */
2703 #define FOR_EACH_DEFINED_VARIABLE(node) \
2704 for ((node) = symtab->first_defined_variable (); (node); \
2705 (node) = symtab->next_defined_variable (node))
2707 /* Return first function with body defined. */
2708 inline cgraph_node *
2709 symbol_table::first_defined_function (void)
2711 symtab_node *node;
2712 for (node = nodes; node; node = node->next)
2714 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2715 if (cn && cn->definition)
2716 return cn;
2718 return NULL;
2721 /* Return next function with body defined after NODE. */
2722 inline cgraph_node *
2723 symbol_table::next_defined_function (cgraph_node *node)
2725 symtab_node *node1 = node->next;
2726 for (; node1; node1 = node1->next)
2728 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2729 if (cn1 && cn1->definition)
2730 return cn1;
2732 return NULL;
2735 /* Walk all functions with body defined. */
2736 #define FOR_EACH_DEFINED_FUNCTION(node) \
2737 for ((node) = symtab->first_defined_function (); (node); \
2738 (node) = symtab->next_defined_function ((node)))
2740 /* Return first function. */
2741 inline cgraph_node *
2742 symbol_table::first_function (void)
2744 symtab_node *node;
2745 for (node = nodes; node; node = node->next)
2746 if (cgraph_node *cn = dyn_cast <cgraph_node *> (node))
2747 return cn;
2748 return NULL;
2751 /* Return next function. */
2752 inline cgraph_node *
2753 symbol_table::next_function (cgraph_node *node)
2755 symtab_node *node1 = node->next;
2756 for (; node1; node1 = node1->next)
2757 if (cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1))
2758 return cn1;
2759 return NULL;
2762 /* Return first function with body defined. */
2763 inline cgraph_node *
2764 symbol_table::first_function_with_gimple_body (void)
2766 symtab_node *node;
2767 for (node = nodes; node; node = node->next)
2769 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2770 if (cn && cn->has_gimple_body_p ())
2771 return cn;
2773 return NULL;
2776 /* Return next reachable static variable with initializer after NODE. */
2777 inline cgraph_node *
2778 symbol_table::next_function_with_gimple_body (cgraph_node *node)
2780 symtab_node *node1 = node->next;
2781 for (; node1; node1 = node1->next)
2783 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2784 if (cn1 && cn1->has_gimple_body_p ())
2785 return cn1;
2787 return NULL;
2790 /* Walk all functions. */
2791 #define FOR_EACH_FUNCTION(node) \
2792 for ((node) = symtab->first_function (); (node); \
2793 (node) = symtab->next_function ((node)))
2795 /* Return true when callgraph node is a function with Gimple body defined
2796 in current unit. Functions can also be define externally or they
2797 can be thunks with no Gimple representation.
2799 Note that at WPA stage, the function body may not be present in memory. */
2801 inline bool
2802 cgraph_node::has_gimple_body_p (void)
2804 return definition && !thunk.thunk_p && !alias;
2807 /* Walk all functions with body defined. */
2808 #define FOR_EACH_FUNCTION_WITH_GIMPLE_BODY(node) \
2809 for ((node) = symtab->first_function_with_gimple_body (); (node); \
2810 (node) = symtab->next_function_with_gimple_body (node))
2812 /* Uniquize all constants that appear in memory.
2813 Each constant in memory thus far output is recorded
2814 in `const_desc_table'. */
2816 struct GTY((for_user)) constant_descriptor_tree {
2817 /* A MEM for the constant. */
2818 rtx rtl;
2820 /* The value of the constant. */
2821 tree value;
2823 /* Hash of value. Computing the hash from value each time
2824 hashfn is called can't work properly, as that means recursive
2825 use of the hash table during hash table expansion. */
2826 hashval_t hash;
2829 /* Return true when function is only called directly or it has alias.
2830 i.e. it is not externally visible, address was not taken and
2831 it is not used in any other non-standard way. */
2833 inline bool
2834 cgraph_node::only_called_directly_or_aliased_p (void)
2836 gcc_assert (!global.inlined_to);
2837 return (!force_output && !address_taken
2838 && !used_from_other_partition
2839 && !DECL_VIRTUAL_P (decl)
2840 && !DECL_STATIC_CONSTRUCTOR (decl)
2841 && !DECL_STATIC_DESTRUCTOR (decl)
2842 && !used_from_object_file_p ()
2843 && !externally_visible);
2846 /* Return true when function can be removed from callgraph
2847 if all direct calls are eliminated. */
2849 inline bool
2850 cgraph_node::can_remove_if_no_direct_calls_and_refs_p (void)
2852 gcc_checking_assert (!global.inlined_to);
2853 /* Instrumentation clones should not be removed before
2854 instrumentation happens. New callers may appear after
2855 instrumentation. */
2856 if (instrumentation_clone
2857 && !chkp_function_instrumented_p (decl))
2858 return false;
2859 /* Extern inlines can always go, we will use the external definition. */
2860 if (DECL_EXTERNAL (decl))
2861 return true;
2862 /* When function is needed, we can not remove it. */
2863 if (force_output || used_from_other_partition)
2864 return false;
2865 if (DECL_STATIC_CONSTRUCTOR (decl)
2866 || DECL_STATIC_DESTRUCTOR (decl))
2867 return false;
2868 /* Only COMDAT functions can be removed if externally visible. */
2869 if (externally_visible
2870 && (!DECL_COMDAT (decl)
2871 || forced_by_abi
2872 || used_from_object_file_p ()))
2873 return false;
2874 return true;
2877 /* Verify cgraph, if consistency checking is enabled. */
2879 inline void
2880 cgraph_node::checking_verify_cgraph_nodes (void)
2882 if (flag_checking)
2883 cgraph_node::verify_cgraph_nodes ();
2886 /* Return true when variable can be removed from variable pool
2887 if all direct calls are eliminated. */
2889 inline bool
2890 varpool_node::can_remove_if_no_refs_p (void)
2892 if (DECL_EXTERNAL (decl))
2893 return true;
2894 return (!force_output && !used_from_other_partition
2895 && ((DECL_COMDAT (decl)
2896 && !forced_by_abi
2897 && !used_from_object_file_p ())
2898 || !externally_visible
2899 || DECL_HAS_VALUE_EXPR_P (decl)));
2902 /* Return true when all references to variable must be visible in ipa_ref_list.
2903 i.e. if the variable is not externally visible or not used in some magic
2904 way (asm statement or such).
2905 The magic uses are all summarized in force_output flag. */
2907 inline bool
2908 varpool_node::all_refs_explicit_p ()
2910 return (definition
2911 && !externally_visible
2912 && !used_from_other_partition
2913 && !force_output);
2916 struct tree_descriptor_hasher : ggc_ptr_hash<constant_descriptor_tree>
2918 static hashval_t hash (constant_descriptor_tree *);
2919 static bool equal (constant_descriptor_tree *, constant_descriptor_tree *);
2922 /* Constant pool accessor function. */
2923 hash_table<tree_descriptor_hasher> *constant_pool_htab (void);
2925 /* Return node that alias is aliasing. */
2927 inline cgraph_node *
2928 cgraph_node::get_alias_target (void)
2930 return dyn_cast <cgraph_node *> (symtab_node::get_alias_target ());
2933 /* Return node that alias is aliasing. */
2935 inline varpool_node *
2936 varpool_node::get_alias_target (void)
2938 return dyn_cast <varpool_node *> (symtab_node::get_alias_target ());
2941 /* Walk the alias chain to return the symbol NODE is alias of.
2942 If NODE is not an alias, return NODE.
2943 When AVAILABILITY is non-NULL, get minimal availability in the chain.
2944 When REF is non-NULL, assume that reference happens in symbol REF
2945 when determining the availability. */
2947 inline symtab_node *
2948 symtab_node::ultimate_alias_target (enum availability *availability,
2949 symtab_node *ref)
2951 if (!alias)
2953 if (availability)
2954 *availability = get_availability (ref);
2955 return this;
2958 return ultimate_alias_target_1 (availability, ref);
2961 /* Given function symbol, walk the alias chain to return the function node
2962 is alias of. Do not walk through thunks.
2963 When AVAILABILITY is non-NULL, get minimal availability in the chain.
2964 When REF is non-NULL, assume that reference happens in symbol REF
2965 when determining the availability. */
2967 inline cgraph_node *
2968 cgraph_node::ultimate_alias_target (enum availability *availability,
2969 symtab_node *ref)
2971 cgraph_node *n = dyn_cast <cgraph_node *>
2972 (symtab_node::ultimate_alias_target (availability, ref));
2973 if (!n && availability)
2974 *availability = AVAIL_NOT_AVAILABLE;
2975 return n;
2978 /* For given variable pool node, walk the alias chain to return the function
2979 the variable is alias of. Do not walk through thunks.
2980 When AVAILABILITY is non-NULL, get minimal availability in the chain.
2981 When REF is non-NULL, assume that reference happens in symbol REF
2982 when determining the availability. */
2984 inline varpool_node *
2985 varpool_node::ultimate_alias_target (availability *availability,
2986 symtab_node *ref)
2988 varpool_node *n = dyn_cast <varpool_node *>
2989 (symtab_node::ultimate_alias_target (availability, ref));
2991 if (!n && availability)
2992 *availability = AVAIL_NOT_AVAILABLE;
2993 return n;
2996 /* Set callee N of call graph edge and add it to the corresponding set of
2997 callers. */
2999 inline void
3000 cgraph_edge::set_callee (cgraph_node *n)
3002 prev_caller = NULL;
3003 if (n->callers)
3004 n->callers->prev_caller = this;
3005 next_caller = n->callers;
3006 n->callers = this;
3007 callee = n;
3010 /* Redirect callee of the edge to N. The function does not update underlying
3011 call expression. */
3013 inline void
3014 cgraph_edge::redirect_callee (cgraph_node *n)
3016 /* Remove from callers list of the current callee. */
3017 remove_callee ();
3019 /* Insert to callers list of the new callee. */
3020 set_callee (n);
3023 /* Return true when the edge represents a direct recursion. */
3025 inline bool
3026 cgraph_edge::recursive_p (void)
3028 cgraph_node *c = callee->ultimate_alias_target ();
3029 if (caller->global.inlined_to)
3030 return caller->global.inlined_to->decl == c->decl;
3031 else
3032 return caller->decl == c->decl;
3035 /* Remove the edge from the list of the callers of the callee. */
3037 inline void
3038 cgraph_edge::remove_callee (void)
3040 gcc_assert (!indirect_unknown_callee);
3041 if (prev_caller)
3042 prev_caller->next_caller = next_caller;
3043 if (next_caller)
3044 next_caller->prev_caller = prev_caller;
3045 if (!prev_caller)
3046 callee->callers = next_caller;
3049 /* Return true if call must bind to current definition. */
3051 inline bool
3052 cgraph_edge::binds_to_current_def_p ()
3054 if (callee)
3055 return callee->binds_to_current_def_p (caller);
3056 else
3057 return false;
3060 /* Return true if the TM_CLONE bit is set for a given FNDECL. */
3061 static inline bool
3062 decl_is_tm_clone (const_tree fndecl)
3064 cgraph_node *n = cgraph_node::get (fndecl);
3065 if (n)
3066 return n->tm_clone;
3067 return false;
3070 /* Likewise indicate that a node is needed, i.e. reachable via some
3071 external means. */
3073 inline void
3074 cgraph_node::mark_force_output (void)
3076 force_output = 1;
3077 gcc_checking_assert (!global.inlined_to);
3080 /* Return true if function should be optimized for size. */
3082 inline bool
3083 cgraph_node::optimize_for_size_p (void)
3085 if (opt_for_fn (decl, optimize_size))
3086 return true;
3087 if (frequency == NODE_FREQUENCY_UNLIKELY_EXECUTED)
3088 return true;
3089 else
3090 return false;
3093 /* Return symtab_node for NODE or create one if it is not present
3094 in symtab. */
3096 inline symtab_node *
3097 symtab_node::get_create (tree node)
3099 if (TREE_CODE (node) == VAR_DECL)
3100 return varpool_node::get_create (node);
3101 else
3102 return cgraph_node::get_create (node);
3105 /* Return availability of NODE when referenced from REF. */
3107 inline enum availability
3108 symtab_node::get_availability (symtab_node *ref)
3110 if (is_a <cgraph_node *> (this))
3111 return dyn_cast <cgraph_node *> (this)->get_availability (ref);
3112 else
3113 return dyn_cast <varpool_node *> (this)->get_availability (ref);
3116 /* Call calback on symtab node and aliases associated to this node.
3117 When INCLUDE_OVERWRITABLE is false, overwritable symbols are skipped. */
3119 inline bool
3120 symtab_node::call_for_symbol_and_aliases (bool (*callback) (symtab_node *,
3121 void *),
3122 void *data,
3123 bool include_overwritable)
3125 if (include_overwritable
3126 || get_availability () > AVAIL_INTERPOSABLE)
3128 if (callback (this, data))
3129 return true;
3131 if (has_aliases_p ())
3132 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3133 return false;
3136 /* Call callback on function and aliases associated to the function.
3137 When INCLUDE_OVERWRITABLE is false, overwritable symbols are
3138 skipped. */
3140 inline bool
3141 cgraph_node::call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
3142 void *),
3143 void *data,
3144 bool include_overwritable)
3146 if (include_overwritable
3147 || get_availability () > AVAIL_INTERPOSABLE)
3149 if (callback (this, data))
3150 return true;
3152 if (has_aliases_p ())
3153 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3154 return false;
3157 /* Call calback on varpool symbol and aliases associated to varpool symbol.
3158 When INCLUDE_OVERWRITABLE is false, overwritable symbols are
3159 skipped. */
3161 inline bool
3162 varpool_node::call_for_symbol_and_aliases (bool (*callback) (varpool_node *,
3163 void *),
3164 void *data,
3165 bool include_overwritable)
3167 if (include_overwritable
3168 || get_availability () > AVAIL_INTERPOSABLE)
3170 if (callback (this, data))
3171 return true;
3173 if (has_aliases_p ())
3174 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3175 return false;
3178 /* Return true if refernece may be used in address compare. */
3180 inline bool
3181 ipa_ref::address_matters_p ()
3183 if (use != IPA_REF_ADDR)
3184 return false;
3185 /* Addresses taken from virtual tables are never compared. */
3186 if (is_a <varpool_node *> (referring)
3187 && DECL_VIRTUAL_P (referring->decl))
3188 return false;
3189 return referred->address_can_be_compared_p ();
3192 /* Build polymorphic call context for indirect call E. */
3194 inline
3195 ipa_polymorphic_call_context::ipa_polymorphic_call_context (cgraph_edge *e)
3197 gcc_checking_assert (e->indirect_info->polymorphic);
3198 *this = e->indirect_info->context;
3201 /* Build empty "I know nothing" context. */
3203 inline
3204 ipa_polymorphic_call_context::ipa_polymorphic_call_context ()
3206 clear_speculation ();
3207 clear_outer_type ();
3208 invalid = false;
3211 /* Make context non-speculative. */
3213 inline void
3214 ipa_polymorphic_call_context::clear_speculation ()
3216 speculative_outer_type = NULL;
3217 speculative_offset = 0;
3218 speculative_maybe_derived_type = false;
3221 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
3222 NULL, the context is set to dummy "I know nothing" setting. */
3224 inline void
3225 ipa_polymorphic_call_context::clear_outer_type (tree otr_type)
3227 outer_type = otr_type ? TYPE_MAIN_VARIANT (otr_type) : NULL;
3228 offset = 0;
3229 maybe_derived_type = true;
3230 maybe_in_construction = true;
3231 dynamic = true;
3234 /* Adjust all offsets in contexts by OFF bits. */
3236 inline void
3237 ipa_polymorphic_call_context::offset_by (HOST_WIDE_INT off)
3239 if (outer_type)
3240 offset += off;
3241 if (speculative_outer_type)
3242 speculative_offset += off;
3245 /* Return TRUE if context is fully useless. */
3247 inline bool
3248 ipa_polymorphic_call_context::useless_p () const
3250 return (!outer_type && !speculative_outer_type);
3253 /* Return true if NODE is local. Instrumentation clones are counted as local
3254 only when original function is local. */
3256 static inline bool
3257 cgraph_local_p (cgraph_node *node)
3259 if (!node->instrumentation_clone || !node->instrumented_version)
3260 return node->local.local;
3262 return node->local.local && node->instrumented_version->local.local;
3265 /* When using fprintf (or similar), problems can arise with
3266 transient generated strings. Many string-generation APIs
3267 only support one result being alive at once (e.g. by
3268 returning a pointer to a statically-allocated buffer).
3270 If there is more than one generated string within one
3271 fprintf call: the first string gets evicted or overwritten
3272 by the second, before fprintf is fully evaluated.
3273 See e.g. PR/53136.
3275 This function provides a workaround for this, by providing
3276 a simple way to create copies of these transient strings,
3277 without the need to have explicit cleanup:
3279 fprintf (dumpfile, "string 1: %s string 2:%s\n",
3280 xstrdup_for_dump (EXPR_1),
3281 xstrdup_for_dump (EXPR_2));
3283 This is actually a simple wrapper around ggc_strdup, but
3284 the name documents the intent. We require that no GC can occur
3285 within the fprintf call. */
3287 static inline const char *
3288 xstrdup_for_dump (const char *transient_str)
3290 return ggc_strdup (transient_str);
3293 #endif /* GCC_CGRAPH_H */