[Patch AArch64 1/3] Enable CRC by default for armv8.1-a
[official-gcc.git] / gcc / cgraph.h
blob0d5806b458ebb7bcfad966e342d423053d38d519
1 /* Callgraph handling code.
2 Copyright (C) 2003-2016 Free Software Foundation, Inc.
3 Contributed by Jan Hubicka
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
10 version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
21 #ifndef GCC_CGRAPH_H
22 #define GCC_CGRAPH_H
24 #include "ipa-ref.h"
25 #include "plugin-api.h"
27 class ipa_opt_pass_d;
28 typedef ipa_opt_pass_d *ipa_opt_pass;
30 /* Symbol table consists of functions and variables.
31 TODO: add labels and CONST_DECLs. */
32 enum symtab_type
34 SYMTAB_SYMBOL,
35 SYMTAB_FUNCTION,
36 SYMTAB_VARIABLE
39 /* Section names are stored as reference counted strings in GGC safe hashtable
40 (to make them survive through PCH). */
42 struct GTY((for_user)) section_hash_entry
44 int ref_count;
45 char *name; /* As long as this datastructure stays in GGC, we can not put
46 string at the tail of structure of GGC dies in horrible
47 way */
50 struct section_name_hasher : ggc_ptr_hash<section_hash_entry>
52 typedef const char *compare_type;
54 static hashval_t hash (section_hash_entry *);
55 static bool equal (section_hash_entry *, const char *);
58 enum availability
60 /* Not yet set by cgraph_function_body_availability. */
61 AVAIL_UNSET,
62 /* Function body/variable initializer is unknown. */
63 AVAIL_NOT_AVAILABLE,
64 /* Function body/variable initializer is known but might be replaced
65 by a different one from other compilation unit and thus needs to
66 be dealt with a care. Like AVAIL_NOT_AVAILABLE it can have
67 arbitrary side effects on escaping variables and functions, while
68 like AVAILABLE it might access static variables. */
69 AVAIL_INTERPOSABLE,
70 /* Function body/variable initializer is known and will be used in final
71 program. */
72 AVAIL_AVAILABLE,
73 /* Function body/variable initializer is known and all it's uses are
74 explicitly visible within current unit (ie it's address is never taken and
75 it is not exported to other units). Currently used only for functions. */
76 AVAIL_LOCAL
79 /* Classification of symbols WRT partitioning. */
80 enum symbol_partitioning_class
82 /* External declarations are ignored by partitioning algorithms and they are
83 added into the boundary later via compute_ltrans_boundary. */
84 SYMBOL_EXTERNAL,
85 /* Partitioned symbols are pur into one of partitions. */
86 SYMBOL_PARTITION,
87 /* Duplicated symbols (such as comdat or constant pool references) are
88 copied into every node needing them via add_symbol_to_partition. */
89 SYMBOL_DUPLICATE
92 /* Base of all entries in the symbol table.
93 The symtab_node is inherited by cgraph and varpol nodes. */
94 class GTY((desc ("%h.type"), tag ("SYMTAB_SYMBOL"),
95 chain_next ("%h.next"), chain_prev ("%h.previous")))
96 symtab_node
98 public:
99 /* Return name. */
100 const char *name () const;
102 /* Return asm name. */
103 const char * asm_name () const;
105 /* Add node into symbol table. This function is not used directly, but via
106 cgraph/varpool node creation routines. */
107 void register_symbol (void);
109 /* Remove symbol from symbol table. */
110 void remove (void);
112 /* Dump symtab node to F. */
113 void dump (FILE *f);
115 /* Dump symtab node to stderr. */
116 void DEBUG_FUNCTION debug (void);
118 /* Verify consistency of node. */
119 void DEBUG_FUNCTION verify (void);
121 /* Return ipa reference from this symtab_node to
122 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
123 of the use and STMT the statement (if it exists). */
124 ipa_ref *create_reference (symtab_node *referred_node,
125 enum ipa_ref_use use_type);
127 /* Return ipa reference from this symtab_node to
128 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
129 of the use and STMT the statement (if it exists). */
130 ipa_ref *create_reference (symtab_node *referred_node,
131 enum ipa_ref_use use_type, gimple *stmt);
133 /* If VAL is a reference to a function or a variable, add a reference from
134 this symtab_node to the corresponding symbol table node. USE_TYPE specify
135 type of the use and STMT the statement (if it exists). Return the new
136 reference or NULL if none was created. */
137 ipa_ref *maybe_create_reference (tree val, enum ipa_ref_use use_type,
138 gimple *stmt);
140 /* Clone all references from symtab NODE to this symtab_node. */
141 void clone_references (symtab_node *node);
143 /* Remove all stmt references in non-speculative references.
144 Those are not maintained during inlining & clonning.
145 The exception are speculative references that are updated along
146 with callgraph edges associated with them. */
147 void clone_referring (symtab_node *node);
149 /* Clone reference REF to this symtab_node and set its stmt to STMT. */
150 ipa_ref *clone_reference (ipa_ref *ref, gimple *stmt);
152 /* Find the structure describing a reference to REFERRED_NODE
153 and associated with statement STMT. */
154 ipa_ref *find_reference (symtab_node *referred_node, gimple *stmt,
155 unsigned int lto_stmt_uid);
157 /* Remove all references that are associated with statement STMT. */
158 void remove_stmt_references (gimple *stmt);
160 /* Remove all stmt references in non-speculative references.
161 Those are not maintained during inlining & clonning.
162 The exception are speculative references that are updated along
163 with callgraph edges associated with them. */
164 void clear_stmts_in_references (void);
166 /* Remove all references in ref list. */
167 void remove_all_references (void);
169 /* Remove all referring items in ref list. */
170 void remove_all_referring (void);
172 /* Dump references in ref list to FILE. */
173 void dump_references (FILE *file);
175 /* Dump referring in list to FILE. */
176 void dump_referring (FILE *);
178 /* Get number of references for this node. */
179 inline unsigned num_references (void)
181 return ref_list.references ? ref_list.references->length () : 0;
184 /* Iterates I-th reference in the list, REF is also set. */
185 ipa_ref *iterate_reference (unsigned i, ipa_ref *&ref);
187 /* Iterates I-th referring item in the list, REF is also set. */
188 ipa_ref *iterate_referring (unsigned i, ipa_ref *&ref);
190 /* Iterates I-th referring alias item in the list, REF is also set. */
191 ipa_ref *iterate_direct_aliases (unsigned i, ipa_ref *&ref);
193 /* Return true if symtab node and TARGET represents
194 semantically equivalent symbols. */
195 bool semantically_equivalent_p (symtab_node *target);
197 /* Classify symbol symtab node for partitioning. */
198 enum symbol_partitioning_class get_partitioning_class (void);
200 /* Return comdat group. */
201 tree get_comdat_group ()
203 return x_comdat_group;
206 /* Return comdat group as identifier_node. */
207 tree get_comdat_group_id ()
209 if (x_comdat_group && TREE_CODE (x_comdat_group) != IDENTIFIER_NODE)
210 x_comdat_group = DECL_ASSEMBLER_NAME (x_comdat_group);
211 return x_comdat_group;
214 /* Set comdat group. */
215 void set_comdat_group (tree group)
217 gcc_checking_assert (!group || TREE_CODE (group) == IDENTIFIER_NODE
218 || DECL_P (group));
219 x_comdat_group = group;
222 /* Return section as string. */
223 const char * get_section ()
225 if (!x_section)
226 return NULL;
227 return x_section->name;
230 /* Remove node from same comdat group. */
231 void remove_from_same_comdat_group (void);
233 /* Add this symtab_node to the same comdat group that OLD is in. */
234 void add_to_same_comdat_group (symtab_node *old_node);
236 /* Dissolve the same_comdat_group list in which NODE resides. */
237 void dissolve_same_comdat_group_list (void);
239 /* Return true when symtab_node is known to be used from other (non-LTO)
240 object file. Known only when doing LTO via linker plugin. */
241 bool used_from_object_file_p (void);
243 /* Walk the alias chain to return the symbol NODE is alias of.
244 If NODE is not an alias, return NODE.
245 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
246 symtab_node *ultimate_alias_target (enum availability *avail = NULL);
248 /* Return next reachable static symbol with initializer after NODE. */
249 inline symtab_node *next_defined_symbol (void);
251 /* Add reference recording that symtab node is alias of TARGET.
252 If TRANSPARENT is true make the alias to be transparent alias.
253 The function can fail in the case of aliasing cycles; in this case
254 it returns false. */
255 bool resolve_alias (symtab_node *target, bool transparent = false);
257 /* C++ FE sometimes change linkage flags after producing same
258 body aliases. */
259 void fixup_same_cpp_alias_visibility (symtab_node *target);
261 /* Call callback on symtab node and aliases associated to this node.
262 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
263 skipped. */
264 bool call_for_symbol_and_aliases (bool (*callback) (symtab_node *, void *),
265 void *data,
266 bool include_overwrite);
268 /* If node can not be interposable by static or dynamic linker to point to
269 different definition, return this symbol. Otherwise look for alias with
270 such property and if none exists, introduce new one. */
271 symtab_node *noninterposable_alias (void);
273 /* Return node that alias is aliasing. */
274 inline symtab_node *get_alias_target (void);
276 /* Set section for symbol and its aliases. */
277 void set_section (const char *section);
279 /* Set section, do not recurse into aliases.
280 When one wants to change section of symbol and its aliases,
281 use set_section. */
282 void set_section_for_node (const char *section);
284 /* Set initialization priority to PRIORITY. */
285 void set_init_priority (priority_type priority);
287 /* Return the initialization priority. */
288 priority_type get_init_priority ();
290 /* Return availability of NODE. */
291 enum availability get_availability (void);
293 /* Make DECL local. */
294 void make_decl_local (void);
296 /* Copy visibility from N. */
297 void copy_visibility_from (symtab_node *n);
299 /* Return desired alignment of the definition. This is NOT alignment useful
300 to access THIS, because THIS may be interposable and DECL_ALIGN should
301 be used instead. It however must be guaranteed when output definition
302 of THIS. */
303 unsigned int definition_alignment ();
305 /* Return true if alignment can be increased. */
306 bool can_increase_alignment_p ();
308 /* Increase alignment of symbol to ALIGN. */
309 void increase_alignment (unsigned int align);
311 /* Return true if list contains an alias. */
312 bool has_aliases_p (void);
314 /* Return true when the symbol is real symbol, i.e. it is not inline clone
315 or abstract function kept for debug info purposes only. */
316 bool real_symbol_p (void);
318 /* Determine if symbol declaration is needed. That is, visible to something
319 either outside this translation unit, something magic in the system
320 configury. This function is used just during symbol creation. */
321 bool needed_p (void);
323 /* Return true when there are references to the node. */
324 bool referred_to_p (bool include_self = true);
326 /* Return true if symbol can be discarded by linker from the binary.
327 Assume that symbol is used (so there is no need to take into account
328 garbage collecting linkers)
330 This can happen for comdats, commons and weaks when they are previaled
331 by other definition at static linking time. */
332 inline bool
333 can_be_discarded_p (void)
335 return (DECL_EXTERNAL (decl)
336 || ((get_comdat_group ()
337 || DECL_COMMON (decl)
338 || (DECL_SECTION_NAME (decl) && DECL_WEAK (decl)))
339 && ((resolution != LDPR_PREVAILING_DEF
340 && resolution != LDPR_PREVAILING_DEF_IRONLY_EXP)
341 || flag_incremental_link)
342 && resolution != LDPR_PREVAILING_DEF_IRONLY));
345 /* Return true if NODE is local to a particular COMDAT group, and must not
346 be named from outside the COMDAT. This is used for C++ decloned
347 constructors. */
348 inline bool comdat_local_p (void)
350 return (same_comdat_group && !TREE_PUBLIC (decl));
353 /* Return true if ONE and TWO are part of the same COMDAT group. */
354 inline bool in_same_comdat_group_p (symtab_node *target);
356 /* Return true if symbol is known to be nonzero. */
357 bool nonzero_address ();
359 /* Return 0 if symbol is known to have different address than S2,
360 Return 1 if symbol is known to have same address as S2,
361 return 2 otherwise.
363 If MEMORY_ACCESSED is true, assume that both memory pointer to THIS
364 and S2 is going to be accessed. This eliminates the situations when
365 either THIS or S2 is NULL and is seful for comparing bases when deciding
366 about memory aliasing. */
367 int equal_address_to (symtab_node *s2, bool memory_accessed = false);
369 /* Return true if symbol's address may possibly be compared to other
370 symbol's address. */
371 bool address_matters_p ();
373 /* Return true if NODE's address can be compared. This use properties
374 of NODE only and does not look if the address is actually taken in
375 interesting way. For that use ADDRESS_MATTERS_P instead. */
376 bool address_can_be_compared_p (void);
378 /* Return symbol table node associated with DECL, if any,
379 and NULL otherwise. */
380 static inline symtab_node *get (const_tree decl)
382 /* Check that we are called for sane type of object - functions
383 and static or external variables. */
384 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL
385 || (TREE_CODE (decl) == VAR_DECL
386 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl)
387 || in_lto_p)));
388 /* Check that the mapping is sane - perhaps this check can go away,
389 but at the moment frontends tends to corrupt the mapping by calling
390 memcpy/memset on the tree nodes. */
391 gcc_checking_assert (!decl->decl_with_vis.symtab_node
392 || decl->decl_with_vis.symtab_node->decl == decl);
393 return decl->decl_with_vis.symtab_node;
396 /* Try to find a symtab node for declaration DECL and if it does not
397 exist or if it corresponds to an inline clone, create a new one. */
398 static inline symtab_node * get_create (tree node);
400 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
401 Return NULL if there's no such node. */
402 static symtab_node *get_for_asmname (const_tree asmname);
404 /* Dump symbol table to F. */
405 static void dump_table (FILE *);
407 /* Dump symbol table to stderr. */
408 static inline DEBUG_FUNCTION void debug_symtab (void)
410 dump_table (stderr);
413 /* Verify symbol table for internal consistency. */
414 static DEBUG_FUNCTION void verify_symtab_nodes (void);
416 /* Perform internal consistency checks, if they are enabled. */
417 static inline void checking_verify_symtab_nodes (void);
419 /* Type of the symbol. */
420 ENUM_BITFIELD (symtab_type) type : 8;
422 /* The symbols resolution. */
423 ENUM_BITFIELD (ld_plugin_symbol_resolution) resolution : 8;
425 /*** Flags representing the symbol type. ***/
427 /* True when symbol corresponds to a definition in current unit.
428 set via finalize_function or finalize_decl */
429 unsigned definition : 1;
430 /* True when symbol is an alias.
431 Set by ssemble_alias. */
432 unsigned alias : 1;
433 /* When true the alias is translated into its target symbol either by GCC
434 or assembler (it also may just be a duplicate declaration of the same
435 linker name).
437 Currently transparent aliases come in three different flavors
438 - aliases having the same assembler name as their target (aka duplicated
439 declarations). In this case the assembler names compare via
440 assembler_names_equal_p and weakref is false
441 - aliases that are renamed at a time being output to final file
442 by varasm.c. For those DECL_ASSEMBLER_NAME have
443 IDENTIFIER_TRANSPARENT_ALIAS set and thus also their assembler
444 name must be unique.
445 Weakrefs belong to this cateogry when we target assembler without
446 .weakref directive.
447 - weakrefs that are renamed by assembler via .weakref directive.
448 In this case the alias may or may not be definition (depending if
449 target declaration was seen by the compiler), weakref is set.
450 Unless we are before renaming statics, assembler names are different.
452 Given that we now support duplicate declarations, the second option is
453 redundant and will be removed. */
454 unsigned transparent_alias : 1;
455 /* True when alias is a weakref. */
456 unsigned weakref : 1;
457 /* C++ frontend produce same body aliases and extra name aliases for
458 virtual functions and vtables that are obviously equivalent.
459 Those aliases are bit special, especially because C++ frontend
460 visibility code is so ugly it can not get them right at first time
461 and their visibility needs to be copied from their "masters" at
462 the end of parsing. */
463 unsigned cpp_implicit_alias : 1;
464 /* Set once the definition was analyzed. The list of references and
465 other properties are built during analysis. */
466 unsigned analyzed : 1;
467 /* Set for write-only variables. */
468 unsigned writeonly : 1;
469 /* Visibility of symbol was used for further optimization; do not
470 permit further changes. */
471 unsigned refuse_visibility_changes : 1;
473 /*** Visibility and linkage flags. ***/
475 /* Set when function is visible by other units. */
476 unsigned externally_visible : 1;
477 /* Don't reorder to other symbols having this set. */
478 unsigned no_reorder : 1;
479 /* The symbol will be assumed to be used in an invisible way (like
480 by an toplevel asm statement). */
481 unsigned force_output : 1;
482 /* Like FORCE_OUTPUT, but in the case it is ABI requiring the symbol to be
483 exported. Unlike FORCE_OUTPUT this flag gets cleared to symbols promoted
484 to static and it does not inhibit optimization. */
485 unsigned forced_by_abi : 1;
486 /* True when the name is known to be unique and thus it does not need mangling. */
487 unsigned unique_name : 1;
488 /* Specify whether the section was set by user or by
489 compiler via -ffunction-sections. */
490 unsigned implicit_section : 1;
491 /* True when body and other characteristics have been removed by
492 symtab_remove_unreachable_nodes. */
493 unsigned body_removed : 1;
495 /*** WHOPR Partitioning flags.
496 These flags are used at ltrans stage when only part of the callgraph is
497 available. ***/
499 /* Set when variable is used from other LTRANS partition. */
500 unsigned used_from_other_partition : 1;
501 /* Set when function is available in the other LTRANS partition.
502 During WPA output it is used to mark nodes that are present in
503 multiple partitions. */
504 unsigned in_other_partition : 1;
508 /*** other flags. ***/
510 /* Set when symbol has address taken. */
511 unsigned address_taken : 1;
512 /* Set when init priority is set. */
513 unsigned in_init_priority_hash : 1;
515 /* Set when symbol needs to be streamed into LTO bytecode for LTO, or in case
516 of offloading, for separate compilation for a different target. */
517 unsigned need_lto_streaming : 1;
519 /* Set when symbol can be streamed into bytecode for offloading. */
520 unsigned offloadable : 1;
523 /* Ordering of all symtab entries. */
524 int order;
526 /* Declaration representing the symbol. */
527 tree decl;
529 /* Linked list of symbol table entries starting with symtab_nodes. */
530 symtab_node *next;
531 symtab_node *previous;
533 /* Linked list of symbols with the same asm name. There may be multiple
534 entries for single symbol name during LTO, because symbols are renamed
535 only after partitioning.
537 Because inline clones are kept in the assembler name has, they also produce
538 duplicate entries.
540 There are also several long standing bugs where frontends and builtin
541 code produce duplicated decls. */
542 symtab_node *next_sharing_asm_name;
543 symtab_node *previous_sharing_asm_name;
545 /* Circular list of nodes in the same comdat group if non-NULL. */
546 symtab_node *same_comdat_group;
548 /* Vectors of referring and referenced entities. */
549 ipa_ref_list ref_list;
551 /* Alias target. May be either DECL pointer or ASSEMBLER_NAME pointer
552 depending to what was known to frontend on the creation time.
553 Once alias is resolved, this pointer become NULL. */
554 tree alias_target;
556 /* File stream where this node is being written to. */
557 struct lto_file_decl_data * lto_file_data;
559 PTR GTY ((skip)) aux;
561 /* Comdat group the symbol is in. Can be private if GGC allowed that. */
562 tree x_comdat_group;
564 /* Section name. Again can be private, if allowed. */
565 section_hash_entry *x_section;
567 protected:
568 /* Dump base fields of symtab nodes to F. Not to be used directly. */
569 void dump_base (FILE *);
571 /* Verify common part of symtab node. */
572 bool DEBUG_FUNCTION verify_base (void);
574 /* Remove node from symbol table. This function is not used directly, but via
575 cgraph/varpool node removal routines. */
576 void unregister (void);
578 /* Return the initialization and finalization priority information for
579 DECL. If there is no previous priority information, a freshly
580 allocated structure is returned. */
581 struct symbol_priority_map *priority_info (void);
583 /* Worker for call_for_symbol_and_aliases_1. */
584 bool call_for_symbol_and_aliases_1 (bool (*callback) (symtab_node *, void *),
585 void *data,
586 bool include_overwrite);
587 private:
588 /* Worker for set_section. */
589 static bool set_section (symtab_node *n, void *s);
591 /* Worker for symtab_resolve_alias. */
592 static bool set_implicit_section (symtab_node *n, void *);
594 /* Worker searching noninterposable alias. */
595 static bool noninterposable_alias (symtab_node *node, void *data);
597 /* Worker for ultimate_alias_target. */
598 symtab_node *ultimate_alias_target_1 (enum availability *avail = NULL);
601 inline void
602 symtab_node::checking_verify_symtab_nodes (void)
604 if (flag_checking)
605 symtab_node::verify_symtab_nodes ();
608 /* Walk all aliases for NODE. */
609 #define FOR_EACH_ALIAS(node, alias) \
610 for (unsigned x_i = 0; node->iterate_direct_aliases (x_i, alias); x_i++)
612 /* This is the information that is put into the cgraph local structure
613 to recover a function. */
614 struct lto_file_decl_data;
616 extern const char * const cgraph_availability_names[];
617 extern const char * const ld_plugin_symbol_resolution_names[];
618 extern const char * const tls_model_names[];
620 /* Information about thunk, used only for same body aliases. */
622 struct GTY(()) cgraph_thunk_info {
623 /* Information about the thunk. */
624 HOST_WIDE_INT fixed_offset;
625 HOST_WIDE_INT virtual_value;
626 tree alias;
627 bool this_adjusting;
628 bool virtual_offset_p;
629 bool add_pointer_bounds_args;
630 /* Set to true when alias node is thunk. */
631 bool thunk_p;
634 /* Information about the function collected locally.
635 Available after function is analyzed. */
637 struct GTY(()) cgraph_local_info {
638 /* Set when function is visible in current compilation unit only and
639 its address is never taken. */
640 unsigned local : 1;
642 /* False when there is something makes versioning impossible. */
643 unsigned versionable : 1;
645 /* False when function calling convention and signature can not be changed.
646 This is the case when __builtin_apply_args is used. */
647 unsigned can_change_signature : 1;
649 /* True when the function has been originally extern inline, but it is
650 redefined now. */
651 unsigned redefined_extern_inline : 1;
653 /* True if the function may enter serial irrevocable mode. */
654 unsigned tm_may_enter_irr : 1;
657 /* Information about the function that needs to be computed globally
658 once compilation is finished. Available only with -funit-at-a-time. */
660 struct GTY(()) cgraph_global_info {
661 /* For inline clones this points to the function they will be
662 inlined into. */
663 cgraph_node *inlined_to;
666 /* Represent which DECL tree (or reference to such tree)
667 will be replaced by another tree while versioning. */
668 struct GTY(()) ipa_replace_map
670 /* The tree that will be replaced. */
671 tree old_tree;
672 /* The new (replacing) tree. */
673 tree new_tree;
674 /* Parameter number to replace, when old_tree is NULL. */
675 int parm_num;
676 /* True when a substitution should be done, false otherwise. */
677 bool replace_p;
678 /* True when we replace a reference to old_tree. */
679 bool ref_p;
682 struct GTY(()) cgraph_clone_info
684 vec<ipa_replace_map *, va_gc> *tree_map;
685 bitmap args_to_skip;
686 bitmap combined_args_to_skip;
689 enum cgraph_simd_clone_arg_type
691 SIMD_CLONE_ARG_TYPE_VECTOR,
692 SIMD_CLONE_ARG_TYPE_UNIFORM,
693 /* These are only for integer/pointer arguments passed by value. */
694 SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP,
695 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP,
696 /* These 6 are only for reference type arguments or arguments passed
697 by reference. */
698 SIMD_CLONE_ARG_TYPE_LINEAR_REF_CONSTANT_STEP,
699 SIMD_CLONE_ARG_TYPE_LINEAR_REF_VARIABLE_STEP,
700 SIMD_CLONE_ARG_TYPE_LINEAR_UVAL_CONSTANT_STEP,
701 SIMD_CLONE_ARG_TYPE_LINEAR_UVAL_VARIABLE_STEP,
702 SIMD_CLONE_ARG_TYPE_LINEAR_VAL_CONSTANT_STEP,
703 SIMD_CLONE_ARG_TYPE_LINEAR_VAL_VARIABLE_STEP,
704 SIMD_CLONE_ARG_TYPE_MASK
707 /* Function arguments in the original function of a SIMD clone.
708 Supplementary data for `struct simd_clone'. */
710 struct GTY(()) cgraph_simd_clone_arg {
711 /* Original function argument as it originally existed in
712 DECL_ARGUMENTS. */
713 tree orig_arg;
715 /* orig_arg's function (or for extern functions type from
716 TYPE_ARG_TYPES). */
717 tree orig_type;
719 /* If argument is a vector, this holds the vector version of
720 orig_arg that after adjusting the argument types will live in
721 DECL_ARGUMENTS. Otherwise, this is NULL.
723 This basically holds:
724 vector(simdlen) __typeof__(orig_arg) new_arg. */
725 tree vector_arg;
727 /* vector_arg's type (or for extern functions new vector type. */
728 tree vector_type;
730 /* If argument is a vector, this holds the array where the simd
731 argument is held while executing the simd clone function. This
732 is a local variable in the cloned function. Its content is
733 copied from vector_arg upon entry to the clone.
735 This basically holds:
736 __typeof__(orig_arg) simd_array[simdlen]. */
737 tree simd_array;
739 /* A SIMD clone's argument can be either linear (constant or
740 variable), uniform, or vector. */
741 enum cgraph_simd_clone_arg_type arg_type;
743 /* For arg_type SIMD_CLONE_ARG_TYPE_LINEAR_*CONSTANT_STEP this is
744 the constant linear step, if arg_type is
745 SIMD_CLONE_ARG_TYPE_LINEAR_*VARIABLE_STEP, this is index of
746 the uniform argument holding the step, otherwise 0. */
747 HOST_WIDE_INT linear_step;
749 /* Variable alignment if available, otherwise 0. */
750 unsigned int alignment;
753 /* Specific data for a SIMD function clone. */
755 struct GTY(()) cgraph_simd_clone {
756 /* Number of words in the SIMD lane associated with this clone. */
757 unsigned int simdlen;
759 /* Number of annotated function arguments in `args'. This is
760 usually the number of named arguments in FNDECL. */
761 unsigned int nargs;
763 /* Max hardware vector size in bits for integral vectors. */
764 unsigned int vecsize_int;
766 /* Max hardware vector size in bits for floating point vectors. */
767 unsigned int vecsize_float;
769 /* Machine mode of the mask argument(s), if they are to be passed
770 as bitmasks in integer argument(s). VOIDmode if masks are passed
771 as vectors of characteristic type. */
772 machine_mode mask_mode;
774 /* The mangling character for a given vector size. This is used
775 to determine the ISA mangling bit as specified in the Intel
776 Vector ABI. */
777 unsigned char vecsize_mangle;
779 /* True if this is the masked, in-branch version of the clone,
780 otherwise false. */
781 unsigned int inbranch : 1;
783 /* True if this is a Cilk Plus variant. */
784 unsigned int cilk_elemental : 1;
786 /* Doubly linked list of SIMD clones. */
787 cgraph_node *prev_clone, *next_clone;
789 /* Original cgraph node the SIMD clones were created for. */
790 cgraph_node *origin;
792 /* Annotated function arguments for the original function. */
793 cgraph_simd_clone_arg GTY((length ("%h.nargs"))) args[1];
796 /* Function Multiversioning info. */
797 struct GTY((for_user)) cgraph_function_version_info {
798 /* The cgraph_node for which the function version info is stored. */
799 cgraph_node *this_node;
800 /* Chains all the semantically identical function versions. The
801 first function in this chain is the version_info node of the
802 default function. */
803 cgraph_function_version_info *prev;
804 /* If this version node corresponds to a dispatcher for function
805 versions, this points to the version info node of the default
806 function, the first node in the chain. */
807 cgraph_function_version_info *next;
808 /* If this node corresponds to a function version, this points
809 to the dispatcher function decl, which is the function that must
810 be called to execute the right function version at run-time.
812 If this cgraph node is a dispatcher (if dispatcher_function is
813 true, in the cgraph_node struct) for function versions, this
814 points to resolver function, which holds the function body of the
815 dispatcher. The dispatcher decl is an alias to the resolver
816 function decl. */
817 tree dispatcher_resolver;
820 #define DEFCIFCODE(code, type, string) CIF_ ## code,
821 /* Reasons for inlining failures. */
823 enum cgraph_inline_failed_t {
824 #include "cif-code.def"
825 CIF_N_REASONS
828 enum cgraph_inline_failed_type_t
830 CIF_FINAL_NORMAL = 0,
831 CIF_FINAL_ERROR
834 struct cgraph_edge;
836 struct cgraph_edge_hasher : ggc_ptr_hash<cgraph_edge>
838 typedef gimple *compare_type;
840 static hashval_t hash (cgraph_edge *);
841 static hashval_t hash (gimple *);
842 static bool equal (cgraph_edge *, gimple *);
845 /* The cgraph data structure.
846 Each function decl has assigned cgraph_node listing callees and callers. */
848 struct GTY((tag ("SYMTAB_FUNCTION"))) cgraph_node : public symtab_node {
849 public:
850 /* Remove the node from cgraph and all inline clones inlined into it.
851 Skip however removal of FORBIDDEN_NODE and return true if it needs to be
852 removed. This allows to call the function from outer loop walking clone
853 tree. */
854 bool remove_symbol_and_inline_clones (cgraph_node *forbidden_node = NULL);
856 /* Record all references from cgraph_node that are taken
857 in statement STMT. */
858 void record_stmt_references (gimple *stmt);
860 /* Like cgraph_set_call_stmt but walk the clone tree and update all
861 clones sharing the same function body.
862 When WHOLE_SPECULATIVE_EDGES is true, all three components of
863 speculative edge gets updated. Otherwise we update only direct
864 call. */
865 void set_call_stmt_including_clones (gimple *old_stmt, gcall *new_stmt,
866 bool update_speculative = true);
868 /* Walk the alias chain to return the function cgraph_node is alias of.
869 Walk through thunk, too.
870 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
871 cgraph_node *function_symbol (enum availability *avail = NULL);
873 /* Walk the alias chain to return the function cgraph_node is alias of.
874 Walk through non virtual thunks, too. Thus we return either a function
875 or a virtual thunk node.
876 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
877 cgraph_node *function_or_virtual_thunk_symbol
878 (enum availability *avail = NULL);
880 /* Create node representing clone of N executed COUNT times. Decrease
881 the execution counts from original node too.
882 The new clone will have decl set to DECL that may or may not be the same
883 as decl of N.
885 When UPDATE_ORIGINAL is true, the counts are subtracted from the original
886 function's profile to reflect the fact that part of execution is handled
887 by node.
888 When CALL_DUPLICATOIN_HOOK is true, the ipa passes are acknowledged about
889 the new clone. Otherwise the caller is responsible for doing so later.
891 If the new node is being inlined into another one, NEW_INLINED_TO should be
892 the outline function the new one is (even indirectly) inlined to.
893 All hooks will see this in node's global.inlined_to, when invoked.
894 Can be NULL if the node is not inlined. */
895 cgraph_node *create_clone (tree decl, gcov_type count, int freq,
896 bool update_original,
897 vec<cgraph_edge *> redirect_callers,
898 bool call_duplication_hook,
899 cgraph_node *new_inlined_to,
900 bitmap args_to_skip);
902 /* Create callgraph node clone with new declaration. The actual body will
903 be copied later at compilation stage. */
904 cgraph_node *create_virtual_clone (vec<cgraph_edge *> redirect_callers,
905 vec<ipa_replace_map *, va_gc> *tree_map,
906 bitmap args_to_skip, const char * suffix);
908 /* cgraph node being removed from symbol table; see if its entry can be
909 replaced by other inline clone. */
910 cgraph_node *find_replacement (void);
912 /* Create a new cgraph node which is the new version of
913 callgraph node. REDIRECT_CALLERS holds the callers
914 edges which should be redirected to point to
915 NEW_VERSION. ALL the callees edges of the node
916 are cloned to the new version node. Return the new
917 version node.
919 If non-NULL BLOCK_TO_COPY determine what basic blocks
920 was copied to prevent duplications of calls that are dead
921 in the clone. */
923 cgraph_node *create_version_clone (tree new_decl,
924 vec<cgraph_edge *> redirect_callers,
925 bitmap bbs_to_copy);
927 /* Perform function versioning.
928 Function versioning includes copying of the tree and
929 a callgraph update (creating a new cgraph node and updating
930 its callees and callers).
932 REDIRECT_CALLERS varray includes the edges to be redirected
933 to the new version.
935 TREE_MAP is a mapping of tree nodes we want to replace with
936 new ones (according to results of prior analysis).
938 If non-NULL ARGS_TO_SKIP determine function parameters to remove
939 from new version.
940 If SKIP_RETURN is true, the new version will return void.
941 If non-NULL BLOCK_TO_COPY determine what basic blocks to copy.
942 If non_NULL NEW_ENTRY determine new entry BB of the clone.
944 Return the new version's cgraph node. */
945 cgraph_node *create_version_clone_with_body
946 (vec<cgraph_edge *> redirect_callers,
947 vec<ipa_replace_map *, va_gc> *tree_map, bitmap args_to_skip,
948 bool skip_return, bitmap bbs_to_copy, basic_block new_entry_block,
949 const char *clone_name);
951 /* Insert a new cgraph_function_version_info node into cgraph_fnver_htab
952 corresponding to cgraph_node. */
953 cgraph_function_version_info *insert_new_function_version (void);
955 /* Get the cgraph_function_version_info node corresponding to node. */
956 cgraph_function_version_info *function_version (void);
958 /* Discover all functions and variables that are trivially needed, analyze
959 them as well as all functions and variables referred by them */
960 void analyze (void);
962 /* Add thunk alias into callgraph. The alias declaration is ALIAS and it
963 aliases DECL with an adjustments made into the first parameter.
964 See comments in thunk_adjust for detail on the parameters. */
965 cgraph_node * create_thunk (tree alias, tree, bool this_adjusting,
966 HOST_WIDE_INT fixed_offset,
967 HOST_WIDE_INT virtual_value,
968 tree virtual_offset,
969 tree real_alias);
972 /* Return node that alias is aliasing. */
973 inline cgraph_node *get_alias_target (void);
975 /* Given function symbol, walk the alias chain to return the function node
976 is alias of. Do not walk through thunks.
977 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
979 cgraph_node *ultimate_alias_target (availability *availability = NULL);
981 /* Expand thunk NODE to gimple if possible.
982 When FORCE_GIMPLE_THUNK is true, gimple thunk is created and
983 no assembler is produced.
984 When OUTPUT_ASM_THUNK is true, also produce assembler for
985 thunks that are not lowered. */
986 bool expand_thunk (bool output_asm_thunks, bool force_gimple_thunk);
988 /* Call expand_thunk on all callers that are thunks and analyze those
989 nodes that were expanded. */
990 void expand_all_artificial_thunks ();
992 /* Assemble thunks and aliases associated to node. */
993 void assemble_thunks_and_aliases (void);
995 /* Expand function specified by node. */
996 void expand (void);
998 /* As an GCC extension we allow redefinition of the function. The
999 semantics when both copies of bodies differ is not well defined.
1000 We replace the old body with new body so in unit at a time mode
1001 we always use new body, while in normal mode we may end up with
1002 old body inlined into some functions and new body expanded and
1003 inlined in others. */
1004 void reset (void);
1006 /* Creates a wrapper from cgraph_node to TARGET node. Thunk is used for this
1007 kind of wrapper method. */
1008 void create_wrapper (cgraph_node *target);
1010 /* Verify cgraph nodes of the cgraph node. */
1011 void DEBUG_FUNCTION verify_node (void);
1013 /* Remove function from symbol table. */
1014 void remove (void);
1016 /* Dump call graph node to file F. */
1017 void dump (FILE *f);
1019 /* Dump call graph node to stderr. */
1020 void DEBUG_FUNCTION debug (void);
1022 /* When doing LTO, read cgraph_node's body from disk if it is not already
1023 present. */
1024 bool get_untransformed_body (void);
1026 /* Prepare function body. When doing LTO, read cgraph_node's body from disk
1027 if it is not already present. When some IPA transformations are scheduled,
1028 apply them. */
1029 bool get_body (void);
1031 /* Release memory used to represent body of function.
1032 Use this only for functions that are released before being translated to
1033 target code (i.e. RTL). Functions that are compiled to RTL and beyond
1034 are free'd in final.c via free_after_compilation(). */
1035 void release_body (bool keep_arguments = false);
1037 /* Return the DECL_STRUCT_FUNCTION of the function. */
1038 struct function *get_fun (void);
1040 /* cgraph_node is no longer nested function; update cgraph accordingly. */
1041 void unnest (void);
1043 /* Bring cgraph node local. */
1044 void make_local (void);
1046 /* Likewise indicate that a node is having address taken. */
1047 void mark_address_taken (void);
1049 /* Set fialization priority to PRIORITY. */
1050 void set_fini_priority (priority_type priority);
1052 /* Return the finalization priority. */
1053 priority_type get_fini_priority (void);
1055 /* Create edge from a given function to CALLEE in the cgraph. */
1056 cgraph_edge *create_edge (cgraph_node *callee,
1057 gcall *call_stmt, gcov_type count,
1058 int freq);
1060 /* Create an indirect edge with a yet-undetermined callee where the call
1061 statement destination is a formal parameter of the caller with index
1062 PARAM_INDEX. */
1063 cgraph_edge *create_indirect_edge (gcall *call_stmt, int ecf_flags,
1064 gcov_type count, int freq,
1065 bool compute_indirect_info = true);
1067 /* Like cgraph_create_edge walk the clone tree and update all clones sharing
1068 same function body. If clones already have edge for OLD_STMT; only
1069 update the edge same way as cgraph_set_call_stmt_including_clones does. */
1070 void create_edge_including_clones (cgraph_node *callee,
1071 gimple *old_stmt, gcall *stmt,
1072 gcov_type count,
1073 int freq,
1074 cgraph_inline_failed_t reason);
1076 /* Return the callgraph edge representing the GIMPLE_CALL statement
1077 CALL_STMT. */
1078 cgraph_edge *get_edge (gimple *call_stmt);
1080 /* Collect all callers of cgraph_node and its aliases that are known to lead
1081 to NODE (i.e. are not overwritable) and that are not thunks. */
1082 vec<cgraph_edge *> collect_callers (void);
1084 /* Remove all callers from the node. */
1085 void remove_callers (void);
1087 /* Remove all callees from the node. */
1088 void remove_callees (void);
1090 /* Return function availability. See cgraph.h for description of individual
1091 return values. */
1092 enum availability get_availability (void);
1094 /* Set TREE_NOTHROW on cgraph_node's decl and on aliases of the node
1095 if any to NOTHROW. */
1096 void set_nothrow_flag (bool nothrow);
1098 /* Set TREE_READONLY on cgraph_node's decl and on aliases of the node
1099 if any to READONLY. */
1100 void set_const_flag (bool readonly, bool looping);
1102 /* Set DECL_PURE_P on cgraph_node's decl and on aliases of the node
1103 if any to PURE. */
1104 void set_pure_flag (bool pure, bool looping);
1106 /* Call callback on function and aliases associated to the function.
1107 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1108 skipped. */
1110 bool call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
1111 void *),
1112 void *data, bool include_overwritable);
1114 /* Call callback on cgraph_node, thunks and aliases associated to NODE.
1115 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1116 skipped. When EXCLUDE_VIRTUAL_THUNKS is true, virtual thunks are
1117 skipped. */
1118 bool call_for_symbol_thunks_and_aliases (bool (*callback) (cgraph_node *node,
1119 void *data),
1120 void *data,
1121 bool include_overwritable,
1122 bool exclude_virtual_thunks = false);
1124 /* Likewise indicate that a node is needed, i.e. reachable via some
1125 external means. */
1126 inline void mark_force_output (void);
1128 /* Return true when function can be marked local. */
1129 bool local_p (void);
1131 /* Return true if cgraph_node can be made local for API change.
1132 Extern inline functions and C++ COMDAT functions can be made local
1133 at the expense of possible code size growth if function is used in multiple
1134 compilation units. */
1135 bool can_be_local_p (void);
1137 /* Return true when cgraph_node can not return or throw and thus
1138 it is safe to ignore its side effects for IPA analysis. */
1139 bool cannot_return_p (void);
1141 /* Return true when function cgraph_node and all its aliases are only called
1142 directly.
1143 i.e. it is not externally visible, address was not taken and
1144 it is not used in any other non-standard way. */
1145 bool only_called_directly_p (void);
1147 /* Return true when function is only called directly or it has alias.
1148 i.e. it is not externally visible, address was not taken and
1149 it is not used in any other non-standard way. */
1150 inline bool only_called_directly_or_aliased_p (void);
1152 /* Return true when function cgraph_node can be expected to be removed
1153 from program when direct calls in this compilation unit are removed.
1155 As a special case COMDAT functions are
1156 cgraph_can_remove_if_no_direct_calls_p while the are not
1157 cgraph_only_called_directly_p (it is possible they are called from other
1158 unit)
1160 This function behaves as cgraph_only_called_directly_p because eliminating
1161 all uses of COMDAT function does not make it necessarily disappear from
1162 the program unless we are compiling whole program or we do LTO. In this
1163 case we know we win since dynamic linking will not really discard the
1164 linkonce section.
1166 If WILL_INLINE is true, assume that function will be inlined into all the
1167 direct calls. */
1168 bool will_be_removed_from_program_if_no_direct_calls_p
1169 (bool will_inline = false);
1171 /* Return true when function can be removed from callgraph
1172 if all direct calls and references are eliminated. The function does
1173 not take into account comdat groups. */
1174 bool can_remove_if_no_direct_calls_and_refs_p (void);
1176 /* Return true when function cgraph_node and its aliases can be removed from
1177 callgraph if all direct calls are eliminated.
1178 If WILL_INLINE is true, assume that function will be inlined into all the
1179 direct calls. */
1180 bool can_remove_if_no_direct_calls_p (bool will_inline = false);
1182 /* Return true when callgraph node is a function with Gimple body defined
1183 in current unit. Functions can also be define externally or they
1184 can be thunks with no Gimple representation.
1186 Note that at WPA stage, the function body may not be present in memory. */
1187 inline bool has_gimple_body_p (void);
1189 /* Return true if function should be optimized for size. */
1190 bool optimize_for_size_p (void);
1192 /* Dump the callgraph to file F. */
1193 static void dump_cgraph (FILE *f);
1195 /* Dump the call graph to stderr. */
1196 static inline
1197 void debug_cgraph (void)
1199 dump_cgraph (stderr);
1202 /* Record that DECL1 and DECL2 are semantically identical function
1203 versions. */
1204 static void record_function_versions (tree decl1, tree decl2);
1206 /* Remove the cgraph_function_version_info and cgraph_node for DECL. This
1207 DECL is a duplicate declaration. */
1208 static void delete_function_version (tree decl);
1210 /* Add the function FNDECL to the call graph.
1211 Unlike finalize_function, this function is intended to be used
1212 by middle end and allows insertion of new function at arbitrary point
1213 of compilation. The function can be either in high, low or SSA form
1214 GIMPLE.
1216 The function is assumed to be reachable and have address taken (so no
1217 API breaking optimizations are performed on it).
1219 Main work done by this function is to enqueue the function for later
1220 processing to avoid need the passes to be re-entrant. */
1221 static void add_new_function (tree fndecl, bool lowered);
1223 /* Return callgraph node for given symbol and check it is a function. */
1224 static inline cgraph_node *get (const_tree decl)
1226 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL);
1227 return dyn_cast <cgraph_node *> (symtab_node::get (decl));
1230 /* DECL has been parsed. Take it, queue it, compile it at the whim of the
1231 logic in effect. If NO_COLLECT is true, then our caller cannot stand to
1232 have the garbage collector run at the moment. We would need to either
1233 create a new GC context, or just not compile right now. */
1234 static void finalize_function (tree, bool);
1236 /* Return cgraph node assigned to DECL. Create new one when needed. */
1237 static cgraph_node * create (tree decl);
1239 /* Try to find a call graph node for declaration DECL and if it does not
1240 exist or if it corresponds to an inline clone, create a new one. */
1241 static cgraph_node * get_create (tree);
1243 /* Return local info for the compiled function. */
1244 static cgraph_local_info *local_info (tree decl);
1246 /* Return local info for the compiled function. */
1247 static struct cgraph_rtl_info *rtl_info (tree);
1249 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
1250 Return NULL if there's no such node. */
1251 static cgraph_node *get_for_asmname (tree asmname);
1253 /* Attempt to mark ALIAS as an alias to DECL. Return alias node if
1254 successful and NULL otherwise.
1255 Same body aliases are output whenever the body of DECL is output,
1256 and cgraph_node::get (ALIAS) transparently
1257 returns cgraph_node::get (DECL). */
1258 static cgraph_node * create_same_body_alias (tree alias, tree decl);
1260 /* Verify whole cgraph structure. */
1261 static void DEBUG_FUNCTION verify_cgraph_nodes (void);
1263 /* Verify cgraph, if consistency checking is enabled. */
1264 static inline void checking_verify_cgraph_nodes (void);
1266 /* Worker to bring NODE local. */
1267 static bool make_local (cgraph_node *node, void *);
1269 /* Mark ALIAS as an alias to DECL. DECL_NODE is cgraph node representing
1270 the function body is associated
1271 with (not necessarily cgraph_node (DECL). */
1272 static cgraph_node *create_alias (tree alias, tree target);
1274 /* Return true if NODE has thunk. */
1275 static bool has_thunk_p (cgraph_node *node, void *);
1277 cgraph_edge *callees;
1278 cgraph_edge *callers;
1279 /* List of edges representing indirect calls with a yet undetermined
1280 callee. */
1281 cgraph_edge *indirect_calls;
1282 /* For nested functions points to function the node is nested in. */
1283 cgraph_node *origin;
1284 /* Points to first nested function, if any. */
1285 cgraph_node *nested;
1286 /* Pointer to the next function with same origin, if any. */
1287 cgraph_node *next_nested;
1288 /* Pointer to the next clone. */
1289 cgraph_node *next_sibling_clone;
1290 cgraph_node *prev_sibling_clone;
1291 cgraph_node *clones;
1292 cgraph_node *clone_of;
1293 /* If instrumentation_clone is 1 then instrumented_version points
1294 to the original function used to make instrumented version.
1295 Otherwise points to instrumented version of the function. */
1296 cgraph_node *instrumented_version;
1297 /* If instrumentation_clone is 1 then orig_decl is the original
1298 function declaration. */
1299 tree orig_decl;
1300 /* For functions with many calls sites it holds map from call expression
1301 to the edge to speed up cgraph_edge function. */
1302 hash_table<cgraph_edge_hasher> *GTY(()) call_site_hash;
1303 /* Declaration node used to be clone of. */
1304 tree former_clone_of;
1306 /* If this is a SIMD clone, this points to the SIMD specific
1307 information for it. */
1308 cgraph_simd_clone *simdclone;
1309 /* If this function has SIMD clones, this points to the first clone. */
1310 cgraph_node *simd_clones;
1312 /* Interprocedural passes scheduled to have their transform functions
1313 applied next time we execute local pass on them. We maintain it
1314 per-function in order to allow IPA passes to introduce new functions. */
1315 vec<ipa_opt_pass> GTY((skip)) ipa_transforms_to_apply;
1317 cgraph_local_info local;
1318 cgraph_global_info global;
1319 struct cgraph_rtl_info *rtl;
1320 cgraph_clone_info clone;
1321 cgraph_thunk_info thunk;
1323 /* Expected number of executions: calculated in profile.c. */
1324 gcov_type count;
1325 /* How to scale counts at materialization time; used to merge
1326 LTO units with different number of profile runs. */
1327 int count_materialization_scale;
1328 /* Unique id of the node. */
1329 int uid;
1330 /* Summary unique id of the node. */
1331 int summary_uid;
1332 /* ID assigned by the profiling. */
1333 unsigned int profile_id;
1334 /* Time profiler: first run of function. */
1335 int tp_first_run;
1337 /* Set when decl is an abstract function pointed to by the
1338 ABSTRACT_DECL_ORIGIN of a reachable function. */
1339 unsigned used_as_abstract_origin : 1;
1340 /* Set once the function is lowered (i.e. its CFG is built). */
1341 unsigned lowered : 1;
1342 /* Set once the function has been instantiated and its callee
1343 lists created. */
1344 unsigned process : 1;
1345 /* How commonly executed the node is. Initialized during branch
1346 probabilities pass. */
1347 ENUM_BITFIELD (node_frequency) frequency : 2;
1348 /* True when function can only be called at startup (from static ctor). */
1349 unsigned only_called_at_startup : 1;
1350 /* True when function can only be called at startup (from static dtor). */
1351 unsigned only_called_at_exit : 1;
1352 /* True when function is the transactional clone of a function which
1353 is called only from inside transactions. */
1354 /* ?? We should be able to remove this. We have enough bits in
1355 cgraph to calculate it. */
1356 unsigned tm_clone : 1;
1357 /* True if this decl is a dispatcher for function versions. */
1358 unsigned dispatcher_function : 1;
1359 /* True if this decl calls a COMDAT-local function. This is set up in
1360 compute_inline_parameters and inline_call. */
1361 unsigned calls_comdat_local : 1;
1362 /* True if node has been created by merge operation in IPA-ICF. */
1363 unsigned icf_merged: 1;
1364 /* True when function is clone created for Pointer Bounds Checker
1365 instrumentation. */
1366 unsigned instrumentation_clone : 1;
1367 /* True if call to node can't result in a call to free, munmap or
1368 other operation that could make previously non-trapping memory
1369 accesses trapping. */
1370 unsigned nonfreeing_fn : 1;
1371 /* True if there was multiple COMDAT bodies merged by lto-symtab. */
1372 unsigned merged_comdat : 1;
1373 /* True if function was created to be executed in parallel. */
1374 unsigned parallelized_function : 1;
1375 /* True if function is part split out by ipa-split. */
1376 unsigned split_part : 1;
1377 /* True if the function appears as possible target of indirect call. */
1378 unsigned indirect_call_target : 1;
1380 private:
1381 /* Worker for call_for_symbol_and_aliases. */
1382 bool call_for_symbol_and_aliases_1 (bool (*callback) (cgraph_node *,
1383 void *),
1384 void *data, bool include_overwritable);
1387 /* A cgraph node set is a collection of cgraph nodes. A cgraph node
1388 can appear in multiple sets. */
1389 struct cgraph_node_set_def
1391 hash_map<cgraph_node *, size_t> *map;
1392 vec<cgraph_node *> nodes;
1395 typedef cgraph_node_set_def *cgraph_node_set;
1396 typedef struct varpool_node_set_def *varpool_node_set;
1398 class varpool_node;
1400 /* A varpool node set is a collection of varpool nodes. A varpool node
1401 can appear in multiple sets. */
1402 struct varpool_node_set_def
1404 hash_map<varpool_node *, size_t> * map;
1405 vec<varpool_node *> nodes;
1408 /* Iterator structure for cgraph node sets. */
1409 struct cgraph_node_set_iterator
1411 cgraph_node_set set;
1412 unsigned index;
1415 /* Iterator structure for varpool node sets. */
1416 struct varpool_node_set_iterator
1418 varpool_node_set set;
1419 unsigned index;
1422 /* Context of polymorphic call. It represent information about the type of
1423 instance that may reach the call. This is used by ipa-devirt walkers of the
1424 type inheritance graph. */
1426 class GTY(()) ipa_polymorphic_call_context {
1427 public:
1428 /* The called object appears in an object of type OUTER_TYPE
1429 at offset OFFSET. When information is not 100% reliable, we
1430 use SPECULATIVE_OUTER_TYPE and SPECULATIVE_OFFSET. */
1431 HOST_WIDE_INT offset;
1432 HOST_WIDE_INT speculative_offset;
1433 tree outer_type;
1434 tree speculative_outer_type;
1435 /* True if outer object may be in construction or destruction. */
1436 unsigned maybe_in_construction : 1;
1437 /* True if outer object may be of derived type. */
1438 unsigned maybe_derived_type : 1;
1439 /* True if speculative outer object may be of derived type. We always
1440 speculate that construction does not happen. */
1441 unsigned speculative_maybe_derived_type : 1;
1442 /* True if the context is invalid and all calls should be redirected
1443 to BUILTIN_UNREACHABLE. */
1444 unsigned invalid : 1;
1445 /* True if the outer type is dynamic. */
1446 unsigned dynamic : 1;
1448 /* Build empty "I know nothing" context. */
1449 ipa_polymorphic_call_context ();
1450 /* Build polymorphic call context for indirect call E. */
1451 ipa_polymorphic_call_context (cgraph_edge *e);
1452 /* Build polymorphic call context for IP invariant CST.
1453 If specified, OTR_TYPE specify the type of polymorphic call
1454 that takes CST+OFFSET as a prameter. */
1455 ipa_polymorphic_call_context (tree cst, tree otr_type = NULL,
1456 HOST_WIDE_INT offset = 0);
1457 /* Build context for pointer REF contained in FNDECL at statement STMT.
1458 if INSTANCE is non-NULL, return pointer to the object described by
1459 the context. */
1460 ipa_polymorphic_call_context (tree fndecl, tree ref, gimple *stmt,
1461 tree *instance = NULL);
1463 /* Look for vtable stores or constructor calls to work out dynamic type
1464 of memory location. */
1465 bool get_dynamic_type (tree, tree, tree, gimple *);
1467 /* Make context non-speculative. */
1468 void clear_speculation ();
1470 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
1471 NULL, the context is set to dummy "I know nothing" setting. */
1472 void clear_outer_type (tree otr_type = NULL);
1474 /* Walk container types and modify context to point to actual class
1475 containing OTR_TYPE (if non-NULL) as base class.
1476 Return true if resulting context is valid.
1478 When CONSIDER_PLACEMENT_NEW is false, reject contexts that may be made
1479 valid only via alocation of new polymorphic type inside by means
1480 of placement new.
1482 When CONSIDER_BASES is false, only look for actual fields, not base types
1483 of TYPE. */
1484 bool restrict_to_inner_class (tree otr_type,
1485 bool consider_placement_new = true,
1486 bool consider_bases = true);
1488 /* Adjust all offsets in contexts by given number of bits. */
1489 void offset_by (HOST_WIDE_INT);
1490 /* Use when we can not track dynamic type change. This speculatively assume
1491 type change is not happening. */
1492 void possible_dynamic_type_change (bool, tree otr_type = NULL);
1493 /* Assume that both THIS and a given context is valid and strenghten THIS
1494 if possible. Return true if any strenghtening was made.
1495 If actual type the context is being used in is known, OTR_TYPE should be
1496 set accordingly. This improves quality of combined result. */
1497 bool combine_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1498 bool meet_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1500 /* Return TRUE if context is fully useless. */
1501 bool useless_p () const;
1502 /* Return TRUE if this context conveys the same information as X. */
1503 bool equal_to (const ipa_polymorphic_call_context &x) const;
1505 /* Dump human readable context to F. If NEWLINE is true, it will be
1506 terminated by a newline. */
1507 void dump (FILE *f, bool newline = true) const;
1508 void DEBUG_FUNCTION debug () const;
1510 /* LTO streaming. */
1511 void stream_out (struct output_block *) const;
1512 void stream_in (struct lto_input_block *, struct data_in *data_in);
1514 private:
1515 bool combine_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1516 bool meet_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1517 void set_by_decl (tree, HOST_WIDE_INT);
1518 bool set_by_invariant (tree, tree, HOST_WIDE_INT);
1519 bool speculation_consistent_p (tree, HOST_WIDE_INT, bool, tree) const;
1520 void make_speculative (tree otr_type = NULL);
1523 /* Structure containing additional information about an indirect call. */
1525 struct GTY(()) cgraph_indirect_call_info
1527 /* When agg_content is set, an offset where the call pointer is located
1528 within the aggregate. */
1529 HOST_WIDE_INT offset;
1530 /* Context of the polymorphic call; use only when POLYMORPHIC flag is set. */
1531 ipa_polymorphic_call_context context;
1532 /* OBJ_TYPE_REF_TOKEN of a polymorphic call (if polymorphic is set). */
1533 HOST_WIDE_INT otr_token;
1534 /* Type of the object from OBJ_TYPE_REF_OBJECT. */
1535 tree otr_type;
1536 /* Index of the parameter that is called. */
1537 int param_index;
1538 /* ECF flags determined from the caller. */
1539 int ecf_flags;
1540 /* Profile_id of common target obtrained from profile. */
1541 int common_target_id;
1542 /* Probability that call will land in function with COMMON_TARGET_ID. */
1543 int common_target_probability;
1545 /* Set when the call is a virtual call with the parameter being the
1546 associated object pointer rather than a simple direct call. */
1547 unsigned polymorphic : 1;
1548 /* Set when the call is a call of a pointer loaded from contents of an
1549 aggregate at offset. */
1550 unsigned agg_contents : 1;
1551 /* Set when this is a call through a member pointer. */
1552 unsigned member_ptr : 1;
1553 /* When the previous bit is set, this one determines whether the destination
1554 is loaded from a parameter passed by reference. */
1555 unsigned by_ref : 1;
1556 /* For polymorphic calls this specify whether the virtual table pointer
1557 may have changed in between function entry and the call. */
1558 unsigned vptr_changed : 1;
1561 struct GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller"),
1562 for_user)) cgraph_edge {
1563 friend class cgraph_node;
1565 /* Remove the edge in the cgraph. */
1566 void remove (void);
1568 /* Change field call_stmt of edge to NEW_STMT.
1569 If UPDATE_SPECULATIVE and E is any component of speculative
1570 edge, then update all components. */
1571 void set_call_stmt (gcall *new_stmt, bool update_speculative = true);
1573 /* Redirect callee of the edge to N. The function does not update underlying
1574 call expression. */
1575 void redirect_callee (cgraph_node *n);
1577 /* If the edge does not lead to a thunk, simply redirect it to N. Otherwise
1578 create one or more equivalent thunks for N and redirect E to the first in
1579 the chain. Note that it is then necessary to call
1580 n->expand_all_artificial_thunks once all callers are redirected. */
1581 void redirect_callee_duplicating_thunks (cgraph_node *n);
1583 /* Make an indirect edge with an unknown callee an ordinary edge leading to
1584 CALLEE. DELTA is an integer constant that is to be added to the this
1585 pointer (first parameter) to compensate for skipping
1586 a thunk adjustment. */
1587 cgraph_edge *make_direct (cgraph_node *callee);
1589 /* Turn edge into speculative call calling N2. Update
1590 the profile so the direct call is taken COUNT times
1591 with FREQUENCY. */
1592 cgraph_edge *make_speculative (cgraph_node *n2, gcov_type direct_count,
1593 int direct_frequency);
1595 /* Given speculative call edge, return all three components. */
1596 void speculative_call_info (cgraph_edge *&direct, cgraph_edge *&indirect,
1597 ipa_ref *&reference);
1599 /* Speculative call edge turned out to be direct call to CALLE_DECL.
1600 Remove the speculative call sequence and return edge representing the call.
1601 It is up to caller to redirect the call as appropriate. */
1602 cgraph_edge *resolve_speculation (tree callee_decl = NULL);
1604 /* If necessary, change the function declaration in the call statement
1605 associated with the edge so that it corresponds to the edge callee. */
1606 gimple *redirect_call_stmt_to_callee (void);
1608 /* Create clone of edge in the node N represented
1609 by CALL_EXPR the callgraph. */
1610 cgraph_edge * clone (cgraph_node *n, gcall *call_stmt, unsigned stmt_uid,
1611 gcov_type count_scale, int freq_scale, bool update_original);
1613 /* Verify edge count and frequency. */
1614 bool verify_count_and_frequency ();
1616 /* Return true when call of edge can not lead to return from caller
1617 and thus it is safe to ignore its side effects for IPA analysis
1618 when computing side effects of the caller. */
1619 bool cannot_lead_to_return_p (void);
1621 /* Return true when the edge represents a direct recursion. */
1622 bool recursive_p (void);
1624 /* Return true if the call can be hot. */
1625 bool maybe_hot_p (void);
1627 /* Rebuild cgraph edges for current function node. This needs to be run after
1628 passes that don't update the cgraph. */
1629 static unsigned int rebuild_edges (void);
1631 /* Rebuild cgraph references for current function node. This needs to be run
1632 after passes that don't update the cgraph. */
1633 static void rebuild_references (void);
1635 /* Expected number of executions: calculated in profile.c. */
1636 gcov_type count;
1637 cgraph_node *caller;
1638 cgraph_node *callee;
1639 cgraph_edge *prev_caller;
1640 cgraph_edge *next_caller;
1641 cgraph_edge *prev_callee;
1642 cgraph_edge *next_callee;
1643 gcall *call_stmt;
1644 /* Additional information about an indirect call. Not cleared when an edge
1645 becomes direct. */
1646 cgraph_indirect_call_info *indirect_info;
1647 PTR GTY ((skip (""))) aux;
1648 /* When equal to CIF_OK, inline this call. Otherwise, points to the
1649 explanation why function was not inlined. */
1650 enum cgraph_inline_failed_t inline_failed;
1651 /* The stmt_uid of call_stmt. This is used by LTO to recover the call_stmt
1652 when the function is serialized in. */
1653 unsigned int lto_stmt_uid;
1654 /* Expected frequency of executions within the function.
1655 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
1656 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
1657 int frequency;
1658 /* Unique id of the edge. */
1659 int uid;
1660 /* Whether this edge was made direct by indirect inlining. */
1661 unsigned int indirect_inlining_edge : 1;
1662 /* Whether this edge describes an indirect call with an undetermined
1663 callee. */
1664 unsigned int indirect_unknown_callee : 1;
1665 /* Whether this edge is still a dangling */
1666 /* True if the corresponding CALL stmt cannot be inlined. */
1667 unsigned int call_stmt_cannot_inline_p : 1;
1668 /* Can this call throw externally? */
1669 unsigned int can_throw_external : 1;
1670 /* Edges with SPECULATIVE flag represents indirect calls that was
1671 speculatively turned into direct (i.e. by profile feedback).
1672 The final code sequence will have form:
1674 if (call_target == expected_fn)
1675 expected_fn ();
1676 else
1677 call_target ();
1679 Every speculative call is represented by three components attached
1680 to a same call statement:
1681 1) a direct call (to expected_fn)
1682 2) an indirect call (to call_target)
1683 3) a IPA_REF_ADDR refrence to expected_fn.
1685 Optimizers may later redirect direct call to clone, so 1) and 3)
1686 do not need to necesarily agree with destination. */
1687 unsigned int speculative : 1;
1688 /* Set to true when caller is a constructor or destructor of polymorphic
1689 type. */
1690 unsigned in_polymorphic_cdtor : 1;
1692 private:
1693 /* Remove the edge from the list of the callers of the callee. */
1694 void remove_caller (void);
1696 /* Remove the edge from the list of the callees of the caller. */
1697 void remove_callee (void);
1699 /* Set callee N of call graph edge and add it to the corresponding set of
1700 callers. */
1701 void set_callee (cgraph_node *n);
1703 /* Output flags of edge to a file F. */
1704 void dump_edge_flags (FILE *f);
1706 /* Verify that call graph edge corresponds to DECL from the associated
1707 statement. Return true if the verification should fail. */
1708 bool verify_corresponds_to_fndecl (tree decl);
1711 #define CGRAPH_FREQ_BASE 1000
1712 #define CGRAPH_FREQ_MAX 100000
1714 /* The varpool data structure.
1715 Each static variable decl has assigned varpool_node. */
1717 class GTY((tag ("SYMTAB_VARIABLE"))) varpool_node : public symtab_node {
1718 public:
1719 /* Dump given varpool node to F. */
1720 void dump (FILE *f);
1722 /* Dump given varpool node to stderr. */
1723 void DEBUG_FUNCTION debug (void);
1725 /* Remove variable from symbol table. */
1726 void remove (void);
1728 /* Remove node initializer when it is no longer needed. */
1729 void remove_initializer (void);
1731 void analyze (void);
1733 /* Return variable availability. */
1734 availability get_availability (void);
1736 /* When doing LTO, read variable's constructor from disk if
1737 it is not already present. */
1738 tree get_constructor (void);
1740 /* Return true if variable has constructor that can be used for folding. */
1741 bool ctor_useable_for_folding_p (void);
1743 /* For given variable pool node, walk the alias chain to return the function
1744 the variable is alias of. Do not walk through thunks.
1745 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
1746 inline varpool_node *ultimate_alias_target
1747 (availability *availability = NULL);
1749 /* Return node that alias is aliasing. */
1750 inline varpool_node *get_alias_target (void);
1752 /* Output one variable, if necessary. Return whether we output it. */
1753 bool assemble_decl (void);
1755 /* For variables in named sections make sure get_variable_section
1756 is called before we switch to those sections. Then section
1757 conflicts between read-only and read-only requiring relocations
1758 sections can be resolved. */
1759 void finalize_named_section_flags (void);
1761 /* Call calback on varpool symbol and aliases associated to varpool symbol.
1762 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1763 skipped. */
1764 bool call_for_symbol_and_aliases (bool (*callback) (varpool_node *, void *),
1765 void *data,
1766 bool include_overwritable);
1768 /* Return true when variable should be considered externally visible. */
1769 bool externally_visible_p (void);
1771 /* Return true when all references to variable must be visible
1772 in ipa_ref_list.
1773 i.e. if the variable is not externally visible or not used in some magic
1774 way (asm statement or such).
1775 The magic uses are all summarized in force_output flag. */
1776 inline bool all_refs_explicit_p ();
1778 /* Return true when variable can be removed from variable pool
1779 if all direct calls are eliminated. */
1780 inline bool can_remove_if_no_refs_p (void);
1782 /* Add the variable DECL to the varpool.
1783 Unlike finalize_decl function is intended to be used
1784 by middle end and allows insertion of new variable at arbitrary point
1785 of compilation. */
1786 static void add (tree decl);
1788 /* Return varpool node for given symbol and check it is a function. */
1789 static inline varpool_node *get (const_tree decl);
1791 /* Mark DECL as finalized. By finalizing the declaration, frontend instruct
1792 the middle end to output the variable to asm file, if needed or externally
1793 visible. */
1794 static void finalize_decl (tree decl);
1796 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1797 Extra name aliases are output whenever DECL is output. */
1798 static varpool_node * create_extra_name_alias (tree alias, tree decl);
1800 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1801 Extra name aliases are output whenever DECL is output. */
1802 static varpool_node * create_alias (tree, tree);
1804 /* Dump the variable pool to F. */
1805 static void dump_varpool (FILE *f);
1807 /* Dump the variable pool to stderr. */
1808 static void DEBUG_FUNCTION debug_varpool (void);
1810 /* Allocate new callgraph node and insert it into basic data structures. */
1811 static varpool_node *create_empty (void);
1813 /* Return varpool node assigned to DECL. Create new one when needed. */
1814 static varpool_node *get_create (tree decl);
1816 /* Given an assembler name, lookup node. */
1817 static varpool_node *get_for_asmname (tree asmname);
1819 /* Set when variable is scheduled to be assembled. */
1820 unsigned output : 1;
1822 /* Set when variable has statically initialized pointer
1823 or is a static bounds variable and needs initalization. */
1824 unsigned need_bounds_init : 1;
1826 /* Set if the variable is dynamically initialized, except for
1827 function local statics. */
1828 unsigned dynamically_initialized : 1;
1830 ENUM_BITFIELD(tls_model) tls_model : 3;
1832 /* Set if the variable is known to be used by single function only.
1833 This is computed by ipa_signle_use pass and used by late optimizations
1834 in places where optimization would be valid for local static variable
1835 if we did not do any inter-procedural code movement. */
1836 unsigned used_by_single_function : 1;
1838 private:
1839 /* Assemble thunks and aliases associated to varpool node. */
1840 void assemble_aliases (void);
1842 /* Worker for call_for_node_and_aliases. */
1843 bool call_for_symbol_and_aliases_1 (bool (*callback) (varpool_node *, void *),
1844 void *data,
1845 bool include_overwritable);
1848 /* Every top level asm statement is put into a asm_node. */
1850 struct GTY(()) asm_node {
1853 /* Next asm node. */
1854 asm_node *next;
1855 /* String for this asm node. */
1856 tree asm_str;
1857 /* Ordering of all cgraph nodes. */
1858 int order;
1861 /* Report whether or not THIS symtab node is a function, aka cgraph_node. */
1863 template <>
1864 template <>
1865 inline bool
1866 is_a_helper <cgraph_node *>::test (symtab_node *p)
1868 return p && p->type == SYMTAB_FUNCTION;
1871 /* Report whether or not THIS symtab node is a vriable, aka varpool_node. */
1873 template <>
1874 template <>
1875 inline bool
1876 is_a_helper <varpool_node *>::test (symtab_node *p)
1878 return p && p->type == SYMTAB_VARIABLE;
1881 /* Macros to access the next item in the list of free cgraph nodes and
1882 edges. */
1883 #define NEXT_FREE_NODE(NODE) dyn_cast<cgraph_node *> ((NODE)->next)
1884 #define SET_NEXT_FREE_NODE(NODE,NODE2) ((NODE))->next = NODE2
1885 #define NEXT_FREE_EDGE(EDGE) (EDGE)->prev_caller
1887 typedef void (*cgraph_edge_hook)(cgraph_edge *, void *);
1888 typedef void (*cgraph_node_hook)(cgraph_node *, void *);
1889 typedef void (*varpool_node_hook)(varpool_node *, void *);
1890 typedef void (*cgraph_2edge_hook)(cgraph_edge *, cgraph_edge *, void *);
1891 typedef void (*cgraph_2node_hook)(cgraph_node *, cgraph_node *, void *);
1893 struct cgraph_edge_hook_list;
1894 struct cgraph_node_hook_list;
1895 struct varpool_node_hook_list;
1896 struct cgraph_2edge_hook_list;
1897 struct cgraph_2node_hook_list;
1899 /* Map from a symbol to initialization/finalization priorities. */
1900 struct GTY(()) symbol_priority_map {
1901 priority_type init;
1902 priority_type fini;
1905 enum symtab_state
1907 /* Frontend is parsing and finalizing functions. */
1908 PARSING,
1909 /* Callgraph is being constructed. It is safe to add new functions. */
1910 CONSTRUCTION,
1911 /* Callgraph is being streamed-in at LTO time. */
1912 LTO_STREAMING,
1913 /* Callgraph is built and early IPA passes are being run. */
1914 IPA,
1915 /* Callgraph is built and all functions are transformed to SSA form. */
1916 IPA_SSA,
1917 /* All inline decisions are done; it is now possible to remove extern inline
1918 functions and virtual call targets. */
1919 IPA_SSA_AFTER_INLINING,
1920 /* Functions are now ordered and being passed to RTL expanders. */
1921 EXPANSION,
1922 /* All cgraph expansion is done. */
1923 FINISHED
1926 struct asmname_hasher : ggc_ptr_hash <symtab_node>
1928 typedef const_tree compare_type;
1930 static hashval_t hash (symtab_node *n);
1931 static bool equal (symtab_node *n, const_tree t);
1934 class GTY((tag ("SYMTAB"))) symbol_table
1936 public:
1937 friend class symtab_node;
1938 friend class cgraph_node;
1939 friend class cgraph_edge;
1941 symbol_table (): cgraph_max_summary_uid (1)
1945 /* Initialize callgraph dump file. */
1946 void initialize (void);
1948 /* Register a top-level asm statement ASM_STR. */
1949 inline asm_node *finalize_toplevel_asm (tree asm_str);
1951 /* Analyze the whole compilation unit once it is parsed completely. */
1952 void finalize_compilation_unit (void);
1954 /* C++ frontend produce same body aliases all over the place, even before PCH
1955 gets streamed out. It relies on us linking the aliases with their function
1956 in order to do the fixups, but ipa-ref is not PCH safe. Consequentely we
1957 first produce aliases without links, but once C++ FE is sure he won't sream
1958 PCH we build the links via this function. */
1959 void process_same_body_aliases (void);
1961 /* Perform simple optimizations based on callgraph. */
1962 void compile (void);
1964 /* Process CGRAPH_NEW_FUNCTIONS and perform actions necessary to add these
1965 functions into callgraph in a way so they look like ordinary reachable
1966 functions inserted into callgraph already at construction time. */
1967 void process_new_functions (void);
1969 /* Once all functions from compilation unit are in memory, produce all clones
1970 and update all calls. We might also do this on demand if we don't want to
1971 bring all functions to memory prior compilation, but current WHOPR
1972 implementation does that and it is bit easier to keep everything right
1973 in this order. */
1974 void materialize_all_clones (void);
1976 /* Register a symbol NODE. */
1977 inline void register_symbol (symtab_node *node);
1979 inline void
1980 clear_asm_symbols (void)
1982 asmnodes = NULL;
1983 asm_last_node = NULL;
1986 /* Perform reachability analysis and reclaim all unreachable nodes. */
1987 bool remove_unreachable_nodes (FILE *file);
1989 /* Optimization of function bodies might've rendered some variables as
1990 unnecessary so we want to avoid these from being compiled. Re-do
1991 reachability starting from variables that are either externally visible
1992 or was referred from the asm output routines. */
1993 void remove_unreferenced_decls (void);
1995 /* Unregister a symbol NODE. */
1996 inline void unregister (symtab_node *node);
1998 /* Allocate new callgraph node and insert it into basic data structures. */
1999 cgraph_node *create_empty (void);
2001 /* Release a callgraph NODE with UID and put in to the list
2002 of free nodes. */
2003 void release_symbol (cgraph_node *node, int uid);
2005 /* Output all variables enqueued to be assembled. */
2006 bool output_variables (void);
2008 /* Weakrefs may be associated to external decls and thus not output
2009 at expansion time. Emit all necessary aliases. */
2010 void output_weakrefs (void);
2012 /* Return first static symbol with definition. */
2013 inline symtab_node *first_symbol (void);
2015 /* Return first assembler symbol. */
2016 inline asm_node *
2017 first_asm_symbol (void)
2019 return asmnodes;
2022 /* Return first static symbol with definition. */
2023 inline symtab_node *first_defined_symbol (void);
2025 /* Return first variable. */
2026 inline varpool_node *first_variable (void);
2028 /* Return next variable after NODE. */
2029 inline varpool_node *next_variable (varpool_node *node);
2031 /* Return first static variable with initializer. */
2032 inline varpool_node *first_static_initializer (void);
2034 /* Return next static variable with initializer after NODE. */
2035 inline varpool_node *next_static_initializer (varpool_node *node);
2037 /* Return first static variable with definition. */
2038 inline varpool_node *first_defined_variable (void);
2040 /* Return next static variable with definition after NODE. */
2041 inline varpool_node *next_defined_variable (varpool_node *node);
2043 /* Return first function with body defined. */
2044 inline cgraph_node *first_defined_function (void);
2046 /* Return next function with body defined after NODE. */
2047 inline cgraph_node *next_defined_function (cgraph_node *node);
2049 /* Return first function. */
2050 inline cgraph_node *first_function (void);
2052 /* Return next function. */
2053 inline cgraph_node *next_function (cgraph_node *node);
2055 /* Return first function with body defined. */
2056 cgraph_node *first_function_with_gimple_body (void);
2058 /* Return next reachable static variable with initializer after NODE. */
2059 inline cgraph_node *next_function_with_gimple_body (cgraph_node *node);
2061 /* Register HOOK to be called with DATA on each removed edge. */
2062 cgraph_edge_hook_list *add_edge_removal_hook (cgraph_edge_hook hook,
2063 void *data);
2065 /* Remove ENTRY from the list of hooks called on removing edges. */
2066 void remove_edge_removal_hook (cgraph_edge_hook_list *entry);
2068 /* Register HOOK to be called with DATA on each removed node. */
2069 cgraph_node_hook_list *add_cgraph_removal_hook (cgraph_node_hook hook,
2070 void *data);
2072 /* Remove ENTRY from the list of hooks called on removing nodes. */
2073 void remove_cgraph_removal_hook (cgraph_node_hook_list *entry);
2075 /* Register HOOK to be called with DATA on each removed node. */
2076 varpool_node_hook_list *add_varpool_removal_hook (varpool_node_hook hook,
2077 void *data);
2079 /* Remove ENTRY from the list of hooks called on removing nodes. */
2080 void remove_varpool_removal_hook (varpool_node_hook_list *entry);
2082 /* Register HOOK to be called with DATA on each inserted node. */
2083 cgraph_node_hook_list *add_cgraph_insertion_hook (cgraph_node_hook hook,
2084 void *data);
2086 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2087 void remove_cgraph_insertion_hook (cgraph_node_hook_list *entry);
2089 /* Register HOOK to be called with DATA on each inserted node. */
2090 varpool_node_hook_list *add_varpool_insertion_hook (varpool_node_hook hook,
2091 void *data);
2093 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2094 void remove_varpool_insertion_hook (varpool_node_hook_list *entry);
2096 /* Register HOOK to be called with DATA on each duplicated edge. */
2097 cgraph_2edge_hook_list *add_edge_duplication_hook (cgraph_2edge_hook hook,
2098 void *data);
2099 /* Remove ENTRY from the list of hooks called on duplicating edges. */
2100 void remove_edge_duplication_hook (cgraph_2edge_hook_list *entry);
2102 /* Register HOOK to be called with DATA on each duplicated node. */
2103 cgraph_2node_hook_list *add_cgraph_duplication_hook (cgraph_2node_hook hook,
2104 void *data);
2106 /* Remove ENTRY from the list of hooks called on duplicating nodes. */
2107 void remove_cgraph_duplication_hook (cgraph_2node_hook_list *entry);
2109 /* Call all edge removal hooks. */
2110 void call_edge_removal_hooks (cgraph_edge *e);
2112 /* Call all node insertion hooks. */
2113 void call_cgraph_insertion_hooks (cgraph_node *node);
2115 /* Call all node removal hooks. */
2116 void call_cgraph_removal_hooks (cgraph_node *node);
2118 /* Call all node duplication hooks. */
2119 void call_cgraph_duplication_hooks (cgraph_node *node, cgraph_node *node2);
2121 /* Call all edge duplication hooks. */
2122 void call_edge_duplication_hooks (cgraph_edge *cs1, cgraph_edge *cs2);
2124 /* Call all node removal hooks. */
2125 void call_varpool_removal_hooks (varpool_node *node);
2127 /* Call all node insertion hooks. */
2128 void call_varpool_insertion_hooks (varpool_node *node);
2130 /* Arrange node to be first in its entry of assembler_name_hash. */
2131 void symtab_prevail_in_asm_name_hash (symtab_node *node);
2133 /* Initalize asm name hash unless. */
2134 void symtab_initialize_asm_name_hash (void);
2136 /* Set the DECL_ASSEMBLER_NAME and update symtab hashtables. */
2137 void change_decl_assembler_name (tree decl, tree name);
2139 /* Return true if assembler names NAME1 and NAME2 leads to the same symbol
2140 name. */
2141 static bool assembler_names_equal_p (const char *name1, const char *name2);
2143 int cgraph_count;
2144 int cgraph_max_uid;
2145 int cgraph_max_summary_uid;
2147 int edges_count;
2148 int edges_max_uid;
2150 symtab_node* GTY(()) nodes;
2151 asm_node* GTY(()) asmnodes;
2152 asm_node* GTY(()) asm_last_node;
2153 cgraph_node* GTY(()) free_nodes;
2155 /* Head of a linked list of unused (freed) call graph edges.
2156 Do not GTY((delete)) this list so UIDs gets reliably recycled. */
2157 cgraph_edge * GTY(()) free_edges;
2159 /* The order index of the next symtab node to be created. This is
2160 used so that we can sort the cgraph nodes in order by when we saw
2161 them, to support -fno-toplevel-reorder. */
2162 int order;
2164 /* Set when whole unit has been analyzed so we can access global info. */
2165 bool global_info_ready;
2166 /* What state callgraph is in right now. */
2167 enum symtab_state state;
2168 /* Set when the cgraph is fully build and the basic flags are computed. */
2169 bool function_flags_ready;
2171 bool cpp_implicit_aliases_done;
2173 /* Hash table used to hold sectoons. */
2174 hash_table<section_name_hasher> *GTY(()) section_hash;
2176 /* Hash table used to convert assembler names into nodes. */
2177 hash_table<asmname_hasher> *assembler_name_hash;
2179 /* Hash table used to hold init priorities. */
2180 hash_map<symtab_node *, symbol_priority_map> *init_priority_hash;
2182 FILE* GTY ((skip)) dump_file;
2184 /* Return symbol used to separate symbol name from suffix. */
2185 static char symbol_suffix_separator ();
2187 private:
2188 /* Allocate new callgraph node. */
2189 inline cgraph_node * allocate_cgraph_symbol (void);
2191 /* Allocate a cgraph_edge structure and fill it with data according to the
2192 parameters of which only CALLEE can be NULL (when creating an indirect call
2193 edge). */
2194 cgraph_edge *create_edge (cgraph_node *caller, cgraph_node *callee,
2195 gcall *call_stmt, gcov_type count, int freq,
2196 bool indir_unknown_callee);
2198 /* Put the edge onto the free list. */
2199 void free_edge (cgraph_edge *e);
2201 /* Insert NODE to assembler name hash. */
2202 void insert_to_assembler_name_hash (symtab_node *node, bool with_clones);
2204 /* Remove NODE from assembler name hash. */
2205 void unlink_from_assembler_name_hash (symtab_node *node, bool with_clones);
2207 /* Hash asmnames ignoring the user specified marks. */
2208 static hashval_t decl_assembler_name_hash (const_tree asmname);
2210 /* Compare ASMNAME with the DECL_ASSEMBLER_NAME of DECL. */
2211 static bool decl_assembler_name_equal (tree decl, const_tree asmname);
2213 friend struct asmname_hasher;
2215 /* List of hooks triggered when an edge is removed. */
2216 cgraph_edge_hook_list * GTY((skip)) m_first_edge_removal_hook;
2217 /* List of hooks triggem_red when a cgraph node is removed. */
2218 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_removal_hook;
2219 /* List of hooks triggered when an edge is duplicated. */
2220 cgraph_2edge_hook_list * GTY((skip)) m_first_edge_duplicated_hook;
2221 /* List of hooks triggered when a node is duplicated. */
2222 cgraph_2node_hook_list * GTY((skip)) m_first_cgraph_duplicated_hook;
2223 /* List of hooks triggered when an function is inserted. */
2224 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_insertion_hook;
2225 /* List of hooks triggered when an variable is inserted. */
2226 varpool_node_hook_list * GTY((skip)) m_first_varpool_insertion_hook;
2227 /* List of hooks triggered when a node is removed. */
2228 varpool_node_hook_list * GTY((skip)) m_first_varpool_removal_hook;
2231 extern GTY(()) symbol_table *symtab;
2233 extern vec<cgraph_node *> cgraph_new_nodes;
2235 inline hashval_t
2236 asmname_hasher::hash (symtab_node *n)
2238 return symbol_table::decl_assembler_name_hash
2239 (DECL_ASSEMBLER_NAME (n->decl));
2242 inline bool
2243 asmname_hasher::equal (symtab_node *n, const_tree t)
2245 return symbol_table::decl_assembler_name_equal (n->decl, t);
2248 /* In cgraph.c */
2249 void cgraph_c_finalize (void);
2250 void release_function_body (tree);
2251 cgraph_indirect_call_info *cgraph_allocate_init_indirect_info (void);
2253 void cgraph_update_edges_for_call_stmt (gimple *, tree, gimple *);
2254 bool cgraph_function_possibly_inlined_p (tree);
2256 const char* cgraph_inline_failed_string (cgraph_inline_failed_t);
2257 cgraph_inline_failed_type_t cgraph_inline_failed_type (cgraph_inline_failed_t);
2259 extern bool gimple_check_call_matching_types (gimple *, tree, bool);
2261 /* In cgraphunit.c */
2262 void cgraphunit_c_finalize (void);
2264 /* Initialize datastructures so DECL is a function in lowered gimple form.
2265 IN_SSA is true if the gimple is in SSA. */
2266 basic_block init_lowered_empty_function (tree, bool, gcov_type);
2268 /* In cgraphclones.c */
2270 tree clone_function_name_1 (const char *, const char *);
2271 tree clone_function_name (tree decl, const char *);
2273 void tree_function_versioning (tree, tree, vec<ipa_replace_map *, va_gc> *,
2274 bool, bitmap, bool, bitmap, basic_block);
2276 /* In cgraphbuild.c */
2277 int compute_call_stmt_bb_frequency (tree, basic_block bb);
2278 void record_references_in_initializer (tree, bool);
2280 /* In ipa.c */
2281 void cgraph_build_static_cdtor (char which, tree body, int priority);
2282 bool ipa_discover_readonly_nonaddressable_vars (void);
2284 /* In varpool.c */
2285 tree ctor_for_folding (tree);
2287 /* In tree-chkp.c */
2288 extern bool chkp_function_instrumented_p (tree fndecl);
2290 /* Return true when the symbol is real symbol, i.e. it is not inline clone
2291 or abstract function kept for debug info purposes only. */
2292 inline bool
2293 symtab_node::real_symbol_p (void)
2295 cgraph_node *cnode;
2297 if (DECL_ABSTRACT_P (decl))
2298 return false;
2299 if (transparent_alias && definition)
2300 return false;
2301 if (!is_a <cgraph_node *> (this))
2302 return true;
2303 cnode = dyn_cast <cgraph_node *> (this);
2304 if (cnode->global.inlined_to)
2305 return false;
2306 return true;
2309 /* Return true if DECL should have entry in symbol table if used.
2310 Those are functions and static & external veriables*/
2312 static inline bool
2313 decl_in_symtab_p (const_tree decl)
2315 return (TREE_CODE (decl) == FUNCTION_DECL
2316 || (TREE_CODE (decl) == VAR_DECL
2317 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl))));
2320 inline bool
2321 symtab_node::in_same_comdat_group_p (symtab_node *target)
2323 symtab_node *source = this;
2325 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2327 if (cn->global.inlined_to)
2328 source = cn->global.inlined_to;
2330 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2332 if (cn->global.inlined_to)
2333 target = cn->global.inlined_to;
2336 return source->get_comdat_group () == target->get_comdat_group ();
2339 /* Return node that alias is aliasing. */
2341 inline symtab_node *
2342 symtab_node::get_alias_target (void)
2344 ipa_ref *ref = NULL;
2345 iterate_reference (0, ref);
2346 if (ref->use == IPA_REF_CHKP)
2347 iterate_reference (1, ref);
2348 gcc_checking_assert (ref->use == IPA_REF_ALIAS);
2349 return ref->referred;
2352 /* Return next reachable static symbol with initializer after the node. */
2354 inline symtab_node *
2355 symtab_node::next_defined_symbol (void)
2357 symtab_node *node1 = next;
2359 for (; node1; node1 = node1->next)
2360 if (node1->definition)
2361 return node1;
2363 return NULL;
2366 /* Iterates I-th reference in the list, REF is also set. */
2368 inline ipa_ref *
2369 symtab_node::iterate_reference (unsigned i, ipa_ref *&ref)
2371 vec_safe_iterate (ref_list.references, i, &ref);
2373 return ref;
2376 /* Iterates I-th referring item in the list, REF is also set. */
2378 inline ipa_ref *
2379 symtab_node::iterate_referring (unsigned i, ipa_ref *&ref)
2381 ref_list.referring.iterate (i, &ref);
2383 return ref;
2386 /* Iterates I-th referring alias item in the list, REF is also set. */
2388 inline ipa_ref *
2389 symtab_node::iterate_direct_aliases (unsigned i, ipa_ref *&ref)
2391 ref_list.referring.iterate (i, &ref);
2393 if (ref && ref->use != IPA_REF_ALIAS)
2394 return NULL;
2396 return ref;
2399 /* Return true if list contains an alias. */
2401 inline bool
2402 symtab_node::has_aliases_p (void)
2404 ipa_ref *ref = NULL;
2406 return (iterate_direct_aliases (0, ref) != NULL);
2409 /* Return true when RESOLUTION indicate that linker will use
2410 the symbol from non-LTO object files. */
2412 inline bool
2413 resolution_used_from_other_file_p (enum ld_plugin_symbol_resolution resolution)
2415 return (resolution == LDPR_PREVAILING_DEF
2416 || resolution == LDPR_PREEMPTED_REG
2417 || resolution == LDPR_RESOLVED_EXEC
2418 || resolution == LDPR_RESOLVED_DYN);
2421 /* Return true when symtab_node is known to be used from other (non-LTO)
2422 object file. Known only when doing LTO via linker plugin. */
2424 inline bool
2425 symtab_node::used_from_object_file_p (void)
2427 if (!TREE_PUBLIC (decl) || DECL_EXTERNAL (decl))
2428 return false;
2429 if (resolution_used_from_other_file_p (resolution))
2430 return true;
2431 return false;
2434 /* Return varpool node for given symbol and check it is a function. */
2436 inline varpool_node *
2437 varpool_node::get (const_tree decl)
2439 gcc_checking_assert (TREE_CODE (decl) == VAR_DECL);
2440 return dyn_cast<varpool_node *> (symtab_node::get (decl));
2443 /* Register a symbol NODE. */
2445 inline void
2446 symbol_table::register_symbol (symtab_node *node)
2448 node->next = nodes;
2449 node->previous = NULL;
2451 if (nodes)
2452 nodes->previous = node;
2453 nodes = node;
2455 node->order = order++;
2458 /* Register a top-level asm statement ASM_STR. */
2460 asm_node *
2461 symbol_table::finalize_toplevel_asm (tree asm_str)
2463 asm_node *node;
2465 node = ggc_cleared_alloc<asm_node> ();
2466 node->asm_str = asm_str;
2467 node->order = order++;
2468 node->next = NULL;
2470 if (asmnodes == NULL)
2471 asmnodes = node;
2472 else
2473 asm_last_node->next = node;
2475 asm_last_node = node;
2476 return node;
2479 /* Unregister a symbol NODE. */
2480 inline void
2481 symbol_table::unregister (symtab_node *node)
2483 if (node->previous)
2484 node->previous->next = node->next;
2485 else
2486 nodes = node->next;
2488 if (node->next)
2489 node->next->previous = node->previous;
2491 node->next = NULL;
2492 node->previous = NULL;
2495 /* Release a callgraph NODE with UID and put in to the list of free nodes. */
2497 inline void
2498 symbol_table::release_symbol (cgraph_node *node, int uid)
2500 cgraph_count--;
2502 /* Clear out the node to NULL all pointers and add the node to the free
2503 list. */
2504 memset (node, 0, sizeof (*node));
2505 node->type = SYMTAB_FUNCTION;
2506 node->uid = uid;
2507 SET_NEXT_FREE_NODE (node, free_nodes);
2508 free_nodes = node;
2511 /* Allocate new callgraph node. */
2513 inline cgraph_node *
2514 symbol_table::allocate_cgraph_symbol (void)
2516 cgraph_node *node;
2518 if (free_nodes)
2520 node = free_nodes;
2521 free_nodes = NEXT_FREE_NODE (node);
2523 else
2525 node = ggc_cleared_alloc<cgraph_node> ();
2526 node->uid = cgraph_max_uid++;
2529 node->summary_uid = cgraph_max_summary_uid++;
2530 return node;
2534 /* Return first static symbol with definition. */
2535 inline symtab_node *
2536 symbol_table::first_symbol (void)
2538 return nodes;
2541 /* Walk all symbols. */
2542 #define FOR_EACH_SYMBOL(node) \
2543 for ((node) = symtab->first_symbol (); (node); (node) = (node)->next)
2545 /* Return first static symbol with definition. */
2546 inline symtab_node *
2547 symbol_table::first_defined_symbol (void)
2549 symtab_node *node;
2551 for (node = nodes; node; node = node->next)
2552 if (node->definition)
2553 return node;
2555 return NULL;
2558 /* Walk all symbols with definitions in current unit. */
2559 #define FOR_EACH_DEFINED_SYMBOL(node) \
2560 for ((node) = symtab->first_defined_symbol (); (node); \
2561 (node) = node->next_defined_symbol ())
2563 /* Return first variable. */
2564 inline varpool_node *
2565 symbol_table::first_variable (void)
2567 symtab_node *node;
2568 for (node = nodes; node; node = node->next)
2569 if (varpool_node *vnode = dyn_cast <varpool_node *> (node))
2570 return vnode;
2571 return NULL;
2574 /* Return next variable after NODE. */
2575 inline varpool_node *
2576 symbol_table::next_variable (varpool_node *node)
2578 symtab_node *node1 = node->next;
2579 for (; node1; node1 = node1->next)
2580 if (varpool_node *vnode1 = dyn_cast <varpool_node *> (node1))
2581 return vnode1;
2582 return NULL;
2584 /* Walk all variables. */
2585 #define FOR_EACH_VARIABLE(node) \
2586 for ((node) = symtab->first_variable (); \
2587 (node); \
2588 (node) = symtab->next_variable ((node)))
2590 /* Return first static variable with initializer. */
2591 inline varpool_node *
2592 symbol_table::first_static_initializer (void)
2594 symtab_node *node;
2595 for (node = nodes; node; node = node->next)
2597 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2598 if (vnode && DECL_INITIAL (node->decl))
2599 return vnode;
2601 return NULL;
2604 /* Return next static variable with initializer after NODE. */
2605 inline varpool_node *
2606 symbol_table::next_static_initializer (varpool_node *node)
2608 symtab_node *node1 = node->next;
2609 for (; node1; node1 = node1->next)
2611 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2612 if (vnode1 && DECL_INITIAL (node1->decl))
2613 return vnode1;
2615 return NULL;
2618 /* Walk all static variables with initializer set. */
2619 #define FOR_EACH_STATIC_INITIALIZER(node) \
2620 for ((node) = symtab->first_static_initializer (); (node); \
2621 (node) = symtab->next_static_initializer (node))
2623 /* Return first static variable with definition. */
2624 inline varpool_node *
2625 symbol_table::first_defined_variable (void)
2627 symtab_node *node;
2628 for (node = nodes; node; node = node->next)
2630 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2631 if (vnode && vnode->definition)
2632 return vnode;
2634 return NULL;
2637 /* Return next static variable with definition after NODE. */
2638 inline varpool_node *
2639 symbol_table::next_defined_variable (varpool_node *node)
2641 symtab_node *node1 = node->next;
2642 for (; node1; node1 = node1->next)
2644 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2645 if (vnode1 && vnode1->definition)
2646 return vnode1;
2648 return NULL;
2650 /* Walk all variables with definitions in current unit. */
2651 #define FOR_EACH_DEFINED_VARIABLE(node) \
2652 for ((node) = symtab->first_defined_variable (); (node); \
2653 (node) = symtab->next_defined_variable (node))
2655 /* Return first function with body defined. */
2656 inline cgraph_node *
2657 symbol_table::first_defined_function (void)
2659 symtab_node *node;
2660 for (node = nodes; node; node = node->next)
2662 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2663 if (cn && cn->definition)
2664 return cn;
2666 return NULL;
2669 /* Return next function with body defined after NODE. */
2670 inline cgraph_node *
2671 symbol_table::next_defined_function (cgraph_node *node)
2673 symtab_node *node1 = node->next;
2674 for (; node1; node1 = node1->next)
2676 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2677 if (cn1 && cn1->definition)
2678 return cn1;
2680 return NULL;
2683 /* Walk all functions with body defined. */
2684 #define FOR_EACH_DEFINED_FUNCTION(node) \
2685 for ((node) = symtab->first_defined_function (); (node); \
2686 (node) = symtab->next_defined_function ((node)))
2688 /* Return first function. */
2689 inline cgraph_node *
2690 symbol_table::first_function (void)
2692 symtab_node *node;
2693 for (node = nodes; node; node = node->next)
2694 if (cgraph_node *cn = dyn_cast <cgraph_node *> (node))
2695 return cn;
2696 return NULL;
2699 /* Return next function. */
2700 inline cgraph_node *
2701 symbol_table::next_function (cgraph_node *node)
2703 symtab_node *node1 = node->next;
2704 for (; node1; node1 = node1->next)
2705 if (cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1))
2706 return cn1;
2707 return NULL;
2710 /* Return first function with body defined. */
2711 inline cgraph_node *
2712 symbol_table::first_function_with_gimple_body (void)
2714 symtab_node *node;
2715 for (node = nodes; node; node = node->next)
2717 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2718 if (cn && cn->has_gimple_body_p ())
2719 return cn;
2721 return NULL;
2724 /* Return next reachable static variable with initializer after NODE. */
2725 inline cgraph_node *
2726 symbol_table::next_function_with_gimple_body (cgraph_node *node)
2728 symtab_node *node1 = node->next;
2729 for (; node1; node1 = node1->next)
2731 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2732 if (cn1 && cn1->has_gimple_body_p ())
2733 return cn1;
2735 return NULL;
2738 /* Walk all functions. */
2739 #define FOR_EACH_FUNCTION(node) \
2740 for ((node) = symtab->first_function (); (node); \
2741 (node) = symtab->next_function ((node)))
2743 /* Return true when callgraph node is a function with Gimple body defined
2744 in current unit. Functions can also be define externally or they
2745 can be thunks with no Gimple representation.
2747 Note that at WPA stage, the function body may not be present in memory. */
2749 inline bool
2750 cgraph_node::has_gimple_body_p (void)
2752 return definition && !thunk.thunk_p && !alias;
2755 /* Walk all functions with body defined. */
2756 #define FOR_EACH_FUNCTION_WITH_GIMPLE_BODY(node) \
2757 for ((node) = symtab->first_function_with_gimple_body (); (node); \
2758 (node) = symtab->next_function_with_gimple_body (node))
2760 /* Uniquize all constants that appear in memory.
2761 Each constant in memory thus far output is recorded
2762 in `const_desc_table'. */
2764 struct GTY((for_user)) constant_descriptor_tree {
2765 /* A MEM for the constant. */
2766 rtx rtl;
2768 /* The value of the constant. */
2769 tree value;
2771 /* Hash of value. Computing the hash from value each time
2772 hashfn is called can't work properly, as that means recursive
2773 use of the hash table during hash table expansion. */
2774 hashval_t hash;
2777 /* Return true when function is only called directly or it has alias.
2778 i.e. it is not externally visible, address was not taken and
2779 it is not used in any other non-standard way. */
2781 inline bool
2782 cgraph_node::only_called_directly_or_aliased_p (void)
2784 gcc_assert (!global.inlined_to);
2785 return (!force_output && !address_taken
2786 && !used_from_other_partition
2787 && !DECL_VIRTUAL_P (decl)
2788 && !DECL_STATIC_CONSTRUCTOR (decl)
2789 && !DECL_STATIC_DESTRUCTOR (decl)
2790 && !used_from_object_file_p ()
2791 && !externally_visible);
2794 /* Return true when function can be removed from callgraph
2795 if all direct calls are eliminated. */
2797 inline bool
2798 cgraph_node::can_remove_if_no_direct_calls_and_refs_p (void)
2800 gcc_checking_assert (!global.inlined_to);
2801 /* Instrumentation clones should not be removed before
2802 instrumentation happens. New callers may appear after
2803 instrumentation. */
2804 if (instrumentation_clone
2805 && !chkp_function_instrumented_p (decl))
2806 return false;
2807 /* Extern inlines can always go, we will use the external definition. */
2808 if (DECL_EXTERNAL (decl))
2809 return true;
2810 /* When function is needed, we can not remove it. */
2811 if (force_output || used_from_other_partition)
2812 return false;
2813 if (DECL_STATIC_CONSTRUCTOR (decl)
2814 || DECL_STATIC_DESTRUCTOR (decl))
2815 return false;
2816 /* Only COMDAT functions can be removed if externally visible. */
2817 if (externally_visible
2818 && (!DECL_COMDAT (decl)
2819 || forced_by_abi
2820 || used_from_object_file_p ()))
2821 return false;
2822 return true;
2825 /* Verify cgraph, if consistency checking is enabled. */
2827 inline void
2828 cgraph_node::checking_verify_cgraph_nodes (void)
2830 if (flag_checking)
2831 cgraph_node::verify_cgraph_nodes ();
2834 /* Return true when variable can be removed from variable pool
2835 if all direct calls are eliminated. */
2837 inline bool
2838 varpool_node::can_remove_if_no_refs_p (void)
2840 if (DECL_EXTERNAL (decl))
2841 return true;
2842 return (!force_output && !used_from_other_partition
2843 && ((DECL_COMDAT (decl)
2844 && !forced_by_abi
2845 && !used_from_object_file_p ())
2846 || !externally_visible
2847 || DECL_HAS_VALUE_EXPR_P (decl)));
2850 /* Return true when all references to variable must be visible in ipa_ref_list.
2851 i.e. if the variable is not externally visible or not used in some magic
2852 way (asm statement or such).
2853 The magic uses are all summarized in force_output flag. */
2855 inline bool
2856 varpool_node::all_refs_explicit_p ()
2858 return (definition
2859 && !externally_visible
2860 && !used_from_other_partition
2861 && !force_output);
2864 struct tree_descriptor_hasher : ggc_ptr_hash<constant_descriptor_tree>
2866 static hashval_t hash (constant_descriptor_tree *);
2867 static bool equal (constant_descriptor_tree *, constant_descriptor_tree *);
2870 /* Constant pool accessor function. */
2871 hash_table<tree_descriptor_hasher> *constant_pool_htab (void);
2873 /* Return node that alias is aliasing. */
2875 inline cgraph_node *
2876 cgraph_node::get_alias_target (void)
2878 return dyn_cast <cgraph_node *> (symtab_node::get_alias_target ());
2881 /* Return node that alias is aliasing. */
2883 inline varpool_node *
2884 varpool_node::get_alias_target (void)
2886 return dyn_cast <varpool_node *> (symtab_node::get_alias_target ());
2889 /* Walk the alias chain to return the symbol NODE is alias of.
2890 If NODE is not an alias, return NODE.
2891 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2893 inline symtab_node *
2894 symtab_node::ultimate_alias_target (enum availability *availability)
2896 if (!alias)
2898 if (availability)
2899 *availability = get_availability ();
2900 return this;
2903 return ultimate_alias_target_1 (availability);
2906 /* Given function symbol, walk the alias chain to return the function node
2907 is alias of. Do not walk through thunks.
2908 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2910 inline cgraph_node *
2911 cgraph_node::ultimate_alias_target (enum availability *availability)
2913 cgraph_node *n = dyn_cast <cgraph_node *>
2914 (symtab_node::ultimate_alias_target (availability));
2915 if (!n && availability)
2916 *availability = AVAIL_NOT_AVAILABLE;
2917 return n;
2920 /* For given variable pool node, walk the alias chain to return the function
2921 the variable is alias of. Do not walk through thunks.
2922 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2924 inline varpool_node *
2925 varpool_node::ultimate_alias_target (availability *availability)
2927 varpool_node *n = dyn_cast <varpool_node *>
2928 (symtab_node::ultimate_alias_target (availability));
2930 if (!n && availability)
2931 *availability = AVAIL_NOT_AVAILABLE;
2932 return n;
2935 /* Set callee N of call graph edge and add it to the corresponding set of
2936 callers. */
2938 inline void
2939 cgraph_edge::set_callee (cgraph_node *n)
2941 prev_caller = NULL;
2942 if (n->callers)
2943 n->callers->prev_caller = this;
2944 next_caller = n->callers;
2945 n->callers = this;
2946 callee = n;
2949 /* Redirect callee of the edge to N. The function does not update underlying
2950 call expression. */
2952 inline void
2953 cgraph_edge::redirect_callee (cgraph_node *n)
2955 /* Remove from callers list of the current callee. */
2956 remove_callee ();
2958 /* Insert to callers list of the new callee. */
2959 set_callee (n);
2962 /* Return true when the edge represents a direct recursion. */
2964 inline bool
2965 cgraph_edge::recursive_p (void)
2967 cgraph_node *c = callee->ultimate_alias_target ();
2968 if (caller->global.inlined_to)
2969 return caller->global.inlined_to->decl == c->decl;
2970 else
2971 return caller->decl == c->decl;
2974 /* Remove the edge from the list of the callers of the callee. */
2976 inline void
2977 cgraph_edge::remove_callee (void)
2979 gcc_assert (!indirect_unknown_callee);
2980 if (prev_caller)
2981 prev_caller->next_caller = next_caller;
2982 if (next_caller)
2983 next_caller->prev_caller = prev_caller;
2984 if (!prev_caller)
2985 callee->callers = next_caller;
2988 /* Return true if the TM_CLONE bit is set for a given FNDECL. */
2989 static inline bool
2990 decl_is_tm_clone (const_tree fndecl)
2992 cgraph_node *n = cgraph_node::get (fndecl);
2993 if (n)
2994 return n->tm_clone;
2995 return false;
2998 /* Likewise indicate that a node is needed, i.e. reachable via some
2999 external means. */
3001 inline void
3002 cgraph_node::mark_force_output (void)
3004 force_output = 1;
3005 gcc_checking_assert (!global.inlined_to);
3008 /* Return true if function should be optimized for size. */
3010 inline bool
3011 cgraph_node::optimize_for_size_p (void)
3013 if (opt_for_fn (decl, optimize_size))
3014 return true;
3015 if (frequency == NODE_FREQUENCY_UNLIKELY_EXECUTED)
3016 return true;
3017 else
3018 return false;
3021 /* Return symtab_node for NODE or create one if it is not present
3022 in symtab. */
3024 inline symtab_node *
3025 symtab_node::get_create (tree node)
3027 if (TREE_CODE (node) == VAR_DECL)
3028 return varpool_node::get_create (node);
3029 else
3030 return cgraph_node::get_create (node);
3033 /* Return availability of NODE. */
3035 inline enum availability
3036 symtab_node::get_availability (void)
3038 if (is_a <cgraph_node *> (this))
3039 return dyn_cast <cgraph_node *> (this)->get_availability ();
3040 else
3041 return dyn_cast <varpool_node *> (this)->get_availability ();
3044 /* Call calback on symtab node and aliases associated to this node.
3045 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
3046 skipped. */
3048 inline bool
3049 symtab_node::call_for_symbol_and_aliases (bool (*callback) (symtab_node *,
3050 void *),
3051 void *data,
3052 bool include_overwritable)
3054 if (callback (this, data))
3055 return true;
3056 if (has_aliases_p ())
3057 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3058 return false;
3061 /* Call callback on function and aliases associated to the function.
3062 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
3063 skipped. */
3065 inline bool
3066 cgraph_node::call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
3067 void *),
3068 void *data,
3069 bool include_overwritable)
3071 if (callback (this, data))
3072 return true;
3073 if (has_aliases_p ())
3074 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3075 return false;
3078 /* Call calback on varpool symbol and aliases associated to varpool symbol.
3079 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
3080 skipped. */
3082 inline bool
3083 varpool_node::call_for_symbol_and_aliases (bool (*callback) (varpool_node *,
3084 void *),
3085 void *data,
3086 bool include_overwritable)
3088 if (callback (this, data))
3089 return true;
3090 if (has_aliases_p ())
3091 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3092 return false;
3095 /* Return true if refernece may be used in address compare. */
3097 inline bool
3098 ipa_ref::address_matters_p ()
3100 if (use != IPA_REF_ADDR)
3101 return false;
3102 /* Addresses taken from virtual tables are never compared. */
3103 if (is_a <varpool_node *> (referring)
3104 && DECL_VIRTUAL_P (referring->decl))
3105 return false;
3106 return referred->address_can_be_compared_p ();
3109 /* Build polymorphic call context for indirect call E. */
3111 inline
3112 ipa_polymorphic_call_context::ipa_polymorphic_call_context (cgraph_edge *e)
3114 gcc_checking_assert (e->indirect_info->polymorphic);
3115 *this = e->indirect_info->context;
3118 /* Build empty "I know nothing" context. */
3120 inline
3121 ipa_polymorphic_call_context::ipa_polymorphic_call_context ()
3123 clear_speculation ();
3124 clear_outer_type ();
3125 invalid = false;
3128 /* Make context non-speculative. */
3130 inline void
3131 ipa_polymorphic_call_context::clear_speculation ()
3133 speculative_outer_type = NULL;
3134 speculative_offset = 0;
3135 speculative_maybe_derived_type = false;
3138 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
3139 NULL, the context is set to dummy "I know nothing" setting. */
3141 inline void
3142 ipa_polymorphic_call_context::clear_outer_type (tree otr_type)
3144 outer_type = otr_type ? TYPE_MAIN_VARIANT (otr_type) : NULL;
3145 offset = 0;
3146 maybe_derived_type = true;
3147 maybe_in_construction = true;
3148 dynamic = true;
3151 /* Adjust all offsets in contexts by OFF bits. */
3153 inline void
3154 ipa_polymorphic_call_context::offset_by (HOST_WIDE_INT off)
3156 if (outer_type)
3157 offset += off;
3158 if (speculative_outer_type)
3159 speculative_offset += off;
3162 /* Return TRUE if context is fully useless. */
3164 inline bool
3165 ipa_polymorphic_call_context::useless_p () const
3167 return (!outer_type && !speculative_outer_type);
3170 /* Return true if NODE is local. Instrumentation clones are counted as local
3171 only when original function is local. */
3173 static inline bool
3174 cgraph_local_p (cgraph_node *node)
3176 if (!node->instrumentation_clone || !node->instrumented_version)
3177 return node->local.local;
3179 return node->local.local && node->instrumented_version->local.local;
3182 /* When using fprintf (or similar), problems can arise with
3183 transient generated strings. Many string-generation APIs
3184 only support one result being alive at once (e.g. by
3185 returning a pointer to a statically-allocated buffer).
3187 If there is more than one generated string within one
3188 fprintf call: the first string gets evicted or overwritten
3189 by the second, before fprintf is fully evaluated.
3190 See e.g. PR/53136.
3192 This function provides a workaround for this, by providing
3193 a simple way to create copies of these transient strings,
3194 without the need to have explicit cleanup:
3196 fprintf (dumpfile, "string 1: %s string 2:%s\n",
3197 xstrdup_for_dump (EXPR_1),
3198 xstrdup_for_dump (EXPR_2));
3200 This is actually a simple wrapper around ggc_strdup, but
3201 the name documents the intent. We require that no GC can occur
3202 within the fprintf call. */
3204 static inline const char *
3205 xstrdup_for_dump (const char *transient_str)
3207 return ggc_strdup (transient_str);
3210 #endif /* GCC_CGRAPH_H */