[ARM] Fix typo in comment in arm_expand_prologue
[official-gcc.git] / gcc / cgraph.h
blob72f9702f851bde427c4e06b3d6f298142f962e87
1 /* Callgraph handling code.
2 Copyright (C) 2003-2017 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 dump name. */
103 const char *dump_name () const;
105 /* Return asm name. */
106 const char *asm_name () const;
108 /* Return dump name with assembler name. */
109 const char *dump_asm_name () const;
111 /* Add node into symbol table. This function is not used directly, but via
112 cgraph/varpool node creation routines. */
113 void register_symbol (void);
115 /* Remove symbol from symbol table. */
116 void remove (void);
118 /* Dump symtab node to F. */
119 void dump (FILE *f);
121 /* Dump symtab node to stderr. */
122 void DEBUG_FUNCTION debug (void);
124 /* Verify consistency of node. */
125 void DEBUG_FUNCTION verify (void);
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);
133 /* Return ipa reference from this symtab_node to
134 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
135 of the use and STMT the statement (if it exists). */
136 ipa_ref *create_reference (symtab_node *referred_node,
137 enum ipa_ref_use use_type, gimple *stmt);
139 /* If VAL is a reference to a function or a variable, add a reference from
140 this symtab_node to the corresponding symbol table node. Return the new
141 reference or NULL if none was created. */
142 ipa_ref *maybe_create_reference (tree val, gimple *stmt);
144 /* Clone all references from symtab NODE to this symtab_node. */
145 void clone_references (symtab_node *node);
147 /* Remove all stmt references in non-speculative references.
148 Those are not maintained during inlining & clonning.
149 The exception are speculative references that are updated along
150 with callgraph edges associated with them. */
151 void clone_referring (symtab_node *node);
153 /* Clone reference REF to this symtab_node and set its stmt to STMT. */
154 ipa_ref *clone_reference (ipa_ref *ref, gimple *stmt);
156 /* Find the structure describing a reference to REFERRED_NODE
157 and associated with statement STMT. */
158 ipa_ref *find_reference (symtab_node *referred_node, gimple *stmt,
159 unsigned int lto_stmt_uid);
161 /* Remove all references that are associated with statement STMT. */
162 void remove_stmt_references (gimple *stmt);
164 /* Remove all stmt references in non-speculative references.
165 Those are not maintained during inlining & clonning.
166 The exception are speculative references that are updated along
167 with callgraph edges associated with them. */
168 void clear_stmts_in_references (void);
170 /* Remove all references in ref list. */
171 void remove_all_references (void);
173 /* Remove all referring items in ref list. */
174 void remove_all_referring (void);
176 /* Dump references in ref list to FILE. */
177 void dump_references (FILE *file);
179 /* Dump referring in list to FILE. */
180 void dump_referring (FILE *);
182 /* Get number of references for this node. */
183 inline unsigned num_references (void)
185 return ref_list.references ? ref_list.references->length () : 0;
188 /* Iterates I-th reference in the list, REF is also set. */
189 ipa_ref *iterate_reference (unsigned i, ipa_ref *&ref);
191 /* Iterates I-th referring item in the list, REF is also set. */
192 ipa_ref *iterate_referring (unsigned i, ipa_ref *&ref);
194 /* Iterates I-th referring alias item in the list, REF is also set. */
195 ipa_ref *iterate_direct_aliases (unsigned i, ipa_ref *&ref);
197 /* Return true if symtab node and TARGET represents
198 semantically equivalent symbols. */
199 bool semantically_equivalent_p (symtab_node *target);
201 /* Classify symbol symtab node for partitioning. */
202 enum symbol_partitioning_class get_partitioning_class (void);
204 /* Return comdat group. */
205 tree get_comdat_group ()
207 return x_comdat_group;
210 /* Return comdat group as identifier_node. */
211 tree get_comdat_group_id ()
213 if (x_comdat_group && TREE_CODE (x_comdat_group) != IDENTIFIER_NODE)
214 x_comdat_group = DECL_ASSEMBLER_NAME (x_comdat_group);
215 return x_comdat_group;
218 /* Set comdat group. */
219 void set_comdat_group (tree group)
221 gcc_checking_assert (!group || TREE_CODE (group) == IDENTIFIER_NODE
222 || DECL_P (group));
223 x_comdat_group = group;
226 /* Return section as string. */
227 const char * get_section ()
229 if (!x_section)
230 return NULL;
231 return x_section->name;
234 /* Remove node from same comdat group. */
235 void remove_from_same_comdat_group (void);
237 /* Add this symtab_node to the same comdat group that OLD is in. */
238 void add_to_same_comdat_group (symtab_node *old_node);
240 /* Dissolve the same_comdat_group list in which NODE resides. */
241 void dissolve_same_comdat_group_list (void);
243 /* Return true when symtab_node is known to be used from other (non-LTO)
244 object file. Known only when doing LTO via linker plugin. */
245 bool used_from_object_file_p (void);
247 /* Walk the alias chain to return the symbol NODE is alias of.
248 If NODE is not an alias, return NODE.
249 When AVAILABILITY is non-NULL, get minimal availability in the chain.
250 When REF is non-NULL, assume that reference happens in symbol REF
251 when determining the availability. */
252 symtab_node *ultimate_alias_target (enum availability *avail = NULL,
253 struct symtab_node *ref = NULL);
255 /* Return next reachable static symbol with initializer after NODE. */
256 inline symtab_node *next_defined_symbol (void);
258 /* Add reference recording that symtab node is alias of TARGET.
259 If TRANSPARENT is true make the alias to be transparent alias.
260 The function can fail in the case of aliasing cycles; in this case
261 it returns false. */
262 bool resolve_alias (symtab_node *target, bool transparent = false);
264 /* C++ FE sometimes change linkage flags after producing same
265 body aliases. */
266 void fixup_same_cpp_alias_visibility (symtab_node *target);
268 /* Call callback on symtab node and aliases associated to this node.
269 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
270 skipped. */
271 bool call_for_symbol_and_aliases (bool (*callback) (symtab_node *, void *),
272 void *data,
273 bool include_overwrite);
275 /* If node can not be interposable by static or dynamic linker to point to
276 different definition, return this symbol. Otherwise look for alias with
277 such property and if none exists, introduce new one. */
278 symtab_node *noninterposable_alias (void);
280 /* Return node that alias is aliasing. */
281 inline symtab_node *get_alias_target (void);
283 /* Set section for symbol and its aliases. */
284 void set_section (const char *section);
286 /* Set section, do not recurse into aliases.
287 When one wants to change section of symbol and its aliases,
288 use set_section. */
289 void set_section_for_node (const char *section);
291 /* Set initialization priority to PRIORITY. */
292 void set_init_priority (priority_type priority);
294 /* Return the initialization priority. */
295 priority_type get_init_priority ();
297 /* Return availability of NODE when referenced from REF. */
298 enum availability get_availability (symtab_node *ref = NULL);
300 /* Return true if NODE binds to current definition in final executable
301 when referenced from REF. If REF is NULL return conservative value
302 for any reference. */
303 bool binds_to_current_def_p (symtab_node *ref = NULL);
305 /* Make DECL local. */
306 void make_decl_local (void);
308 /* Copy visibility from N. */
309 void copy_visibility_from (symtab_node *n);
311 /* Return desired alignment of the definition. This is NOT alignment useful
312 to access THIS, because THIS may be interposable and DECL_ALIGN should
313 be used instead. It however must be guaranteed when output definition
314 of THIS. */
315 unsigned int definition_alignment ();
317 /* Return true if alignment can be increased. */
318 bool can_increase_alignment_p ();
320 /* Increase alignment of symbol to ALIGN. */
321 void increase_alignment (unsigned int align);
323 /* Return true if list contains an alias. */
324 bool has_aliases_p (void);
326 /* Return true when the symbol is real symbol, i.e. it is not inline clone
327 or abstract function kept for debug info purposes only. */
328 bool real_symbol_p (void);
330 /* Determine if symbol declaration is needed. That is, visible to something
331 either outside this translation unit, something magic in the system
332 configury. This function is used just during symbol creation. */
333 bool needed_p (void);
335 /* Return true if this symbol is a function from the C frontend specified
336 directly in RTL form (with "__RTL"). */
337 bool native_rtl_p () const;
339 /* Return true when there are references to the node. */
340 bool referred_to_p (bool include_self = true);
342 /* Return true if symbol can be discarded by linker from the binary.
343 Assume that symbol is used (so there is no need to take into account
344 garbage collecting linkers)
346 This can happen for comdats, commons and weaks when they are previaled
347 by other definition at static linking time. */
348 inline bool
349 can_be_discarded_p (void)
351 return (DECL_EXTERNAL (decl)
352 || ((get_comdat_group ()
353 || DECL_COMMON (decl)
354 || (DECL_SECTION_NAME (decl) && DECL_WEAK (decl)))
355 && ((resolution != LDPR_PREVAILING_DEF
356 && resolution != LDPR_PREVAILING_DEF_IRONLY_EXP)
357 || flag_incremental_link)
358 && resolution != LDPR_PREVAILING_DEF_IRONLY));
361 /* Return true if NODE is local to a particular COMDAT group, and must not
362 be named from outside the COMDAT. This is used for C++ decloned
363 constructors. */
364 inline bool comdat_local_p (void)
366 return (same_comdat_group && !TREE_PUBLIC (decl));
369 /* Return true if ONE and TWO are part of the same COMDAT group. */
370 inline bool in_same_comdat_group_p (symtab_node *target);
372 /* Return true if symbol is known to be nonzero. */
373 bool nonzero_address ();
375 /* Return 0 if symbol is known to have different address than S2,
376 Return 1 if symbol is known to have same address as S2,
377 return 2 otherwise.
379 If MEMORY_ACCESSED is true, assume that both memory pointer to THIS
380 and S2 is going to be accessed. This eliminates the situations when
381 either THIS or S2 is NULL and is seful for comparing bases when deciding
382 about memory aliasing. */
383 int equal_address_to (symtab_node *s2, bool memory_accessed = false);
385 /* Return true if symbol's address may possibly be compared to other
386 symbol's address. */
387 bool address_matters_p ();
389 /* Return true if NODE's address can be compared. This use properties
390 of NODE only and does not look if the address is actually taken in
391 interesting way. For that use ADDRESS_MATTERS_P instead. */
392 bool address_can_be_compared_p (void);
394 /* Return symbol table node associated with DECL, if any,
395 and NULL otherwise. */
396 static inline symtab_node *get (const_tree decl)
398 /* Check that we are called for sane type of object - functions
399 and static or external variables. */
400 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL
401 || (TREE_CODE (decl) == VAR_DECL
402 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl)
403 || in_lto_p)));
404 /* Check that the mapping is sane - perhaps this check can go away,
405 but at the moment frontends tends to corrupt the mapping by calling
406 memcpy/memset on the tree nodes. */
407 gcc_checking_assert (!decl->decl_with_vis.symtab_node
408 || decl->decl_with_vis.symtab_node->decl == decl);
409 return decl->decl_with_vis.symtab_node;
412 /* Try to find a symtab node for declaration DECL and if it does not
413 exist or if it corresponds to an inline clone, create a new one. */
414 static inline symtab_node * get_create (tree node);
416 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
417 Return NULL if there's no such node. */
418 static symtab_node *get_for_asmname (const_tree asmname);
420 /* Verify symbol table for internal consistency. */
421 static DEBUG_FUNCTION void verify_symtab_nodes (void);
423 /* Perform internal consistency checks, if they are enabled. */
424 static inline void checking_verify_symtab_nodes (void);
426 /* Type of the symbol. */
427 ENUM_BITFIELD (symtab_type) type : 8;
429 /* The symbols resolution. */
430 ENUM_BITFIELD (ld_plugin_symbol_resolution) resolution : 8;
432 /*** Flags representing the symbol type. ***/
434 /* True when symbol corresponds to a definition in current unit.
435 set via finalize_function or finalize_decl */
436 unsigned definition : 1;
437 /* True when symbol is an alias.
438 Set by ssemble_alias. */
439 unsigned alias : 1;
440 /* When true the alias is translated into its target symbol either by GCC
441 or assembler (it also may just be a duplicate declaration of the same
442 linker name).
444 Currently transparent aliases come in three different flavors
445 - aliases having the same assembler name as their target (aka duplicated
446 declarations). In this case the assembler names compare via
447 assembler_names_equal_p and weakref is false
448 - aliases that are renamed at a time being output to final file
449 by varasm.c. For those DECL_ASSEMBLER_NAME have
450 IDENTIFIER_TRANSPARENT_ALIAS set and thus also their assembler
451 name must be unique.
452 Weakrefs belong to this cateogry when we target assembler without
453 .weakref directive.
454 - weakrefs that are renamed by assembler via .weakref directive.
455 In this case the alias may or may not be definition (depending if
456 target declaration was seen by the compiler), weakref is set.
457 Unless we are before renaming statics, assembler names are different.
459 Given that we now support duplicate declarations, the second option is
460 redundant and will be removed. */
461 unsigned transparent_alias : 1;
462 /* True when alias is a weakref. */
463 unsigned weakref : 1;
464 /* C++ frontend produce same body aliases and extra name aliases for
465 virtual functions and vtables that are obviously equivalent.
466 Those aliases are bit special, especially because C++ frontend
467 visibility code is so ugly it can not get them right at first time
468 and their visibility needs to be copied from their "masters" at
469 the end of parsing. */
470 unsigned cpp_implicit_alias : 1;
471 /* Set once the definition was analyzed. The list of references and
472 other properties are built during analysis. */
473 unsigned analyzed : 1;
474 /* Set for write-only variables. */
475 unsigned writeonly : 1;
476 /* Visibility of symbol was used for further optimization; do not
477 permit further changes. */
478 unsigned refuse_visibility_changes : 1;
480 /*** Visibility and linkage flags. ***/
482 /* Set when function is visible by other units. */
483 unsigned externally_visible : 1;
484 /* Don't reorder to other symbols having this set. */
485 unsigned no_reorder : 1;
486 /* The symbol will be assumed to be used in an invisible way (like
487 by an toplevel asm statement). */
488 unsigned force_output : 1;
489 /* Like FORCE_OUTPUT, but in the case it is ABI requiring the symbol to be
490 exported. Unlike FORCE_OUTPUT this flag gets cleared to symbols promoted
491 to static and it does not inhibit optimization. */
492 unsigned forced_by_abi : 1;
493 /* True when the name is known to be unique and thus it does not need mangling. */
494 unsigned unique_name : 1;
495 /* Specify whether the section was set by user or by
496 compiler via -ffunction-sections. */
497 unsigned implicit_section : 1;
498 /* True when body and other characteristics have been removed by
499 symtab_remove_unreachable_nodes. */
500 unsigned body_removed : 1;
502 /*** WHOPR Partitioning flags.
503 These flags are used at ltrans stage when only part of the callgraph is
504 available. ***/
506 /* Set when variable is used from other LTRANS partition. */
507 unsigned used_from_other_partition : 1;
508 /* Set when function is available in the other LTRANS partition.
509 During WPA output it is used to mark nodes that are present in
510 multiple partitions. */
511 unsigned in_other_partition : 1;
515 /*** other flags. ***/
517 /* Set when symbol has address taken. */
518 unsigned address_taken : 1;
519 /* Set when init priority is set. */
520 unsigned in_init_priority_hash : 1;
522 /* Set when symbol needs to be streamed into LTO bytecode for LTO, or in case
523 of offloading, for separate compilation for a different target. */
524 unsigned need_lto_streaming : 1;
526 /* Set when symbol can be streamed into bytecode for offloading. */
527 unsigned offloadable : 1;
530 /* Ordering of all symtab entries. */
531 int order;
533 /* Declaration representing the symbol. */
534 tree decl;
536 /* Linked list of symbol table entries starting with symtab_nodes. */
537 symtab_node *next;
538 symtab_node *previous;
540 /* Linked list of symbols with the same asm name. There may be multiple
541 entries for single symbol name during LTO, because symbols are renamed
542 only after partitioning.
544 Because inline clones are kept in the assembler name has, they also produce
545 duplicate entries.
547 There are also several long standing bugs where frontends and builtin
548 code produce duplicated decls. */
549 symtab_node *next_sharing_asm_name;
550 symtab_node *previous_sharing_asm_name;
552 /* Circular list of nodes in the same comdat group if non-NULL. */
553 symtab_node *same_comdat_group;
555 /* Vectors of referring and referenced entities. */
556 ipa_ref_list ref_list;
558 /* Alias target. May be either DECL pointer or ASSEMBLER_NAME pointer
559 depending to what was known to frontend on the creation time.
560 Once alias is resolved, this pointer become NULL. */
561 tree alias_target;
563 /* File stream where this node is being written to. */
564 struct lto_file_decl_data * lto_file_data;
566 PTR GTY ((skip)) aux;
568 /* Comdat group the symbol is in. Can be private if GGC allowed that. */
569 tree x_comdat_group;
571 /* Section name. Again can be private, if allowed. */
572 section_hash_entry *x_section;
574 protected:
575 /* Dump base fields of symtab nodes to F. Not to be used directly. */
576 void dump_base (FILE *);
578 /* Verify common part of symtab node. */
579 bool DEBUG_FUNCTION verify_base (void);
581 /* Remove node from symbol table. This function is not used directly, but via
582 cgraph/varpool node removal routines. */
583 void unregister (void);
585 /* Return the initialization and finalization priority information for
586 DECL. If there is no previous priority information, a freshly
587 allocated structure is returned. */
588 struct symbol_priority_map *priority_info (void);
590 /* Worker for call_for_symbol_and_aliases_1. */
591 bool call_for_symbol_and_aliases_1 (bool (*callback) (symtab_node *, void *),
592 void *data,
593 bool include_overwrite);
594 private:
595 /* Worker for set_section. */
596 static bool set_section (symtab_node *n, void *s);
598 /* Worker for symtab_resolve_alias. */
599 static bool set_implicit_section (symtab_node *n, void *);
601 /* Worker searching noninterposable alias. */
602 static bool noninterposable_alias (symtab_node *node, void *data);
604 /* Worker for ultimate_alias_target. */
605 symtab_node *ultimate_alias_target_1 (enum availability *avail = NULL,
606 symtab_node *ref = NULL);
608 /* Get dump name with normal or assembly name. */
609 const char *get_dump_name (bool asm_name_p) const;
612 inline void
613 symtab_node::checking_verify_symtab_nodes (void)
615 if (flag_checking)
616 symtab_node::verify_symtab_nodes ();
619 /* Walk all aliases for NODE. */
620 #define FOR_EACH_ALIAS(node, alias) \
621 for (unsigned x_i = 0; node->iterate_direct_aliases (x_i, alias); x_i++)
623 /* This is the information that is put into the cgraph local structure
624 to recover a function. */
625 struct lto_file_decl_data;
627 extern const char * const cgraph_availability_names[];
628 extern const char * const ld_plugin_symbol_resolution_names[];
629 extern const char * const tls_model_names[];
631 /* Information about thunk, used only for same body aliases. */
633 struct GTY(()) cgraph_thunk_info {
634 /* Information about the thunk. */
635 HOST_WIDE_INT fixed_offset;
636 HOST_WIDE_INT virtual_value;
637 tree alias;
638 bool this_adjusting;
639 bool virtual_offset_p;
640 bool add_pointer_bounds_args;
641 /* Set to true when alias node is thunk. */
642 bool thunk_p;
645 /* Information about the function collected locally.
646 Available after function is analyzed. */
648 struct GTY(()) cgraph_local_info {
649 /* Set when function is visible in current compilation unit only and
650 its address is never taken. */
651 unsigned local : 1;
653 /* False when there is something makes versioning impossible. */
654 unsigned versionable : 1;
656 /* False when function calling convention and signature can not be changed.
657 This is the case when __builtin_apply_args is used. */
658 unsigned can_change_signature : 1;
660 /* True when the function has been originally extern inline, but it is
661 redefined now. */
662 unsigned redefined_extern_inline : 1;
664 /* True if the function may enter serial irrevocable mode. */
665 unsigned tm_may_enter_irr : 1;
668 /* Information about the function that needs to be computed globally
669 once compilation is finished. Available only with -funit-at-a-time. */
671 struct GTY(()) cgraph_global_info {
672 /* For inline clones this points to the function they will be
673 inlined into. */
674 cgraph_node *inlined_to;
677 /* Represent which DECL tree (or reference to such tree)
678 will be replaced by another tree while versioning. */
679 struct GTY(()) ipa_replace_map
681 /* The tree that will be replaced. */
682 tree old_tree;
683 /* The new (replacing) tree. */
684 tree new_tree;
685 /* Parameter number to replace, when old_tree is NULL. */
686 int parm_num;
687 /* True when a substitution should be done, false otherwise. */
688 bool replace_p;
689 /* True when we replace a reference to old_tree. */
690 bool ref_p;
693 struct GTY(()) cgraph_clone_info
695 vec<ipa_replace_map *, va_gc> *tree_map;
696 bitmap args_to_skip;
697 bitmap combined_args_to_skip;
700 enum cgraph_simd_clone_arg_type
702 SIMD_CLONE_ARG_TYPE_VECTOR,
703 SIMD_CLONE_ARG_TYPE_UNIFORM,
704 /* These are only for integer/pointer arguments passed by value. */
705 SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP,
706 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP,
707 /* These 6 are only for reference type arguments or arguments passed
708 by reference. */
709 SIMD_CLONE_ARG_TYPE_LINEAR_REF_CONSTANT_STEP,
710 SIMD_CLONE_ARG_TYPE_LINEAR_REF_VARIABLE_STEP,
711 SIMD_CLONE_ARG_TYPE_LINEAR_UVAL_CONSTANT_STEP,
712 SIMD_CLONE_ARG_TYPE_LINEAR_UVAL_VARIABLE_STEP,
713 SIMD_CLONE_ARG_TYPE_LINEAR_VAL_CONSTANT_STEP,
714 SIMD_CLONE_ARG_TYPE_LINEAR_VAL_VARIABLE_STEP,
715 SIMD_CLONE_ARG_TYPE_MASK
718 /* Function arguments in the original function of a SIMD clone.
719 Supplementary data for `struct simd_clone'. */
721 struct GTY(()) cgraph_simd_clone_arg {
722 /* Original function argument as it originally existed in
723 DECL_ARGUMENTS. */
724 tree orig_arg;
726 /* orig_arg's function (or for extern functions type from
727 TYPE_ARG_TYPES). */
728 tree orig_type;
730 /* If argument is a vector, this holds the vector version of
731 orig_arg that after adjusting the argument types will live in
732 DECL_ARGUMENTS. Otherwise, this is NULL.
734 This basically holds:
735 vector(simdlen) __typeof__(orig_arg) new_arg. */
736 tree vector_arg;
738 /* vector_arg's type (or for extern functions new vector type. */
739 tree vector_type;
741 /* If argument is a vector, this holds the array where the simd
742 argument is held while executing the simd clone function. This
743 is a local variable in the cloned function. Its content is
744 copied from vector_arg upon entry to the clone.
746 This basically holds:
747 __typeof__(orig_arg) simd_array[simdlen]. */
748 tree simd_array;
750 /* A SIMD clone's argument can be either linear (constant or
751 variable), uniform, or vector. */
752 enum cgraph_simd_clone_arg_type arg_type;
754 /* For arg_type SIMD_CLONE_ARG_TYPE_LINEAR_*CONSTANT_STEP this is
755 the constant linear step, if arg_type is
756 SIMD_CLONE_ARG_TYPE_LINEAR_*VARIABLE_STEP, this is index of
757 the uniform argument holding the step, otherwise 0. */
758 HOST_WIDE_INT linear_step;
760 /* Variable alignment if available, otherwise 0. */
761 unsigned int alignment;
764 /* Specific data for a SIMD function clone. */
766 struct GTY(()) cgraph_simd_clone {
767 /* Number of words in the SIMD lane associated with this clone. */
768 unsigned int simdlen;
770 /* Number of annotated function arguments in `args'. This is
771 usually the number of named arguments in FNDECL. */
772 unsigned int nargs;
774 /* Max hardware vector size in bits for integral vectors. */
775 unsigned int vecsize_int;
777 /* Max hardware vector size in bits for floating point vectors. */
778 unsigned int vecsize_float;
780 /* Machine mode of the mask argument(s), if they are to be passed
781 as bitmasks in integer argument(s). VOIDmode if masks are passed
782 as vectors of characteristic type. */
783 machine_mode mask_mode;
785 /* The mangling character for a given vector size. This is used
786 to determine the ISA mangling bit as specified in the Intel
787 Vector ABI. */
788 unsigned char vecsize_mangle;
790 /* True if this is the masked, in-branch version of the clone,
791 otherwise false. */
792 unsigned int inbranch : 1;
794 /* True if this is a Cilk Plus variant. */
795 unsigned int cilk_elemental : 1;
797 /* Doubly linked list of SIMD clones. */
798 cgraph_node *prev_clone, *next_clone;
800 /* Original cgraph node the SIMD clones were created for. */
801 cgraph_node *origin;
803 /* Annotated function arguments for the original function. */
804 cgraph_simd_clone_arg GTY((length ("%h.nargs"))) args[1];
807 /* Function Multiversioning info. */
808 struct GTY((for_user)) cgraph_function_version_info {
809 /* The cgraph_node for which the function version info is stored. */
810 cgraph_node *this_node;
811 /* Chains all the semantically identical function versions. The
812 first function in this chain is the version_info node of the
813 default function. */
814 cgraph_function_version_info *prev;
815 /* If this version node corresponds to a dispatcher for function
816 versions, this points to the version info node of the default
817 function, the first node in the chain. */
818 cgraph_function_version_info *next;
819 /* If this node corresponds to a function version, this points
820 to the dispatcher function decl, which is the function that must
821 be called to execute the right function version at run-time.
823 If this cgraph node is a dispatcher (if dispatcher_function is
824 true, in the cgraph_node struct) for function versions, this
825 points to resolver function, which holds the function body of the
826 dispatcher. The dispatcher decl is an alias to the resolver
827 function decl. */
828 tree dispatcher_resolver;
831 #define DEFCIFCODE(code, type, string) CIF_ ## code,
832 /* Reasons for inlining failures. */
834 enum cgraph_inline_failed_t {
835 #include "cif-code.def"
836 CIF_N_REASONS
839 enum cgraph_inline_failed_type_t
841 CIF_FINAL_NORMAL = 0,
842 CIF_FINAL_ERROR
845 struct cgraph_edge;
847 struct cgraph_edge_hasher : ggc_ptr_hash<cgraph_edge>
849 typedef gimple *compare_type;
851 static hashval_t hash (cgraph_edge *);
852 static hashval_t hash (gimple *);
853 static bool equal (cgraph_edge *, gimple *);
856 /* The cgraph data structure.
857 Each function decl has assigned cgraph_node listing callees and callers. */
859 struct GTY((tag ("SYMTAB_FUNCTION"))) cgraph_node : public symtab_node {
860 public:
861 /* Remove the node from cgraph and all inline clones inlined into it.
862 Skip however removal of FORBIDDEN_NODE and return true if it needs to be
863 removed. This allows to call the function from outer loop walking clone
864 tree. */
865 bool remove_symbol_and_inline_clones (cgraph_node *forbidden_node = NULL);
867 /* Record all references from cgraph_node that are taken
868 in statement STMT. */
869 void record_stmt_references (gimple *stmt);
871 /* Like cgraph_set_call_stmt but walk the clone tree and update all
872 clones sharing the same function body.
873 When WHOLE_SPECULATIVE_EDGES is true, all three components of
874 speculative edge gets updated. Otherwise we update only direct
875 call. */
876 void set_call_stmt_including_clones (gimple *old_stmt, gcall *new_stmt,
877 bool update_speculative = true);
879 /* Walk the alias chain to return the function cgraph_node is alias of.
880 Walk through thunk, too.
881 When AVAILABILITY is non-NULL, get minimal availability in the chain.
882 When REF is non-NULL, assume that reference happens in symbol REF
883 when determining the availability. */
884 cgraph_node *function_symbol (enum availability *avail = NULL,
885 struct symtab_node *ref = NULL);
887 /* Walk the alias chain to return the function cgraph_node is alias of.
888 Walk through non virtual thunks, too. Thus we return either a function
889 or a virtual thunk node.
890 When AVAILABILITY is non-NULL, get minimal availability in the chain.
891 When REF is non-NULL, assume that reference happens in symbol REF
892 when determining the availability. */
893 cgraph_node *function_or_virtual_thunk_symbol
894 (enum availability *avail = NULL,
895 struct symtab_node *ref = NULL);
897 /* Create node representing clone of N executed COUNT times. Decrease
898 the execution counts from original node too.
899 The new clone will have decl set to DECL that may or may not be the same
900 as decl of N.
902 When UPDATE_ORIGINAL is true, the counts are subtracted from the original
903 function's profile to reflect the fact that part of execution is handled
904 by node.
905 When CALL_DUPLICATOIN_HOOK is true, the ipa passes are acknowledged about
906 the new clone. Otherwise the caller is responsible for doing so later.
908 If the new node is being inlined into another one, NEW_INLINED_TO should be
909 the outline function the new one is (even indirectly) inlined to.
910 All hooks will see this in node's global.inlined_to, when invoked.
911 Can be NULL if the node is not inlined. SUFFIX is string that is appended
912 to the original name. */
913 cgraph_node *create_clone (tree decl, gcov_type count, int freq,
914 bool update_original,
915 vec<cgraph_edge *> redirect_callers,
916 bool call_duplication_hook,
917 cgraph_node *new_inlined_to,
918 bitmap args_to_skip, const char *suffix = NULL);
920 /* Create callgraph node clone with new declaration. The actual body will
921 be copied later at compilation stage. */
922 cgraph_node *create_virtual_clone (vec<cgraph_edge *> redirect_callers,
923 vec<ipa_replace_map *, va_gc> *tree_map,
924 bitmap args_to_skip, const char * suffix);
926 /* cgraph node being removed from symbol table; see if its entry can be
927 replaced by other inline clone. */
928 cgraph_node *find_replacement (void);
930 /* Create a new cgraph node which is the new version of
931 callgraph node. REDIRECT_CALLERS holds the callers
932 edges which should be redirected to point to
933 NEW_VERSION. ALL the callees edges of the node
934 are cloned to the new version node. Return the new
935 version node.
937 If non-NULL BLOCK_TO_COPY determine what basic blocks
938 was copied to prevent duplications of calls that are dead
939 in the clone.
941 SUFFIX is string that is appended to the original name. */
943 cgraph_node *create_version_clone (tree new_decl,
944 vec<cgraph_edge *> redirect_callers,
945 bitmap bbs_to_copy,
946 const char *suffix = NULL);
948 /* Perform function versioning.
949 Function versioning includes copying of the tree and
950 a callgraph update (creating a new cgraph node and updating
951 its callees and callers).
953 REDIRECT_CALLERS varray includes the edges to be redirected
954 to the new version.
956 TREE_MAP is a mapping of tree nodes we want to replace with
957 new ones (according to results of prior analysis).
959 If non-NULL ARGS_TO_SKIP determine function parameters to remove
960 from new version.
961 If SKIP_RETURN is true, the new version will return void.
962 If non-NULL BLOCK_TO_COPY determine what basic blocks to copy.
963 If non_NULL NEW_ENTRY determine new entry BB of the clone.
965 Return the new version's cgraph node. */
966 cgraph_node *create_version_clone_with_body
967 (vec<cgraph_edge *> redirect_callers,
968 vec<ipa_replace_map *, va_gc> *tree_map, bitmap args_to_skip,
969 bool skip_return, bitmap bbs_to_copy, basic_block new_entry_block,
970 const char *clone_name);
972 /* Insert a new cgraph_function_version_info node into cgraph_fnver_htab
973 corresponding to cgraph_node. */
974 cgraph_function_version_info *insert_new_function_version (void);
976 /* Get the cgraph_function_version_info node corresponding to node. */
977 cgraph_function_version_info *function_version (void);
979 /* Discover all functions and variables that are trivially needed, analyze
980 them as well as all functions and variables referred by them */
981 void analyze (void);
983 /* Add thunk alias into callgraph. The alias declaration is ALIAS and it
984 aliases DECL with an adjustments made into the first parameter.
985 See comments in thunk_adjust for detail on the parameters. */
986 cgraph_node * create_thunk (tree alias, tree, bool this_adjusting,
987 HOST_WIDE_INT fixed_offset,
988 HOST_WIDE_INT virtual_value,
989 tree virtual_offset,
990 tree real_alias);
993 /* Return node that alias is aliasing. */
994 inline cgraph_node *get_alias_target (void);
996 /* Given function symbol, walk the alias chain to return the function node
997 is alias of. Do not walk through thunks.
998 When AVAILABILITY is non-NULL, get minimal availability in the chain.
999 When REF is non-NULL, assume that reference happens in symbol REF
1000 when determining the availability. */
1002 cgraph_node *ultimate_alias_target (availability *availability = NULL,
1003 symtab_node *ref = NULL);
1005 /* Expand thunk NODE to gimple if possible.
1006 When FORCE_GIMPLE_THUNK is true, gimple thunk is created and
1007 no assembler is produced.
1008 When OUTPUT_ASM_THUNK is true, also produce assembler for
1009 thunks that are not lowered. */
1010 bool expand_thunk (bool output_asm_thunks, bool force_gimple_thunk);
1012 /* Call expand_thunk on all callers that are thunks and analyze those
1013 nodes that were expanded. */
1014 void expand_all_artificial_thunks ();
1016 /* Assemble thunks and aliases associated to node. */
1017 void assemble_thunks_and_aliases (void);
1019 /* Expand function specified by node. */
1020 void expand (void);
1022 /* As an GCC extension we allow redefinition of the function. The
1023 semantics when both copies of bodies differ is not well defined.
1024 We replace the old body with new body so in unit at a time mode
1025 we always use new body, while in normal mode we may end up with
1026 old body inlined into some functions and new body expanded and
1027 inlined in others. */
1028 void reset (void);
1030 /* Creates a wrapper from cgraph_node to TARGET node. Thunk is used for this
1031 kind of wrapper method. */
1032 void create_wrapper (cgraph_node *target);
1034 /* Verify cgraph nodes of the cgraph node. */
1035 void DEBUG_FUNCTION verify_node (void);
1037 /* Remove function from symbol table. */
1038 void remove (void);
1040 /* Dump call graph node to file F. */
1041 void dump (FILE *f);
1043 /* Dump call graph node to stderr. */
1044 void DEBUG_FUNCTION debug (void);
1046 /* When doing LTO, read cgraph_node's body from disk if it is not already
1047 present. */
1048 bool get_untransformed_body (void);
1050 /* Prepare function body. When doing LTO, read cgraph_node's body from disk
1051 if it is not already present. When some IPA transformations are scheduled,
1052 apply them. */
1053 bool get_body (void);
1055 /* Release memory used to represent body of function.
1056 Use this only for functions that are released before being translated to
1057 target code (i.e. RTL). Functions that are compiled to RTL and beyond
1058 are free'd in final.c via free_after_compilation(). */
1059 void release_body (bool keep_arguments = false);
1061 /* Return the DECL_STRUCT_FUNCTION of the function. */
1062 struct function *get_fun (void);
1064 /* cgraph_node is no longer nested function; update cgraph accordingly. */
1065 void unnest (void);
1067 /* Bring cgraph node local. */
1068 void make_local (void);
1070 /* Likewise indicate that a node is having address taken. */
1071 void mark_address_taken (void);
1073 /* Set fialization priority to PRIORITY. */
1074 void set_fini_priority (priority_type priority);
1076 /* Return the finalization priority. */
1077 priority_type get_fini_priority (void);
1079 /* Create edge from a given function to CALLEE in the cgraph. */
1080 cgraph_edge *create_edge (cgraph_node *callee,
1081 gcall *call_stmt, gcov_type count,
1082 int freq);
1084 /* Create an indirect edge with a yet-undetermined callee where the call
1085 statement destination is a formal parameter of the caller with index
1086 PARAM_INDEX. */
1087 cgraph_edge *create_indirect_edge (gcall *call_stmt, int ecf_flags,
1088 gcov_type count, int freq,
1089 bool compute_indirect_info = true);
1091 /* Like cgraph_create_edge walk the clone tree and update all clones sharing
1092 same function body. If clones already have edge for OLD_STMT; only
1093 update the edge same way as cgraph_set_call_stmt_including_clones does. */
1094 void create_edge_including_clones (cgraph_node *callee,
1095 gimple *old_stmt, gcall *stmt,
1096 gcov_type count,
1097 int freq,
1098 cgraph_inline_failed_t reason);
1100 /* Return the callgraph edge representing the GIMPLE_CALL statement
1101 CALL_STMT. */
1102 cgraph_edge *get_edge (gimple *call_stmt);
1104 /* Collect all callers of cgraph_node and its aliases that are known to lead
1105 to NODE (i.e. are not overwritable) and that are not thunks. */
1106 vec<cgraph_edge *> collect_callers (void);
1108 /* Remove all callers from the node. */
1109 void remove_callers (void);
1111 /* Remove all callees from the node. */
1112 void remove_callees (void);
1114 /* Return function availability. See cgraph.h for description of individual
1115 return values. */
1116 enum availability get_availability (symtab_node *ref = NULL);
1118 /* Set TREE_NOTHROW on cgraph_node's decl and on aliases of the node
1119 if any to NOTHROW. */
1120 bool set_nothrow_flag (bool nothrow);
1122 /* If SET_CONST is true, mark function, aliases and thunks to be ECF_CONST.
1123 If SET_CONST if false, clear the flag.
1125 When setting the flag be careful about possible interposition and
1126 do not set the flag for functions that can be interposet and set pure
1127 flag for functions that can bind to other definition.
1129 Return true if any change was done. */
1131 bool set_const_flag (bool set_const, bool looping);
1133 /* Set DECL_PURE_P on cgraph_node's decl and on aliases of the node
1134 if any to PURE.
1136 When setting the flag, be careful about possible interposition.
1137 Return true if any change was done. */
1139 bool set_pure_flag (bool pure, bool looping);
1141 /* Call callback on function and aliases associated to the function.
1142 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1143 skipped. */
1145 bool call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
1146 void *),
1147 void *data, bool include_overwritable);
1149 /* Call callback on cgraph_node, thunks and aliases associated to NODE.
1150 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1151 skipped. When EXCLUDE_VIRTUAL_THUNKS is true, virtual thunks are
1152 skipped. */
1153 bool call_for_symbol_thunks_and_aliases (bool (*callback) (cgraph_node *node,
1154 void *data),
1155 void *data,
1156 bool include_overwritable,
1157 bool exclude_virtual_thunks = false);
1159 /* Likewise indicate that a node is needed, i.e. reachable via some
1160 external means. */
1161 inline void mark_force_output (void);
1163 /* Return true when function can be marked local. */
1164 bool local_p (void);
1166 /* Return true if cgraph_node can be made local for API change.
1167 Extern inline functions and C++ COMDAT functions can be made local
1168 at the expense of possible code size growth if function is used in multiple
1169 compilation units. */
1170 bool can_be_local_p (void);
1172 /* Return true when cgraph_node can not return or throw and thus
1173 it is safe to ignore its side effects for IPA analysis. */
1174 bool cannot_return_p (void);
1176 /* Return true when function cgraph_node and all its aliases are only called
1177 directly.
1178 i.e. it is not externally visible, address was not taken and
1179 it is not used in any other non-standard way. */
1180 bool only_called_directly_p (void);
1182 /* Return true when function is only called directly or it has alias.
1183 i.e. it is not externally visible, address was not taken and
1184 it is not used in any other non-standard way. */
1185 inline bool only_called_directly_or_aliased_p (void);
1187 /* Return true when function cgraph_node can be expected to be removed
1188 from program when direct calls in this compilation unit are removed.
1190 As a special case COMDAT functions are
1191 cgraph_can_remove_if_no_direct_calls_p while the are not
1192 cgraph_only_called_directly_p (it is possible they are called from other
1193 unit)
1195 This function behaves as cgraph_only_called_directly_p because eliminating
1196 all uses of COMDAT function does not make it necessarily disappear from
1197 the program unless we are compiling whole program or we do LTO. In this
1198 case we know we win since dynamic linking will not really discard the
1199 linkonce section.
1201 If WILL_INLINE is true, assume that function will be inlined into all the
1202 direct calls. */
1203 bool will_be_removed_from_program_if_no_direct_calls_p
1204 (bool will_inline = false);
1206 /* Return true when function can be removed from callgraph
1207 if all direct calls and references are eliminated. The function does
1208 not take into account comdat groups. */
1209 bool can_remove_if_no_direct_calls_and_refs_p (void);
1211 /* Return true when function cgraph_node and its aliases can be removed from
1212 callgraph if all direct calls are eliminated.
1213 If WILL_INLINE is true, assume that function will be inlined into all the
1214 direct calls. */
1215 bool can_remove_if_no_direct_calls_p (bool will_inline = false);
1217 /* Return true when callgraph node is a function with Gimple body defined
1218 in current unit. Functions can also be define externally or they
1219 can be thunks with no Gimple representation.
1221 Note that at WPA stage, the function body may not be present in memory. */
1222 inline bool has_gimple_body_p (void);
1224 /* Return true if function should be optimized for size. */
1225 bool optimize_for_size_p (void);
1227 /* Dump the callgraph to file F. */
1228 static void dump_cgraph (FILE *f);
1230 /* Dump the call graph to stderr. */
1231 static inline
1232 void debug_cgraph (void)
1234 dump_cgraph (stderr);
1237 /* Record that DECL1 and DECL2 are semantically identical function
1238 versions. */
1239 static void record_function_versions (tree decl1, tree decl2);
1241 /* Remove the cgraph_function_version_info and cgraph_node for DECL. This
1242 DECL is a duplicate declaration. */
1243 static void delete_function_version (tree decl);
1245 /* Add the function FNDECL to the call graph.
1246 Unlike finalize_function, this function is intended to be used
1247 by middle end and allows insertion of new function at arbitrary point
1248 of compilation. The function can be either in high, low or SSA form
1249 GIMPLE.
1251 The function is assumed to be reachable and have address taken (so no
1252 API breaking optimizations are performed on it).
1254 Main work done by this function is to enqueue the function for later
1255 processing to avoid need the passes to be re-entrant. */
1256 static void add_new_function (tree fndecl, bool lowered);
1258 /* Return callgraph node for given symbol and check it is a function. */
1259 static inline cgraph_node *get (const_tree decl)
1261 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL);
1262 return dyn_cast <cgraph_node *> (symtab_node::get (decl));
1265 /* DECL has been parsed. Take it, queue it, compile it at the whim of the
1266 logic in effect. If NO_COLLECT is true, then our caller cannot stand to
1267 have the garbage collector run at the moment. We would need to either
1268 create a new GC context, or just not compile right now. */
1269 static void finalize_function (tree, bool);
1271 /* Return cgraph node assigned to DECL. Create new one when needed. */
1272 static cgraph_node * create (tree decl);
1274 /* Try to find a call graph node for declaration DECL and if it does not
1275 exist or if it corresponds to an inline clone, create a new one. */
1276 static cgraph_node * get_create (tree);
1278 /* Return local info for the compiled function. */
1279 static cgraph_local_info *local_info (tree decl);
1281 /* Return local info for the compiled function. */
1282 static struct cgraph_rtl_info *rtl_info (tree);
1284 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
1285 Return NULL if there's no such node. */
1286 static cgraph_node *get_for_asmname (tree asmname);
1288 /* Attempt to mark ALIAS as an alias to DECL. Return alias node if
1289 successful and NULL otherwise.
1290 Same body aliases are output whenever the body of DECL is output,
1291 and cgraph_node::get (ALIAS) transparently
1292 returns cgraph_node::get (DECL). */
1293 static cgraph_node * create_same_body_alias (tree alias, tree decl);
1295 /* Verify whole cgraph structure. */
1296 static void DEBUG_FUNCTION verify_cgraph_nodes (void);
1298 /* Verify cgraph, if consistency checking is enabled. */
1299 static inline void checking_verify_cgraph_nodes (void);
1301 /* Worker to bring NODE local. */
1302 static bool make_local (cgraph_node *node, void *);
1304 /* Mark ALIAS as an alias to DECL. DECL_NODE is cgraph node representing
1305 the function body is associated
1306 with (not necessarily cgraph_node (DECL). */
1307 static cgraph_node *create_alias (tree alias, tree target);
1309 /* Return true if NODE has thunk. */
1310 static bool has_thunk_p (cgraph_node *node, void *);
1312 cgraph_edge *callees;
1313 cgraph_edge *callers;
1314 /* List of edges representing indirect calls with a yet undetermined
1315 callee. */
1316 cgraph_edge *indirect_calls;
1317 /* For nested functions points to function the node is nested in. */
1318 cgraph_node *origin;
1319 /* Points to first nested function, if any. */
1320 cgraph_node *nested;
1321 /* Pointer to the next function with same origin, if any. */
1322 cgraph_node *next_nested;
1323 /* Pointer to the next clone. */
1324 cgraph_node *next_sibling_clone;
1325 cgraph_node *prev_sibling_clone;
1326 cgraph_node *clones;
1327 cgraph_node *clone_of;
1328 /* If instrumentation_clone is 1 then instrumented_version points
1329 to the original function used to make instrumented version.
1330 Otherwise points to instrumented version of the function. */
1331 cgraph_node *instrumented_version;
1332 /* If instrumentation_clone is 1 then orig_decl is the original
1333 function declaration. */
1334 tree orig_decl;
1335 /* For functions with many calls sites it holds map from call expression
1336 to the edge to speed up cgraph_edge function. */
1337 hash_table<cgraph_edge_hasher> *GTY(()) call_site_hash;
1338 /* Declaration node used to be clone of. */
1339 tree former_clone_of;
1341 /* If this is a SIMD clone, this points to the SIMD specific
1342 information for it. */
1343 cgraph_simd_clone *simdclone;
1344 /* If this function has SIMD clones, this points to the first clone. */
1345 cgraph_node *simd_clones;
1347 /* Interprocedural passes scheduled to have their transform functions
1348 applied next time we execute local pass on them. We maintain it
1349 per-function in order to allow IPA passes to introduce new functions. */
1350 vec<ipa_opt_pass> GTY((skip)) ipa_transforms_to_apply;
1352 cgraph_local_info local;
1353 cgraph_global_info global;
1354 struct cgraph_rtl_info *rtl;
1355 cgraph_clone_info clone;
1356 cgraph_thunk_info thunk;
1358 /* Expected number of executions: calculated in profile.c. */
1359 gcov_type count;
1360 /* How to scale counts at materialization time; used to merge
1361 LTO units with different number of profile runs. */
1362 int count_materialization_scale;
1363 /* Unique id of the node. */
1364 int uid;
1365 /* Summary unique id of the node. */
1366 int summary_uid;
1367 /* ID assigned by the profiling. */
1368 unsigned int profile_id;
1369 /* Time profiler: first run of function. */
1370 int tp_first_run;
1372 /* Set when decl is an abstract function pointed to by the
1373 ABSTRACT_DECL_ORIGIN of a reachable function. */
1374 unsigned used_as_abstract_origin : 1;
1375 /* Set once the function is lowered (i.e. its CFG is built). */
1376 unsigned lowered : 1;
1377 /* Set once the function has been instantiated and its callee
1378 lists created. */
1379 unsigned process : 1;
1380 /* How commonly executed the node is. Initialized during branch
1381 probabilities pass. */
1382 ENUM_BITFIELD (node_frequency) frequency : 2;
1383 /* True when function can only be called at startup (from static ctor). */
1384 unsigned only_called_at_startup : 1;
1385 /* True when function can only be called at startup (from static dtor). */
1386 unsigned only_called_at_exit : 1;
1387 /* True when function is the transactional clone of a function which
1388 is called only from inside transactions. */
1389 /* ?? We should be able to remove this. We have enough bits in
1390 cgraph to calculate it. */
1391 unsigned tm_clone : 1;
1392 /* True if this decl is a dispatcher for function versions. */
1393 unsigned dispatcher_function : 1;
1394 /* True if this decl calls a COMDAT-local function. This is set up in
1395 compute_fn_summary and inline_call. */
1396 unsigned calls_comdat_local : 1;
1397 /* True if node has been created by merge operation in IPA-ICF. */
1398 unsigned icf_merged: 1;
1399 /* True when function is clone created for Pointer Bounds Checker
1400 instrumentation. */
1401 unsigned instrumentation_clone : 1;
1402 /* True if call to node can't result in a call to free, munmap or
1403 other operation that could make previously non-trapping memory
1404 accesses trapping. */
1405 unsigned nonfreeing_fn : 1;
1406 /* True if there was multiple COMDAT bodies merged by lto-symtab. */
1407 unsigned merged_comdat : 1;
1408 /* True if function was created to be executed in parallel. */
1409 unsigned parallelized_function : 1;
1410 /* True if function is part split out by ipa-split. */
1411 unsigned split_part : 1;
1412 /* True if the function appears as possible target of indirect call. */
1413 unsigned indirect_call_target : 1;
1415 private:
1416 /* Worker for call_for_symbol_and_aliases. */
1417 bool call_for_symbol_and_aliases_1 (bool (*callback) (cgraph_node *,
1418 void *),
1419 void *data, bool include_overwritable);
1422 /* A cgraph node set is a collection of cgraph nodes. A cgraph node
1423 can appear in multiple sets. */
1424 struct cgraph_node_set_def
1426 hash_map<cgraph_node *, size_t> *map;
1427 vec<cgraph_node *> nodes;
1430 typedef cgraph_node_set_def *cgraph_node_set;
1431 typedef struct varpool_node_set_def *varpool_node_set;
1433 class varpool_node;
1435 /* A varpool node set is a collection of varpool nodes. A varpool node
1436 can appear in multiple sets. */
1437 struct varpool_node_set_def
1439 hash_map<varpool_node *, size_t> * map;
1440 vec<varpool_node *> nodes;
1443 /* Iterator structure for cgraph node sets. */
1444 struct cgraph_node_set_iterator
1446 cgraph_node_set set;
1447 unsigned index;
1450 /* Iterator structure for varpool node sets. */
1451 struct varpool_node_set_iterator
1453 varpool_node_set set;
1454 unsigned index;
1457 /* Context of polymorphic call. It represent information about the type of
1458 instance that may reach the call. This is used by ipa-devirt walkers of the
1459 type inheritance graph. */
1461 class GTY(()) ipa_polymorphic_call_context {
1462 public:
1463 /* The called object appears in an object of type OUTER_TYPE
1464 at offset OFFSET. When information is not 100% reliable, we
1465 use SPECULATIVE_OUTER_TYPE and SPECULATIVE_OFFSET. */
1466 HOST_WIDE_INT offset;
1467 HOST_WIDE_INT speculative_offset;
1468 tree outer_type;
1469 tree speculative_outer_type;
1470 /* True if outer object may be in construction or destruction. */
1471 unsigned maybe_in_construction : 1;
1472 /* True if outer object may be of derived type. */
1473 unsigned maybe_derived_type : 1;
1474 /* True if speculative outer object may be of derived type. We always
1475 speculate that construction does not happen. */
1476 unsigned speculative_maybe_derived_type : 1;
1477 /* True if the context is invalid and all calls should be redirected
1478 to BUILTIN_UNREACHABLE. */
1479 unsigned invalid : 1;
1480 /* True if the outer type is dynamic. */
1481 unsigned dynamic : 1;
1483 /* Build empty "I know nothing" context. */
1484 ipa_polymorphic_call_context ();
1485 /* Build polymorphic call context for indirect call E. */
1486 ipa_polymorphic_call_context (cgraph_edge *e);
1487 /* Build polymorphic call context for IP invariant CST.
1488 If specified, OTR_TYPE specify the type of polymorphic call
1489 that takes CST+OFFSET as a prameter. */
1490 ipa_polymorphic_call_context (tree cst, tree otr_type = NULL,
1491 HOST_WIDE_INT offset = 0);
1492 /* Build context for pointer REF contained in FNDECL at statement STMT.
1493 if INSTANCE is non-NULL, return pointer to the object described by
1494 the context. */
1495 ipa_polymorphic_call_context (tree fndecl, tree ref, gimple *stmt,
1496 tree *instance = NULL);
1498 /* Look for vtable stores or constructor calls to work out dynamic type
1499 of memory location. */
1500 bool get_dynamic_type (tree, tree, tree, gimple *);
1502 /* Make context non-speculative. */
1503 void clear_speculation ();
1505 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
1506 NULL, the context is set to dummy "I know nothing" setting. */
1507 void clear_outer_type (tree otr_type = NULL);
1509 /* Walk container types and modify context to point to actual class
1510 containing OTR_TYPE (if non-NULL) as base class.
1511 Return true if resulting context is valid.
1513 When CONSIDER_PLACEMENT_NEW is false, reject contexts that may be made
1514 valid only via allocation of new polymorphic type inside by means
1515 of placement new.
1517 When CONSIDER_BASES is false, only look for actual fields, not base types
1518 of TYPE. */
1519 bool restrict_to_inner_class (tree otr_type,
1520 bool consider_placement_new = true,
1521 bool consider_bases = true);
1523 /* Adjust all offsets in contexts by given number of bits. */
1524 void offset_by (HOST_WIDE_INT);
1525 /* Use when we can not track dynamic type change. This speculatively assume
1526 type change is not happening. */
1527 void possible_dynamic_type_change (bool, tree otr_type = NULL);
1528 /* Assume that both THIS and a given context is valid and strenghten THIS
1529 if possible. Return true if any strenghtening was made.
1530 If actual type the context is being used in is known, OTR_TYPE should be
1531 set accordingly. This improves quality of combined result. */
1532 bool combine_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1533 bool meet_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1535 /* Return TRUE if context is fully useless. */
1536 bool useless_p () const;
1537 /* Return TRUE if this context conveys the same information as X. */
1538 bool equal_to (const ipa_polymorphic_call_context &x) const;
1540 /* Dump human readable context to F. If NEWLINE is true, it will be
1541 terminated by a newline. */
1542 void dump (FILE *f, bool newline = true) const;
1543 void DEBUG_FUNCTION debug () const;
1545 /* LTO streaming. */
1546 void stream_out (struct output_block *) const;
1547 void stream_in (struct lto_input_block *, struct data_in *data_in);
1549 private:
1550 bool combine_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1551 bool meet_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1552 void set_by_decl (tree, HOST_WIDE_INT);
1553 bool set_by_invariant (tree, tree, HOST_WIDE_INT);
1554 bool speculation_consistent_p (tree, HOST_WIDE_INT, bool, tree) const;
1555 void make_speculative (tree otr_type = NULL);
1558 /* Structure containing additional information about an indirect call. */
1560 struct GTY(()) cgraph_indirect_call_info
1562 /* When agg_content is set, an offset where the call pointer is located
1563 within the aggregate. */
1564 HOST_WIDE_INT offset;
1565 /* Context of the polymorphic call; use only when POLYMORPHIC flag is set. */
1566 ipa_polymorphic_call_context context;
1567 /* OBJ_TYPE_REF_TOKEN of a polymorphic call (if polymorphic is set). */
1568 HOST_WIDE_INT otr_token;
1569 /* Type of the object from OBJ_TYPE_REF_OBJECT. */
1570 tree otr_type;
1571 /* Index of the parameter that is called. */
1572 int param_index;
1573 /* ECF flags determined from the caller. */
1574 int ecf_flags;
1575 /* Profile_id of common target obtrained from profile. */
1576 int common_target_id;
1577 /* Probability that call will land in function with COMMON_TARGET_ID. */
1578 int common_target_probability;
1580 /* Set when the call is a virtual call with the parameter being the
1581 associated object pointer rather than a simple direct call. */
1582 unsigned polymorphic : 1;
1583 /* Set when the call is a call of a pointer loaded from contents of an
1584 aggregate at offset. */
1585 unsigned agg_contents : 1;
1586 /* Set when this is a call through a member pointer. */
1587 unsigned member_ptr : 1;
1588 /* When the agg_contents bit is set, this one determines whether the
1589 destination is loaded from a parameter passed by reference. */
1590 unsigned by_ref : 1;
1591 /* When the agg_contents bit is set, this one determines whether we can
1592 deduce from the function body that the loaded value from the reference is
1593 never modified between the invocation of the function and the load
1594 point. */
1595 unsigned guaranteed_unmodified : 1;
1596 /* For polymorphic calls this specify whether the virtual table pointer
1597 may have changed in between function entry and the call. */
1598 unsigned vptr_changed : 1;
1601 struct GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller"),
1602 for_user)) cgraph_edge {
1603 friend class cgraph_node;
1605 /* Remove the edge in the cgraph. */
1606 void remove (void);
1608 /* Change field call_stmt of edge to NEW_STMT.
1609 If UPDATE_SPECULATIVE and E is any component of speculative
1610 edge, then update all components. */
1611 void set_call_stmt (gcall *new_stmt, bool update_speculative = true);
1613 /* Redirect callee of the edge to N. The function does not update underlying
1614 call expression. */
1615 void redirect_callee (cgraph_node *n);
1617 /* If the edge does not lead to a thunk, simply redirect it to N. Otherwise
1618 create one or more equivalent thunks for N and redirect E to the first in
1619 the chain. Note that it is then necessary to call
1620 n->expand_all_artificial_thunks once all callers are redirected. */
1621 void redirect_callee_duplicating_thunks (cgraph_node *n);
1623 /* Make an indirect edge with an unknown callee an ordinary edge leading to
1624 CALLEE. DELTA is an integer constant that is to be added to the this
1625 pointer (first parameter) to compensate for skipping
1626 a thunk adjustment. */
1627 cgraph_edge *make_direct (cgraph_node *callee);
1629 /* Turn edge into speculative call calling N2. Update
1630 the profile so the direct call is taken COUNT times
1631 with FREQUENCY. */
1632 cgraph_edge *make_speculative (cgraph_node *n2, gcov_type direct_count,
1633 int direct_frequency);
1635 /* Given speculative call edge, return all three components. */
1636 void speculative_call_info (cgraph_edge *&direct, cgraph_edge *&indirect,
1637 ipa_ref *&reference);
1639 /* Speculative call edge turned out to be direct call to CALLE_DECL.
1640 Remove the speculative call sequence and return edge representing the call.
1641 It is up to caller to redirect the call as appropriate. */
1642 cgraph_edge *resolve_speculation (tree callee_decl = NULL);
1644 /* If necessary, change the function declaration in the call statement
1645 associated with the edge so that it corresponds to the edge callee. */
1646 gimple *redirect_call_stmt_to_callee (void);
1648 /* Create clone of edge in the node N represented
1649 by CALL_EXPR the callgraph. */
1650 cgraph_edge * clone (cgraph_node *n, gcall *call_stmt, unsigned stmt_uid,
1651 gcov_type count_scale, int freq_scale, bool update_original);
1653 /* Verify edge count and frequency. */
1654 bool verify_count_and_frequency ();
1656 /* Return true when call of edge can not lead to return from caller
1657 and thus it is safe to ignore its side effects for IPA analysis
1658 when computing side effects of the caller. */
1659 bool cannot_lead_to_return_p (void);
1661 /* Return true when the edge represents a direct recursion. */
1662 bool recursive_p (void);
1664 /* Return true if the call can be hot. */
1665 bool maybe_hot_p (void);
1667 /* Rebuild cgraph edges for current function node. This needs to be run after
1668 passes that don't update the cgraph. */
1669 static unsigned int rebuild_edges (void);
1671 /* Rebuild cgraph references for current function node. This needs to be run
1672 after passes that don't update the cgraph. */
1673 static void rebuild_references (void);
1675 /* Expected number of executions: calculated in profile.c. */
1676 gcov_type count;
1677 cgraph_node *caller;
1678 cgraph_node *callee;
1679 cgraph_edge *prev_caller;
1680 cgraph_edge *next_caller;
1681 cgraph_edge *prev_callee;
1682 cgraph_edge *next_callee;
1683 gcall *call_stmt;
1684 /* Additional information about an indirect call. Not cleared when an edge
1685 becomes direct. */
1686 cgraph_indirect_call_info *indirect_info;
1687 PTR GTY ((skip (""))) aux;
1688 /* When equal to CIF_OK, inline this call. Otherwise, points to the
1689 explanation why function was not inlined. */
1690 enum cgraph_inline_failed_t inline_failed;
1691 /* The stmt_uid of call_stmt. This is used by LTO to recover the call_stmt
1692 when the function is serialized in. */
1693 unsigned int lto_stmt_uid;
1694 /* Expected frequency of executions within the function.
1695 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
1696 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
1697 int frequency;
1698 /* Unique id of the edge. */
1699 int uid;
1700 /* Whether this edge was made direct by indirect inlining. */
1701 unsigned int indirect_inlining_edge : 1;
1702 /* Whether this edge describes an indirect call with an undetermined
1703 callee. */
1704 unsigned int indirect_unknown_callee : 1;
1705 /* Whether this edge is still a dangling */
1706 /* True if the corresponding CALL stmt cannot be inlined. */
1707 unsigned int call_stmt_cannot_inline_p : 1;
1708 /* Can this call throw externally? */
1709 unsigned int can_throw_external : 1;
1710 /* Edges with SPECULATIVE flag represents indirect calls that was
1711 speculatively turned into direct (i.e. by profile feedback).
1712 The final code sequence will have form:
1714 if (call_target == expected_fn)
1715 expected_fn ();
1716 else
1717 call_target ();
1719 Every speculative call is represented by three components attached
1720 to a same call statement:
1721 1) a direct call (to expected_fn)
1722 2) an indirect call (to call_target)
1723 3) a IPA_REF_ADDR refrence to expected_fn.
1725 Optimizers may later redirect direct call to clone, so 1) and 3)
1726 do not need to necesarily agree with destination. */
1727 unsigned int speculative : 1;
1728 /* Set to true when caller is a constructor or destructor of polymorphic
1729 type. */
1730 unsigned in_polymorphic_cdtor : 1;
1732 /* Return true if call must bind to current definition. */
1733 bool binds_to_current_def_p ();
1735 private:
1736 /* Remove the edge from the list of the callers of the callee. */
1737 void remove_caller (void);
1739 /* Remove the edge from the list of the callees of the caller. */
1740 void remove_callee (void);
1742 /* Set callee N of call graph edge and add it to the corresponding set of
1743 callers. */
1744 void set_callee (cgraph_node *n);
1746 /* Output flags of edge to a file F. */
1747 void dump_edge_flags (FILE *f);
1749 /* Verify that call graph edge corresponds to DECL from the associated
1750 statement. Return true if the verification should fail. */
1751 bool verify_corresponds_to_fndecl (tree decl);
1754 #define CGRAPH_FREQ_BASE 1000
1755 #define CGRAPH_FREQ_MAX 100000
1757 /* The varpool data structure.
1758 Each static variable decl has assigned varpool_node. */
1760 class GTY((tag ("SYMTAB_VARIABLE"))) varpool_node : public symtab_node {
1761 public:
1762 /* Dump given varpool node to F. */
1763 void dump (FILE *f);
1765 /* Dump given varpool node to stderr. */
1766 void DEBUG_FUNCTION debug (void);
1768 /* Remove variable from symbol table. */
1769 void remove (void);
1771 /* Remove node initializer when it is no longer needed. */
1772 void remove_initializer (void);
1774 void analyze (void);
1776 /* Return variable availability. */
1777 availability get_availability (symtab_node *ref = NULL);
1779 /* When doing LTO, read variable's constructor from disk if
1780 it is not already present. */
1781 tree get_constructor (void);
1783 /* Return true if variable has constructor that can be used for folding. */
1784 bool ctor_useable_for_folding_p (void);
1786 /* For given variable pool node, walk the alias chain to return the function
1787 the variable is alias of. Do not walk through thunks.
1788 When AVAILABILITY is non-NULL, get minimal availability in the chain.
1789 When REF is non-NULL, assume that reference happens in symbol REF
1790 when determining the availability. */
1791 inline varpool_node *ultimate_alias_target
1792 (availability *availability = NULL, symtab_node *ref = NULL);
1794 /* Return node that alias is aliasing. */
1795 inline varpool_node *get_alias_target (void);
1797 /* Output one variable, if necessary. Return whether we output it. */
1798 bool assemble_decl (void);
1800 /* For variables in named sections make sure get_variable_section
1801 is called before we switch to those sections. Then section
1802 conflicts between read-only and read-only requiring relocations
1803 sections can be resolved. */
1804 void finalize_named_section_flags (void);
1806 /* Call calback on varpool symbol and aliases associated to varpool symbol.
1807 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1808 skipped. */
1809 bool call_for_symbol_and_aliases (bool (*callback) (varpool_node *, void *),
1810 void *data,
1811 bool include_overwritable);
1813 /* Return true when variable should be considered externally visible. */
1814 bool externally_visible_p (void);
1816 /* Return true when all references to variable must be visible
1817 in ipa_ref_list.
1818 i.e. if the variable is not externally visible or not used in some magic
1819 way (asm statement or such).
1820 The magic uses are all summarized in force_output flag. */
1821 inline bool all_refs_explicit_p ();
1823 /* Return true when variable can be removed from variable pool
1824 if all direct calls are eliminated. */
1825 inline bool can_remove_if_no_refs_p (void);
1827 /* Add the variable DECL to the varpool.
1828 Unlike finalize_decl function is intended to be used
1829 by middle end and allows insertion of new variable at arbitrary point
1830 of compilation. */
1831 static void add (tree decl);
1833 /* Return varpool node for given symbol and check it is a function. */
1834 static inline varpool_node *get (const_tree decl);
1836 /* Mark DECL as finalized. By finalizing the declaration, frontend instruct
1837 the middle end to output the variable to asm file, if needed or externally
1838 visible. */
1839 static void finalize_decl (tree decl);
1841 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1842 Extra name aliases are output whenever DECL is output. */
1843 static varpool_node * create_extra_name_alias (tree alias, tree decl);
1845 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1846 Extra name aliases are output whenever DECL is output. */
1847 static varpool_node * create_alias (tree, tree);
1849 /* Dump the variable pool to F. */
1850 static void dump_varpool (FILE *f);
1852 /* Dump the variable pool to stderr. */
1853 static void DEBUG_FUNCTION debug_varpool (void);
1855 /* Allocate new callgraph node and insert it into basic data structures. */
1856 static varpool_node *create_empty (void);
1858 /* Return varpool node assigned to DECL. Create new one when needed. */
1859 static varpool_node *get_create (tree decl);
1861 /* Given an assembler name, lookup node. */
1862 static varpool_node *get_for_asmname (tree asmname);
1864 /* Set when variable is scheduled to be assembled. */
1865 unsigned output : 1;
1867 /* Set when variable has statically initialized pointer
1868 or is a static bounds variable and needs initalization. */
1869 unsigned need_bounds_init : 1;
1871 /* Set if the variable is dynamically initialized, except for
1872 function local statics. */
1873 unsigned dynamically_initialized : 1;
1875 ENUM_BITFIELD(tls_model) tls_model : 3;
1877 /* Set if the variable is known to be used by single function only.
1878 This is computed by ipa_signle_use pass and used by late optimizations
1879 in places where optimization would be valid for local static variable
1880 if we did not do any inter-procedural code movement. */
1881 unsigned used_by_single_function : 1;
1883 private:
1884 /* Assemble thunks and aliases associated to varpool node. */
1885 void assemble_aliases (void);
1887 /* Worker for call_for_node_and_aliases. */
1888 bool call_for_symbol_and_aliases_1 (bool (*callback) (varpool_node *, void *),
1889 void *data,
1890 bool include_overwritable);
1893 /* Every top level asm statement is put into a asm_node. */
1895 struct GTY(()) asm_node {
1898 /* Next asm node. */
1899 asm_node *next;
1900 /* String for this asm node. */
1901 tree asm_str;
1902 /* Ordering of all cgraph nodes. */
1903 int order;
1906 /* Report whether or not THIS symtab node is a function, aka cgraph_node. */
1908 template <>
1909 template <>
1910 inline bool
1911 is_a_helper <cgraph_node *>::test (symtab_node *p)
1913 return p && p->type == SYMTAB_FUNCTION;
1916 /* Report whether or not THIS symtab node is a vriable, aka varpool_node. */
1918 template <>
1919 template <>
1920 inline bool
1921 is_a_helper <varpool_node *>::test (symtab_node *p)
1923 return p && p->type == SYMTAB_VARIABLE;
1926 /* Macros to access the next item in the list of free cgraph nodes and
1927 edges. */
1928 #define NEXT_FREE_NODE(NODE) dyn_cast<cgraph_node *> ((NODE)->next)
1929 #define SET_NEXT_FREE_NODE(NODE,NODE2) ((NODE))->next = NODE2
1930 #define NEXT_FREE_EDGE(EDGE) (EDGE)->prev_caller
1932 typedef void (*cgraph_edge_hook)(cgraph_edge *, void *);
1933 typedef void (*cgraph_node_hook)(cgraph_node *, void *);
1934 typedef void (*varpool_node_hook)(varpool_node *, void *);
1935 typedef void (*cgraph_2edge_hook)(cgraph_edge *, cgraph_edge *, void *);
1936 typedef void (*cgraph_2node_hook)(cgraph_node *, cgraph_node *, void *);
1938 struct cgraph_edge_hook_list;
1939 struct cgraph_node_hook_list;
1940 struct varpool_node_hook_list;
1941 struct cgraph_2edge_hook_list;
1942 struct cgraph_2node_hook_list;
1944 /* Map from a symbol to initialization/finalization priorities. */
1945 struct GTY(()) symbol_priority_map {
1946 priority_type init;
1947 priority_type fini;
1950 enum symtab_state
1952 /* Frontend is parsing and finalizing functions. */
1953 PARSING,
1954 /* Callgraph is being constructed. It is safe to add new functions. */
1955 CONSTRUCTION,
1956 /* Callgraph is being streamed-in at LTO time. */
1957 LTO_STREAMING,
1958 /* Callgraph is built and early IPA passes are being run. */
1959 IPA,
1960 /* Callgraph is built and all functions are transformed to SSA form. */
1961 IPA_SSA,
1962 /* All inline decisions are done; it is now possible to remove extern inline
1963 functions and virtual call targets. */
1964 IPA_SSA_AFTER_INLINING,
1965 /* Functions are now ordered and being passed to RTL expanders. */
1966 EXPANSION,
1967 /* All cgraph expansion is done. */
1968 FINISHED
1971 struct asmname_hasher : ggc_ptr_hash <symtab_node>
1973 typedef const_tree compare_type;
1975 static hashval_t hash (symtab_node *n);
1976 static bool equal (symtab_node *n, const_tree t);
1979 class GTY((tag ("SYMTAB"))) symbol_table
1981 public:
1982 friend class symtab_node;
1983 friend class cgraph_node;
1984 friend class cgraph_edge;
1986 symbol_table (): cgraph_max_summary_uid (1)
1990 /* Initialize callgraph dump file. */
1991 void initialize (void);
1993 /* Register a top-level asm statement ASM_STR. */
1994 inline asm_node *finalize_toplevel_asm (tree asm_str);
1996 /* Analyze the whole compilation unit once it is parsed completely. */
1997 void finalize_compilation_unit (void);
1999 /* C++ frontend produce same body aliases all over the place, even before PCH
2000 gets streamed out. It relies on us linking the aliases with their function
2001 in order to do the fixups, but ipa-ref is not PCH safe. Consequentely we
2002 first produce aliases without links, but once C++ FE is sure he won't sream
2003 PCH we build the links via this function. */
2004 void process_same_body_aliases (void);
2006 /* Perform simple optimizations based on callgraph. */
2007 void compile (void);
2009 /* Process CGRAPH_NEW_FUNCTIONS and perform actions necessary to add these
2010 functions into callgraph in a way so they look like ordinary reachable
2011 functions inserted into callgraph already at construction time. */
2012 void process_new_functions (void);
2014 /* Once all functions from compilation unit are in memory, produce all clones
2015 and update all calls. We might also do this on demand if we don't want to
2016 bring all functions to memory prior compilation, but current WHOPR
2017 implementation does that and it is bit easier to keep everything right
2018 in this order. */
2019 void materialize_all_clones (void);
2021 /* Register a symbol NODE. */
2022 inline void register_symbol (symtab_node *node);
2024 inline void
2025 clear_asm_symbols (void)
2027 asmnodes = NULL;
2028 asm_last_node = NULL;
2031 /* Perform reachability analysis and reclaim all unreachable nodes. */
2032 bool remove_unreachable_nodes (FILE *file);
2034 /* Optimization of function bodies might've rendered some variables as
2035 unnecessary so we want to avoid these from being compiled. Re-do
2036 reachability starting from variables that are either externally visible
2037 or was referred from the asm output routines. */
2038 void remove_unreferenced_decls (void);
2040 /* Unregister a symbol NODE. */
2041 inline void unregister (symtab_node *node);
2043 /* Allocate new callgraph node and insert it into basic data structures. */
2044 cgraph_node *create_empty (void);
2046 /* Release a callgraph NODE with UID and put in to the list
2047 of free nodes. */
2048 void release_symbol (cgraph_node *node, int uid);
2050 /* Output all variables enqueued to be assembled. */
2051 bool output_variables (void);
2053 /* Weakrefs may be associated to external decls and thus not output
2054 at expansion time. Emit all necessary aliases. */
2055 void output_weakrefs (void);
2057 /* Return first static symbol with definition. */
2058 inline symtab_node *first_symbol (void);
2060 /* Return first assembler symbol. */
2061 inline asm_node *
2062 first_asm_symbol (void)
2064 return asmnodes;
2067 /* Return first static symbol with definition. */
2068 inline symtab_node *first_defined_symbol (void);
2070 /* Return first variable. */
2071 inline varpool_node *first_variable (void);
2073 /* Return next variable after NODE. */
2074 inline varpool_node *next_variable (varpool_node *node);
2076 /* Return first static variable with initializer. */
2077 inline varpool_node *first_static_initializer (void);
2079 /* Return next static variable with initializer after NODE. */
2080 inline varpool_node *next_static_initializer (varpool_node *node);
2082 /* Return first static variable with definition. */
2083 inline varpool_node *first_defined_variable (void);
2085 /* Return next static variable with definition after NODE. */
2086 inline varpool_node *next_defined_variable (varpool_node *node);
2088 /* Return first function with body defined. */
2089 inline cgraph_node *first_defined_function (void);
2091 /* Return next function with body defined after NODE. */
2092 inline cgraph_node *next_defined_function (cgraph_node *node);
2094 /* Return first function. */
2095 inline cgraph_node *first_function (void);
2097 /* Return next function. */
2098 inline cgraph_node *next_function (cgraph_node *node);
2100 /* Return first function with body defined. */
2101 cgraph_node *first_function_with_gimple_body (void);
2103 /* Return next reachable static variable with initializer after NODE. */
2104 inline cgraph_node *next_function_with_gimple_body (cgraph_node *node);
2106 /* Register HOOK to be called with DATA on each removed edge. */
2107 cgraph_edge_hook_list *add_edge_removal_hook (cgraph_edge_hook hook,
2108 void *data);
2110 /* Remove ENTRY from the list of hooks called on removing edges. */
2111 void remove_edge_removal_hook (cgraph_edge_hook_list *entry);
2113 /* Register HOOK to be called with DATA on each removed node. */
2114 cgraph_node_hook_list *add_cgraph_removal_hook (cgraph_node_hook hook,
2115 void *data);
2117 /* Remove ENTRY from the list of hooks called on removing nodes. */
2118 void remove_cgraph_removal_hook (cgraph_node_hook_list *entry);
2120 /* Register HOOK to be called with DATA on each removed node. */
2121 varpool_node_hook_list *add_varpool_removal_hook (varpool_node_hook hook,
2122 void *data);
2124 /* Remove ENTRY from the list of hooks called on removing nodes. */
2125 void remove_varpool_removal_hook (varpool_node_hook_list *entry);
2127 /* Register HOOK to be called with DATA on each inserted node. */
2128 cgraph_node_hook_list *add_cgraph_insertion_hook (cgraph_node_hook hook,
2129 void *data);
2131 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2132 void remove_cgraph_insertion_hook (cgraph_node_hook_list *entry);
2134 /* Register HOOK to be called with DATA on each inserted node. */
2135 varpool_node_hook_list *add_varpool_insertion_hook (varpool_node_hook hook,
2136 void *data);
2138 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2139 void remove_varpool_insertion_hook (varpool_node_hook_list *entry);
2141 /* Register HOOK to be called with DATA on each duplicated edge. */
2142 cgraph_2edge_hook_list *add_edge_duplication_hook (cgraph_2edge_hook hook,
2143 void *data);
2144 /* Remove ENTRY from the list of hooks called on duplicating edges. */
2145 void remove_edge_duplication_hook (cgraph_2edge_hook_list *entry);
2147 /* Register HOOK to be called with DATA on each duplicated node. */
2148 cgraph_2node_hook_list *add_cgraph_duplication_hook (cgraph_2node_hook hook,
2149 void *data);
2151 /* Remove ENTRY from the list of hooks called on duplicating nodes. */
2152 void remove_cgraph_duplication_hook (cgraph_2node_hook_list *entry);
2154 /* Call all edge removal hooks. */
2155 void call_edge_removal_hooks (cgraph_edge *e);
2157 /* Call all node insertion hooks. */
2158 void call_cgraph_insertion_hooks (cgraph_node *node);
2160 /* Call all node removal hooks. */
2161 void call_cgraph_removal_hooks (cgraph_node *node);
2163 /* Call all node duplication hooks. */
2164 void call_cgraph_duplication_hooks (cgraph_node *node, cgraph_node *node2);
2166 /* Call all edge duplication hooks. */
2167 void call_edge_duplication_hooks (cgraph_edge *cs1, cgraph_edge *cs2);
2169 /* Call all node removal hooks. */
2170 void call_varpool_removal_hooks (varpool_node *node);
2172 /* Call all node insertion hooks. */
2173 void call_varpool_insertion_hooks (varpool_node *node);
2175 /* Arrange node to be first in its entry of assembler_name_hash. */
2176 void symtab_prevail_in_asm_name_hash (symtab_node *node);
2178 /* Initalize asm name hash unless. */
2179 void symtab_initialize_asm_name_hash (void);
2181 /* Set the DECL_ASSEMBLER_NAME and update symtab hashtables. */
2182 void change_decl_assembler_name (tree decl, tree name);
2184 /* Dump symbol table to F. */
2185 void dump (FILE *f);
2187 /* Dump symbol table to stderr. */
2188 inline DEBUG_FUNCTION void debug (void)
2190 dump (stderr);
2193 /* Return true if assembler names NAME1 and NAME2 leads to the same symbol
2194 name. */
2195 static bool assembler_names_equal_p (const char *name1, const char *name2);
2197 int cgraph_count;
2198 int cgraph_max_uid;
2199 int cgraph_max_summary_uid;
2201 int edges_count;
2202 int edges_max_uid;
2204 symtab_node* GTY(()) nodes;
2205 asm_node* GTY(()) asmnodes;
2206 asm_node* GTY(()) asm_last_node;
2207 cgraph_node* GTY(()) free_nodes;
2209 /* Head of a linked list of unused (freed) call graph edges.
2210 Do not GTY((delete)) this list so UIDs gets reliably recycled. */
2211 cgraph_edge * GTY(()) free_edges;
2213 /* The order index of the next symtab node to be created. This is
2214 used so that we can sort the cgraph nodes in order by when we saw
2215 them, to support -fno-toplevel-reorder. */
2216 int order;
2218 /* Set when whole unit has been analyzed so we can access global info. */
2219 bool global_info_ready;
2220 /* What state callgraph is in right now. */
2221 enum symtab_state state;
2222 /* Set when the cgraph is fully build and the basic flags are computed. */
2223 bool function_flags_ready;
2225 bool cpp_implicit_aliases_done;
2227 /* Hash table used to hold sectoons. */
2228 hash_table<section_name_hasher> *GTY(()) section_hash;
2230 /* Hash table used to convert assembler names into nodes. */
2231 hash_table<asmname_hasher> *assembler_name_hash;
2233 /* Hash table used to hold init priorities. */
2234 hash_map<symtab_node *, symbol_priority_map> *init_priority_hash;
2236 FILE* GTY ((skip)) dump_file;
2238 /* Return symbol used to separate symbol name from suffix. */
2239 static char symbol_suffix_separator ();
2241 FILE* GTY ((skip)) ipa_clones_dump_file;
2243 hash_set <const cgraph_node *> GTY ((skip)) cloned_nodes;
2245 private:
2246 /* Allocate new callgraph node. */
2247 inline cgraph_node * allocate_cgraph_symbol (void);
2249 /* Allocate a cgraph_edge structure and fill it with data according to the
2250 parameters of which only CALLEE can be NULL (when creating an indirect call
2251 edge). */
2252 cgraph_edge *create_edge (cgraph_node *caller, cgraph_node *callee,
2253 gcall *call_stmt, gcov_type count, int freq,
2254 bool indir_unknown_callee);
2256 /* Put the edge onto the free list. */
2257 void free_edge (cgraph_edge *e);
2259 /* Insert NODE to assembler name hash. */
2260 void insert_to_assembler_name_hash (symtab_node *node, bool with_clones);
2262 /* Remove NODE from assembler name hash. */
2263 void unlink_from_assembler_name_hash (symtab_node *node, bool with_clones);
2265 /* Hash asmnames ignoring the user specified marks. */
2266 static hashval_t decl_assembler_name_hash (const_tree asmname);
2268 /* Compare ASMNAME with the DECL_ASSEMBLER_NAME of DECL. */
2269 static bool decl_assembler_name_equal (tree decl, const_tree asmname);
2271 friend struct asmname_hasher;
2273 /* List of hooks triggered when an edge is removed. */
2274 cgraph_edge_hook_list * GTY((skip)) m_first_edge_removal_hook;
2275 /* List of hooks triggem_red when a cgraph node is removed. */
2276 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_removal_hook;
2277 /* List of hooks triggered when an edge is duplicated. */
2278 cgraph_2edge_hook_list * GTY((skip)) m_first_edge_duplicated_hook;
2279 /* List of hooks triggered when a node is duplicated. */
2280 cgraph_2node_hook_list * GTY((skip)) m_first_cgraph_duplicated_hook;
2281 /* List of hooks triggered when an function is inserted. */
2282 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_insertion_hook;
2283 /* List of hooks triggered when an variable is inserted. */
2284 varpool_node_hook_list * GTY((skip)) m_first_varpool_insertion_hook;
2285 /* List of hooks triggered when a node is removed. */
2286 varpool_node_hook_list * GTY((skip)) m_first_varpool_removal_hook;
2289 extern GTY(()) symbol_table *symtab;
2291 extern vec<cgraph_node *> cgraph_new_nodes;
2293 inline hashval_t
2294 asmname_hasher::hash (symtab_node *n)
2296 return symbol_table::decl_assembler_name_hash
2297 (DECL_ASSEMBLER_NAME (n->decl));
2300 inline bool
2301 asmname_hasher::equal (symtab_node *n, const_tree t)
2303 return symbol_table::decl_assembler_name_equal (n->decl, t);
2306 /* In cgraph.c */
2307 void cgraph_c_finalize (void);
2308 void release_function_body (tree);
2309 cgraph_indirect_call_info *cgraph_allocate_init_indirect_info (void);
2311 void cgraph_update_edges_for_call_stmt (gimple *, tree, gimple *);
2312 bool cgraph_function_possibly_inlined_p (tree);
2314 const char* cgraph_inline_failed_string (cgraph_inline_failed_t);
2315 cgraph_inline_failed_type_t cgraph_inline_failed_type (cgraph_inline_failed_t);
2317 extern bool gimple_check_call_matching_types (gimple *, tree, bool);
2319 /* In cgraphunit.c */
2320 void cgraphunit_c_finalize (void);
2322 /* Initialize datastructures so DECL is a function in lowered gimple form.
2323 IN_SSA is true if the gimple is in SSA. */
2324 basic_block init_lowered_empty_function (tree, bool, gcov_type);
2326 tree thunk_adjust (gimple_stmt_iterator *, tree, bool, HOST_WIDE_INT, tree);
2327 /* In cgraphclones.c */
2329 tree clone_function_name_1 (const char *, const char *);
2330 tree clone_function_name (tree decl, const char *);
2332 void tree_function_versioning (tree, tree, vec<ipa_replace_map *, va_gc> *,
2333 bool, bitmap, bool, bitmap, basic_block);
2335 void dump_callgraph_transformation (const cgraph_node *original,
2336 const cgraph_node *clone,
2337 const char *suffix);
2338 tree cgraph_build_function_type_skip_args (tree orig_type, bitmap args_to_skip,
2339 bool skip_return);
2341 /* In cgraphbuild.c */
2342 int compute_call_stmt_bb_frequency (tree, basic_block bb);
2343 void record_references_in_initializer (tree, bool);
2345 /* In ipa.c */
2346 void cgraph_build_static_cdtor (char which, tree body, int priority);
2347 bool ipa_discover_readonly_nonaddressable_vars (void);
2349 /* In varpool.c */
2350 tree ctor_for_folding (tree);
2352 /* In tree-chkp.c */
2353 extern bool chkp_function_instrumented_p (tree fndecl);
2355 /* In ipa-inline-analysis.c */
2356 void initialize_inline_failed (struct cgraph_edge *);
2357 bool speculation_useful_p (struct cgraph_edge *e, bool anticipate_inlining);
2359 /* Return true when the symbol is real symbol, i.e. it is not inline clone
2360 or abstract function kept for debug info purposes only. */
2361 inline bool
2362 symtab_node::real_symbol_p (void)
2364 cgraph_node *cnode;
2366 if (DECL_ABSTRACT_P (decl))
2367 return false;
2368 if (transparent_alias && definition)
2369 return false;
2370 if (!is_a <cgraph_node *> (this))
2371 return true;
2372 cnode = dyn_cast <cgraph_node *> (this);
2373 if (cnode->global.inlined_to)
2374 return false;
2375 return true;
2378 /* Return true if DECL should have entry in symbol table if used.
2379 Those are functions and static & external veriables*/
2381 static inline bool
2382 decl_in_symtab_p (const_tree decl)
2384 return (TREE_CODE (decl) == FUNCTION_DECL
2385 || (TREE_CODE (decl) == VAR_DECL
2386 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl))));
2389 inline bool
2390 symtab_node::in_same_comdat_group_p (symtab_node *target)
2392 symtab_node *source = this;
2394 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2396 if (cn->global.inlined_to)
2397 source = cn->global.inlined_to;
2399 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2401 if (cn->global.inlined_to)
2402 target = cn->global.inlined_to;
2405 return source->get_comdat_group () == target->get_comdat_group ();
2408 /* Return node that alias is aliasing. */
2410 inline symtab_node *
2411 symtab_node::get_alias_target (void)
2413 ipa_ref *ref = NULL;
2414 iterate_reference (0, ref);
2415 if (ref->use == IPA_REF_CHKP)
2416 iterate_reference (1, ref);
2417 gcc_checking_assert (ref->use == IPA_REF_ALIAS);
2418 return ref->referred;
2421 /* Return next reachable static symbol with initializer after the node. */
2423 inline symtab_node *
2424 symtab_node::next_defined_symbol (void)
2426 symtab_node *node1 = next;
2428 for (; node1; node1 = node1->next)
2429 if (node1->definition)
2430 return node1;
2432 return NULL;
2435 /* Iterates I-th reference in the list, REF is also set. */
2437 inline ipa_ref *
2438 symtab_node::iterate_reference (unsigned i, ipa_ref *&ref)
2440 vec_safe_iterate (ref_list.references, i, &ref);
2442 return ref;
2445 /* Iterates I-th referring item in the list, REF is also set. */
2447 inline ipa_ref *
2448 symtab_node::iterate_referring (unsigned i, ipa_ref *&ref)
2450 ref_list.referring.iterate (i, &ref);
2452 return ref;
2455 /* Iterates I-th referring alias item in the list, REF is also set. */
2457 inline ipa_ref *
2458 symtab_node::iterate_direct_aliases (unsigned i, ipa_ref *&ref)
2460 ref_list.referring.iterate (i, &ref);
2462 if (ref && ref->use != IPA_REF_ALIAS)
2463 return NULL;
2465 return ref;
2468 /* Return true if list contains an alias. */
2470 inline bool
2471 symtab_node::has_aliases_p (void)
2473 ipa_ref *ref = NULL;
2475 return (iterate_direct_aliases (0, ref) != NULL);
2478 /* Return true when RESOLUTION indicate that linker will use
2479 the symbol from non-LTO object files. */
2481 inline bool
2482 resolution_used_from_other_file_p (enum ld_plugin_symbol_resolution resolution)
2484 return (resolution == LDPR_PREVAILING_DEF
2485 || resolution == LDPR_PREEMPTED_REG
2486 || resolution == LDPR_RESOLVED_EXEC
2487 || resolution == LDPR_RESOLVED_DYN);
2490 /* Return true when symtab_node is known to be used from other (non-LTO)
2491 object file. Known only when doing LTO via linker plugin. */
2493 inline bool
2494 symtab_node::used_from_object_file_p (void)
2496 if (!TREE_PUBLIC (decl) || DECL_EXTERNAL (decl))
2497 return false;
2498 if (resolution_used_from_other_file_p (resolution))
2499 return true;
2500 return false;
2503 /* Return varpool node for given symbol and check it is a function. */
2505 inline varpool_node *
2506 varpool_node::get (const_tree decl)
2508 gcc_checking_assert (TREE_CODE (decl) == VAR_DECL);
2509 return dyn_cast<varpool_node *> (symtab_node::get (decl));
2512 /* Register a symbol NODE. */
2514 inline void
2515 symbol_table::register_symbol (symtab_node *node)
2517 node->next = nodes;
2518 node->previous = NULL;
2520 if (nodes)
2521 nodes->previous = node;
2522 nodes = node;
2524 node->order = order++;
2527 /* Register a top-level asm statement ASM_STR. */
2529 asm_node *
2530 symbol_table::finalize_toplevel_asm (tree asm_str)
2532 asm_node *node;
2534 node = ggc_cleared_alloc<asm_node> ();
2535 node->asm_str = asm_str;
2536 node->order = order++;
2537 node->next = NULL;
2539 if (asmnodes == NULL)
2540 asmnodes = node;
2541 else
2542 asm_last_node->next = node;
2544 asm_last_node = node;
2545 return node;
2548 /* Unregister a symbol NODE. */
2549 inline void
2550 symbol_table::unregister (symtab_node *node)
2552 if (node->previous)
2553 node->previous->next = node->next;
2554 else
2555 nodes = node->next;
2557 if (node->next)
2558 node->next->previous = node->previous;
2560 node->next = NULL;
2561 node->previous = NULL;
2564 /* Release a callgraph NODE with UID and put in to the list of free nodes. */
2566 inline void
2567 symbol_table::release_symbol (cgraph_node *node, int uid)
2569 cgraph_count--;
2571 /* Clear out the node to NULL all pointers and add the node to the free
2572 list. */
2573 memset (node, 0, sizeof (*node));
2574 node->type = SYMTAB_FUNCTION;
2575 node->uid = uid;
2576 SET_NEXT_FREE_NODE (node, free_nodes);
2577 free_nodes = node;
2580 /* Allocate new callgraph node. */
2582 inline cgraph_node *
2583 symbol_table::allocate_cgraph_symbol (void)
2585 cgraph_node *node;
2587 if (free_nodes)
2589 node = free_nodes;
2590 free_nodes = NEXT_FREE_NODE (node);
2592 else
2594 node = ggc_cleared_alloc<cgraph_node> ();
2595 node->uid = cgraph_max_uid++;
2598 node->summary_uid = cgraph_max_summary_uid++;
2599 return node;
2603 /* Return first static symbol with definition. */
2604 inline symtab_node *
2605 symbol_table::first_symbol (void)
2607 return nodes;
2610 /* Walk all symbols. */
2611 #define FOR_EACH_SYMBOL(node) \
2612 for ((node) = symtab->first_symbol (); (node); (node) = (node)->next)
2614 /* Return first static symbol with definition. */
2615 inline symtab_node *
2616 symbol_table::first_defined_symbol (void)
2618 symtab_node *node;
2620 for (node = nodes; node; node = node->next)
2621 if (node->definition)
2622 return node;
2624 return NULL;
2627 /* Walk all symbols with definitions in current unit. */
2628 #define FOR_EACH_DEFINED_SYMBOL(node) \
2629 for ((node) = symtab->first_defined_symbol (); (node); \
2630 (node) = node->next_defined_symbol ())
2632 /* Return first variable. */
2633 inline varpool_node *
2634 symbol_table::first_variable (void)
2636 symtab_node *node;
2637 for (node = nodes; node; node = node->next)
2638 if (varpool_node *vnode = dyn_cast <varpool_node *> (node))
2639 return vnode;
2640 return NULL;
2643 /* Return next variable after NODE. */
2644 inline varpool_node *
2645 symbol_table::next_variable (varpool_node *node)
2647 symtab_node *node1 = node->next;
2648 for (; node1; node1 = node1->next)
2649 if (varpool_node *vnode1 = dyn_cast <varpool_node *> (node1))
2650 return vnode1;
2651 return NULL;
2653 /* Walk all variables. */
2654 #define FOR_EACH_VARIABLE(node) \
2655 for ((node) = symtab->first_variable (); \
2656 (node); \
2657 (node) = symtab->next_variable ((node)))
2659 /* Return first static variable with initializer. */
2660 inline varpool_node *
2661 symbol_table::first_static_initializer (void)
2663 symtab_node *node;
2664 for (node = nodes; node; node = node->next)
2666 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2667 if (vnode && DECL_INITIAL (node->decl))
2668 return vnode;
2670 return NULL;
2673 /* Return next static variable with initializer after NODE. */
2674 inline varpool_node *
2675 symbol_table::next_static_initializer (varpool_node *node)
2677 symtab_node *node1 = node->next;
2678 for (; node1; node1 = node1->next)
2680 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2681 if (vnode1 && DECL_INITIAL (node1->decl))
2682 return vnode1;
2684 return NULL;
2687 /* Walk all static variables with initializer set. */
2688 #define FOR_EACH_STATIC_INITIALIZER(node) \
2689 for ((node) = symtab->first_static_initializer (); (node); \
2690 (node) = symtab->next_static_initializer (node))
2692 /* Return first static variable with definition. */
2693 inline varpool_node *
2694 symbol_table::first_defined_variable (void)
2696 symtab_node *node;
2697 for (node = nodes; node; node = node->next)
2699 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2700 if (vnode && vnode->definition)
2701 return vnode;
2703 return NULL;
2706 /* Return next static variable with definition after NODE. */
2707 inline varpool_node *
2708 symbol_table::next_defined_variable (varpool_node *node)
2710 symtab_node *node1 = node->next;
2711 for (; node1; node1 = node1->next)
2713 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2714 if (vnode1 && vnode1->definition)
2715 return vnode1;
2717 return NULL;
2719 /* Walk all variables with definitions in current unit. */
2720 #define FOR_EACH_DEFINED_VARIABLE(node) \
2721 for ((node) = symtab->first_defined_variable (); (node); \
2722 (node) = symtab->next_defined_variable (node))
2724 /* Return first function with body defined. */
2725 inline cgraph_node *
2726 symbol_table::first_defined_function (void)
2728 symtab_node *node;
2729 for (node = nodes; node; node = node->next)
2731 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2732 if (cn && cn->definition)
2733 return cn;
2735 return NULL;
2738 /* Return next function with body defined after NODE. */
2739 inline cgraph_node *
2740 symbol_table::next_defined_function (cgraph_node *node)
2742 symtab_node *node1 = node->next;
2743 for (; node1; node1 = node1->next)
2745 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2746 if (cn1 && cn1->definition)
2747 return cn1;
2749 return NULL;
2752 /* Walk all functions with body defined. */
2753 #define FOR_EACH_DEFINED_FUNCTION(node) \
2754 for ((node) = symtab->first_defined_function (); (node); \
2755 (node) = symtab->next_defined_function ((node)))
2757 /* Return first function. */
2758 inline cgraph_node *
2759 symbol_table::first_function (void)
2761 symtab_node *node;
2762 for (node = nodes; node; node = node->next)
2763 if (cgraph_node *cn = dyn_cast <cgraph_node *> (node))
2764 return cn;
2765 return NULL;
2768 /* Return next function. */
2769 inline cgraph_node *
2770 symbol_table::next_function (cgraph_node *node)
2772 symtab_node *node1 = node->next;
2773 for (; node1; node1 = node1->next)
2774 if (cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1))
2775 return cn1;
2776 return NULL;
2779 /* Return first function with body defined. */
2780 inline cgraph_node *
2781 symbol_table::first_function_with_gimple_body (void)
2783 symtab_node *node;
2784 for (node = nodes; node; node = node->next)
2786 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2787 if (cn && cn->has_gimple_body_p ())
2788 return cn;
2790 return NULL;
2793 /* Return next reachable static variable with initializer after NODE. */
2794 inline cgraph_node *
2795 symbol_table::next_function_with_gimple_body (cgraph_node *node)
2797 symtab_node *node1 = node->next;
2798 for (; node1; node1 = node1->next)
2800 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2801 if (cn1 && cn1->has_gimple_body_p ())
2802 return cn1;
2804 return NULL;
2807 /* Walk all functions. */
2808 #define FOR_EACH_FUNCTION(node) \
2809 for ((node) = symtab->first_function (); (node); \
2810 (node) = symtab->next_function ((node)))
2812 /* Return true when callgraph node is a function with Gimple body defined
2813 in current unit. Functions can also be define externally or they
2814 can be thunks with no Gimple representation.
2816 Note that at WPA stage, the function body may not be present in memory. */
2818 inline bool
2819 cgraph_node::has_gimple_body_p (void)
2821 return definition && !thunk.thunk_p && !alias;
2824 /* Walk all functions with body defined. */
2825 #define FOR_EACH_FUNCTION_WITH_GIMPLE_BODY(node) \
2826 for ((node) = symtab->first_function_with_gimple_body (); (node); \
2827 (node) = symtab->next_function_with_gimple_body (node))
2829 /* Uniquize all constants that appear in memory.
2830 Each constant in memory thus far output is recorded
2831 in `const_desc_table'. */
2833 struct GTY((for_user)) constant_descriptor_tree {
2834 /* A MEM for the constant. */
2835 rtx rtl;
2837 /* The value of the constant. */
2838 tree value;
2840 /* Hash of value. Computing the hash from value each time
2841 hashfn is called can't work properly, as that means recursive
2842 use of the hash table during hash table expansion. */
2843 hashval_t hash;
2846 /* Return true when function is only called directly or it has alias.
2847 i.e. it is not externally visible, address was not taken and
2848 it is not used in any other non-standard way. */
2850 inline bool
2851 cgraph_node::only_called_directly_or_aliased_p (void)
2853 gcc_assert (!global.inlined_to);
2854 return (!force_output && !address_taken
2855 && !used_from_other_partition
2856 && !DECL_VIRTUAL_P (decl)
2857 && !DECL_STATIC_CONSTRUCTOR (decl)
2858 && !DECL_STATIC_DESTRUCTOR (decl)
2859 && !used_from_object_file_p ()
2860 && !externally_visible);
2863 /* Return true when function can be removed from callgraph
2864 if all direct calls are eliminated. */
2866 inline bool
2867 cgraph_node::can_remove_if_no_direct_calls_and_refs_p (void)
2869 gcc_checking_assert (!global.inlined_to);
2870 /* Instrumentation clones should not be removed before
2871 instrumentation happens. New callers may appear after
2872 instrumentation. */
2873 if (instrumentation_clone
2874 && !chkp_function_instrumented_p (decl))
2875 return false;
2876 /* Extern inlines can always go, we will use the external definition. */
2877 if (DECL_EXTERNAL (decl))
2878 return true;
2879 /* When function is needed, we can not remove it. */
2880 if (force_output || used_from_other_partition)
2881 return false;
2882 if (DECL_STATIC_CONSTRUCTOR (decl)
2883 || DECL_STATIC_DESTRUCTOR (decl))
2884 return false;
2885 /* Only COMDAT functions can be removed if externally visible. */
2886 if (externally_visible
2887 && (!DECL_COMDAT (decl)
2888 || forced_by_abi
2889 || used_from_object_file_p ()))
2890 return false;
2891 return true;
2894 /* Verify cgraph, if consistency checking is enabled. */
2896 inline void
2897 cgraph_node::checking_verify_cgraph_nodes (void)
2899 if (flag_checking)
2900 cgraph_node::verify_cgraph_nodes ();
2903 /* Return true when variable can be removed from variable pool
2904 if all direct calls are eliminated. */
2906 inline bool
2907 varpool_node::can_remove_if_no_refs_p (void)
2909 if (DECL_EXTERNAL (decl))
2910 return true;
2911 return (!force_output && !used_from_other_partition
2912 && ((DECL_COMDAT (decl)
2913 && !forced_by_abi
2914 && !used_from_object_file_p ())
2915 || !externally_visible
2916 || DECL_HAS_VALUE_EXPR_P (decl)));
2919 /* Return true when all references to variable must be visible in ipa_ref_list.
2920 i.e. if the variable is not externally visible or not used in some magic
2921 way (asm statement or such).
2922 The magic uses are all summarized in force_output flag. */
2924 inline bool
2925 varpool_node::all_refs_explicit_p ()
2927 return (definition
2928 && !externally_visible
2929 && !used_from_other_partition
2930 && !force_output);
2933 struct tree_descriptor_hasher : ggc_ptr_hash<constant_descriptor_tree>
2935 static hashval_t hash (constant_descriptor_tree *);
2936 static bool equal (constant_descriptor_tree *, constant_descriptor_tree *);
2939 /* Constant pool accessor function. */
2940 hash_table<tree_descriptor_hasher> *constant_pool_htab (void);
2942 /* Return node that alias is aliasing. */
2944 inline cgraph_node *
2945 cgraph_node::get_alias_target (void)
2947 return dyn_cast <cgraph_node *> (symtab_node::get_alias_target ());
2950 /* Return node that alias is aliasing. */
2952 inline varpool_node *
2953 varpool_node::get_alias_target (void)
2955 return dyn_cast <varpool_node *> (symtab_node::get_alias_target ());
2958 /* Walk the alias chain to return the symbol NODE is alias of.
2959 If NODE is not an alias, return NODE.
2960 When AVAILABILITY is non-NULL, get minimal availability in the chain.
2961 When REF is non-NULL, assume that reference happens in symbol REF
2962 when determining the availability. */
2964 inline symtab_node *
2965 symtab_node::ultimate_alias_target (enum availability *availability,
2966 symtab_node *ref)
2968 if (!alias)
2970 if (availability)
2971 *availability = get_availability (ref);
2972 return this;
2975 return ultimate_alias_target_1 (availability, ref);
2978 /* Given function symbol, walk the alias chain to return the function node
2979 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 cgraph_node *
2985 cgraph_node::ultimate_alias_target (enum availability *availability,
2986 symtab_node *ref)
2988 cgraph_node *n = dyn_cast <cgraph_node *>
2989 (symtab_node::ultimate_alias_target (availability, ref));
2990 if (!n && availability)
2991 *availability = AVAIL_NOT_AVAILABLE;
2992 return n;
2995 /* For given variable pool node, walk the alias chain to return the function
2996 the variable is alias of. Do not walk through thunks.
2997 When AVAILABILITY is non-NULL, get minimal availability in the chain.
2998 When REF is non-NULL, assume that reference happens in symbol REF
2999 when determining the availability. */
3001 inline varpool_node *
3002 varpool_node::ultimate_alias_target (availability *availability,
3003 symtab_node *ref)
3005 varpool_node *n = dyn_cast <varpool_node *>
3006 (symtab_node::ultimate_alias_target (availability, ref));
3008 if (!n && availability)
3009 *availability = AVAIL_NOT_AVAILABLE;
3010 return n;
3013 /* Set callee N of call graph edge and add it to the corresponding set of
3014 callers. */
3016 inline void
3017 cgraph_edge::set_callee (cgraph_node *n)
3019 prev_caller = NULL;
3020 if (n->callers)
3021 n->callers->prev_caller = this;
3022 next_caller = n->callers;
3023 n->callers = this;
3024 callee = n;
3027 /* Redirect callee of the edge to N. The function does not update underlying
3028 call expression. */
3030 inline void
3031 cgraph_edge::redirect_callee (cgraph_node *n)
3033 /* Remove from callers list of the current callee. */
3034 remove_callee ();
3036 /* Insert to callers list of the new callee. */
3037 set_callee (n);
3040 /* Return true when the edge represents a direct recursion. */
3042 inline bool
3043 cgraph_edge::recursive_p (void)
3045 cgraph_node *c = callee->ultimate_alias_target ();
3046 if (caller->global.inlined_to)
3047 return caller->global.inlined_to->decl == c->decl;
3048 else
3049 return caller->decl == c->decl;
3052 /* Remove the edge from the list of the callers of the callee. */
3054 inline void
3055 cgraph_edge::remove_callee (void)
3057 gcc_assert (!indirect_unknown_callee);
3058 if (prev_caller)
3059 prev_caller->next_caller = next_caller;
3060 if (next_caller)
3061 next_caller->prev_caller = prev_caller;
3062 if (!prev_caller)
3063 callee->callers = next_caller;
3066 /* Return true if call must bind to current definition. */
3068 inline bool
3069 cgraph_edge::binds_to_current_def_p ()
3071 if (callee)
3072 return callee->binds_to_current_def_p (caller);
3073 else
3074 return false;
3077 /* Return true if the TM_CLONE bit is set for a given FNDECL. */
3078 static inline bool
3079 decl_is_tm_clone (const_tree fndecl)
3081 cgraph_node *n = cgraph_node::get (fndecl);
3082 if (n)
3083 return n->tm_clone;
3084 return false;
3087 /* Likewise indicate that a node is needed, i.e. reachable via some
3088 external means. */
3090 inline void
3091 cgraph_node::mark_force_output (void)
3093 force_output = 1;
3094 gcc_checking_assert (!global.inlined_to);
3097 /* Return true if function should be optimized for size. */
3099 inline bool
3100 cgraph_node::optimize_for_size_p (void)
3102 if (opt_for_fn (decl, optimize_size))
3103 return true;
3104 if (frequency == NODE_FREQUENCY_UNLIKELY_EXECUTED)
3105 return true;
3106 else
3107 return false;
3110 /* Return symtab_node for NODE or create one if it is not present
3111 in symtab. */
3113 inline symtab_node *
3114 symtab_node::get_create (tree node)
3116 if (TREE_CODE (node) == VAR_DECL)
3117 return varpool_node::get_create (node);
3118 else
3119 return cgraph_node::get_create (node);
3122 /* Return availability of NODE when referenced from REF. */
3124 inline enum availability
3125 symtab_node::get_availability (symtab_node *ref)
3127 if (is_a <cgraph_node *> (this))
3128 return dyn_cast <cgraph_node *> (this)->get_availability (ref);
3129 else
3130 return dyn_cast <varpool_node *> (this)->get_availability (ref);
3133 /* Call calback on symtab node and aliases associated to this node.
3134 When INCLUDE_OVERWRITABLE is false, overwritable symbols are skipped. */
3136 inline bool
3137 symtab_node::call_for_symbol_and_aliases (bool (*callback) (symtab_node *,
3138 void *),
3139 void *data,
3140 bool include_overwritable)
3142 if (include_overwritable
3143 || get_availability () > AVAIL_INTERPOSABLE)
3145 if (callback (this, data))
3146 return true;
3148 if (has_aliases_p ())
3149 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3150 return false;
3153 /* Call callback on function and aliases associated to the function.
3154 When INCLUDE_OVERWRITABLE is false, overwritable symbols are
3155 skipped. */
3157 inline bool
3158 cgraph_node::call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
3159 void *),
3160 void *data,
3161 bool include_overwritable)
3163 if (include_overwritable
3164 || get_availability () > AVAIL_INTERPOSABLE)
3166 if (callback (this, data))
3167 return true;
3169 if (has_aliases_p ())
3170 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3171 return false;
3174 /* Call calback on varpool symbol and aliases associated to varpool symbol.
3175 When INCLUDE_OVERWRITABLE is false, overwritable symbols are
3176 skipped. */
3178 inline bool
3179 varpool_node::call_for_symbol_and_aliases (bool (*callback) (varpool_node *,
3180 void *),
3181 void *data,
3182 bool include_overwritable)
3184 if (include_overwritable
3185 || get_availability () > AVAIL_INTERPOSABLE)
3187 if (callback (this, data))
3188 return true;
3190 if (has_aliases_p ())
3191 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3192 return false;
3195 /* Return true if refernece may be used in address compare. */
3197 inline bool
3198 ipa_ref::address_matters_p ()
3200 if (use != IPA_REF_ADDR)
3201 return false;
3202 /* Addresses taken from virtual tables are never compared. */
3203 if (is_a <varpool_node *> (referring)
3204 && DECL_VIRTUAL_P (referring->decl))
3205 return false;
3206 return referred->address_can_be_compared_p ();
3209 /* Build polymorphic call context for indirect call E. */
3211 inline
3212 ipa_polymorphic_call_context::ipa_polymorphic_call_context (cgraph_edge *e)
3214 gcc_checking_assert (e->indirect_info->polymorphic);
3215 *this = e->indirect_info->context;
3218 /* Build empty "I know nothing" context. */
3220 inline
3221 ipa_polymorphic_call_context::ipa_polymorphic_call_context ()
3223 clear_speculation ();
3224 clear_outer_type ();
3225 invalid = false;
3228 /* Make context non-speculative. */
3230 inline void
3231 ipa_polymorphic_call_context::clear_speculation ()
3233 speculative_outer_type = NULL;
3234 speculative_offset = 0;
3235 speculative_maybe_derived_type = false;
3238 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
3239 NULL, the context is set to dummy "I know nothing" setting. */
3241 inline void
3242 ipa_polymorphic_call_context::clear_outer_type (tree otr_type)
3244 outer_type = otr_type ? TYPE_MAIN_VARIANT (otr_type) : NULL;
3245 offset = 0;
3246 maybe_derived_type = true;
3247 maybe_in_construction = true;
3248 dynamic = true;
3251 /* Adjust all offsets in contexts by OFF bits. */
3253 inline void
3254 ipa_polymorphic_call_context::offset_by (HOST_WIDE_INT off)
3256 if (outer_type)
3257 offset += off;
3258 if (speculative_outer_type)
3259 speculative_offset += off;
3262 /* Return TRUE if context is fully useless. */
3264 inline bool
3265 ipa_polymorphic_call_context::useless_p () const
3267 return (!outer_type && !speculative_outer_type);
3270 /* Return true if NODE is local. Instrumentation clones are counted as local
3271 only when original function is local. */
3273 static inline bool
3274 cgraph_local_p (cgraph_node *node)
3276 if (!node->instrumentation_clone || !node->instrumented_version)
3277 return node->local.local;
3279 return node->local.local && node->instrumented_version->local.local;
3282 /* When using fprintf (or similar), problems can arise with
3283 transient generated strings. Many string-generation APIs
3284 only support one result being alive at once (e.g. by
3285 returning a pointer to a statically-allocated buffer).
3287 If there is more than one generated string within one
3288 fprintf call: the first string gets evicted or overwritten
3289 by the second, before fprintf is fully evaluated.
3290 See e.g. PR/53136.
3292 This function provides a workaround for this, by providing
3293 a simple way to create copies of these transient strings,
3294 without the need to have explicit cleanup:
3296 fprintf (dumpfile, "string 1: %s string 2:%s\n",
3297 xstrdup_for_dump (EXPR_1),
3298 xstrdup_for_dump (EXPR_2));
3300 This is actually a simple wrapper around ggc_strdup, but
3301 the name documents the intent. We require that no GC can occur
3302 within the fprintf call. */
3304 static inline const char *
3305 xstrdup_for_dump (const char *transient_str)
3307 return ggc_strdup (transient_str);
3310 #endif /* GCC_CGRAPH_H */