gcc/ada/
[official-gcc.git] / gcc / cgraph.h
blob62d4ad6ee7c623208838a38fc0f45a37ecf3d9e5
1 /* Callgraph handling code.
2 Copyright (C) 2003-2015 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
25 /* Symbol table consists of functions and variables.
26 TODO: add labels and CONST_DECLs. */
27 enum symtab_type
29 SYMTAB_SYMBOL,
30 SYMTAB_FUNCTION,
31 SYMTAB_VARIABLE
34 /* Section names are stored as reference counted strings in GGC safe hashtable
35 (to make them survive through PCH). */
37 struct GTY((for_user)) section_hash_entry_d
39 int ref_count;
40 char *name; /* As long as this datastructure stays in GGC, we can not put
41 string at the tail of structure of GGC dies in horrible
42 way */
45 typedef struct section_hash_entry_d section_hash_entry;
47 struct section_name_hasher : ggc_hasher<section_hash_entry *>
49 typedef const char *compare_type;
51 static hashval_t hash (section_hash_entry *);
52 static bool equal (section_hash_entry *, const char *);
55 enum availability
57 /* Not yet set by cgraph_function_body_availability. */
58 AVAIL_UNSET,
59 /* Function body/variable initializer is unknown. */
60 AVAIL_NOT_AVAILABLE,
61 /* Function body/variable initializer is known but might be replaced
62 by a different one from other compilation unit and thus needs to
63 be dealt with a care. Like AVAIL_NOT_AVAILABLE it can have
64 arbitrary side effects on escaping variables and functions, while
65 like AVAILABLE it might access static variables. */
66 AVAIL_INTERPOSABLE,
67 /* Function body/variable initializer is known and will be used in final
68 program. */
69 AVAIL_AVAILABLE,
70 /* Function body/variable initializer is known and all it's uses are
71 explicitly visible within current unit (ie it's address is never taken and
72 it is not exported to other units). Currently used only for functions. */
73 AVAIL_LOCAL
76 /* Classification of symbols WRT partitioning. */
77 enum symbol_partitioning_class
79 /* External declarations are ignored by partitioning algorithms and they are
80 added into the boundary later via compute_ltrans_boundary. */
81 SYMBOL_EXTERNAL,
82 /* Partitioned symbols are pur into one of partitions. */
83 SYMBOL_PARTITION,
84 /* Duplicated symbols (such as comdat or constant pool references) are
85 copied into every node needing them via add_symbol_to_partition. */
86 SYMBOL_DUPLICATE
89 /* Base of all entries in the symbol table.
90 The symtab_node is inherited by cgraph and varpol nodes. */
91 class GTY((desc ("%h.type"), tag ("SYMTAB_SYMBOL"),
92 chain_next ("%h.next"), chain_prev ("%h.previous")))
93 symtab_node
95 public:
96 /* Return name. */
97 const char *name () const;
99 /* Return asm name. */
100 const char * asm_name () const;
102 /* Add node into symbol table. This function is not used directly, but via
103 cgraph/varpool node creation routines. */
104 void register_symbol (void);
106 /* Remove symbol from symbol table. */
107 void remove (void);
109 /* Dump symtab node to F. */
110 void dump (FILE *f);
112 /* Dump symtab node to stderr. */
113 void DEBUG_FUNCTION debug (void);
115 /* Verify consistency of node. */
116 void DEBUG_FUNCTION verify (void);
118 /* Return ipa reference from this symtab_node to
119 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
120 of the use and STMT the statement (if it exists). */
121 ipa_ref *create_reference (symtab_node *referred_node,
122 enum ipa_ref_use use_type);
124 /* Return ipa reference from this symtab_node to
125 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
126 of the use and STMT the statement (if it exists). */
127 ipa_ref *create_reference (symtab_node *referred_node,
128 enum ipa_ref_use use_type, gimple stmt);
130 /* If VAL is a reference to a function or a variable, add a reference from
131 this symtab_node to the corresponding symbol table node. USE_TYPE specify
132 type of the use and STMT the statement (if it exists). Return the new
133 reference or NULL if none was created. */
134 ipa_ref *maybe_create_reference (tree val, enum ipa_ref_use use_type,
135 gimple stmt);
137 /* Clone all references from symtab NODE to this symtab_node. */
138 void clone_references (symtab_node *node);
140 /* Remove all stmt references in non-speculative references.
141 Those are not maintained during inlining & clonning.
142 The exception are speculative references that are updated along
143 with callgraph edges associated with them. */
144 void clone_referring (symtab_node *node);
146 /* Clone reference REF to this symtab_node and set its stmt to STMT. */
147 ipa_ref *clone_reference (ipa_ref *ref, gimple stmt);
149 /* Find the structure describing a reference to REFERRED_NODE
150 and associated with statement STMT. */
151 ipa_ref *find_reference (symtab_node *referred_node, gimple stmt,
152 unsigned int lto_stmt_uid);
154 /* Remove all references that are associated with statement STMT. */
155 void remove_stmt_references (gimple stmt);
157 /* Remove all stmt references in non-speculative references.
158 Those are not maintained during inlining & clonning.
159 The exception are speculative references that are updated along
160 with callgraph edges associated with them. */
161 void clear_stmts_in_references (void);
163 /* Remove all references in ref list. */
164 void remove_all_references (void);
166 /* Remove all referring items in ref list. */
167 void remove_all_referring (void);
169 /* Dump references in ref list to FILE. */
170 void dump_references (FILE *file);
172 /* Dump referring in list to FILE. */
173 void dump_referring (FILE *);
175 /* Get number of references for this node. */
176 inline unsigned num_references (void)
178 return ref_list.references ? ref_list.references->length () : 0;
181 /* Iterates I-th reference in the list, REF is also set. */
182 ipa_ref *iterate_reference (unsigned i, ipa_ref *&ref);
184 /* Iterates I-th referring item in the list, REF is also set. */
185 ipa_ref *iterate_referring (unsigned i, ipa_ref *&ref);
187 /* Iterates I-th referring alias item in the list, REF is also set. */
188 ipa_ref *iterate_direct_aliases (unsigned i, ipa_ref *&ref);
190 /* Return true if symtab node and TARGET represents
191 semantically equivalent symbols. */
192 bool semantically_equivalent_p (symtab_node *target);
194 /* Classify symbol symtab node for partitioning. */
195 enum symbol_partitioning_class get_partitioning_class (void);
197 /* Return comdat group. */
198 tree get_comdat_group ()
200 return x_comdat_group;
203 /* Return comdat group as identifier_node. */
204 tree get_comdat_group_id ()
206 if (x_comdat_group && TREE_CODE (x_comdat_group) != IDENTIFIER_NODE)
207 x_comdat_group = DECL_ASSEMBLER_NAME (x_comdat_group);
208 return x_comdat_group;
211 /* Set comdat group. */
212 void set_comdat_group (tree group)
214 gcc_checking_assert (!group || TREE_CODE (group) == IDENTIFIER_NODE
215 || DECL_P (group));
216 x_comdat_group = group;
219 /* Return section as string. */
220 const char * get_section ()
222 if (!x_section)
223 return NULL;
224 return x_section->name;
227 /* Remove node from same comdat group. */
228 void remove_from_same_comdat_group (void);
230 /* Add this symtab_node to the same comdat group that OLD is in. */
231 void add_to_same_comdat_group (symtab_node *old_node);
233 /* Dissolve the same_comdat_group list in which NODE resides. */
234 void dissolve_same_comdat_group_list (void);
236 /* Return true when symtab_node is known to be used from other (non-LTO)
237 object file. Known only when doing LTO via linker plugin. */
238 bool used_from_object_file_p (void);
240 /* Walk the alias chain to return the symbol NODE is alias of.
241 If NODE is not an alias, return NODE.
242 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
243 symtab_node *ultimate_alias_target (enum availability *avail = NULL);
245 /* Return next reachable static symbol with initializer after NODE. */
246 inline symtab_node *next_defined_symbol (void);
248 /* Add reference recording that symtab node is alias of TARGET.
249 The function can fail in the case of aliasing cycles; in this case
250 it returns false. */
251 bool resolve_alias (symtab_node *target);
253 /* C++ FE sometimes change linkage flags after producing same
254 body aliases. */
255 void fixup_same_cpp_alias_visibility (symtab_node *target);
257 /* Call callback on symtab node and aliases associated to this node.
258 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
259 skipped. */
260 bool call_for_symbol_and_aliases (bool (*callback) (symtab_node *, void *),
261 void *data,
262 bool include_overwrite);
264 /* If node can not be interposable by static or dynamic linker to point to
265 different definition, return this symbol. Otherwise look for alias with
266 such property and if none exists, introduce new one. */
267 symtab_node *noninterposable_alias (void);
269 /* Return node that alias is aliasing. */
270 inline symtab_node *get_alias_target (void);
272 /* Set section for symbol and its aliases. */
273 void set_section (const char *section);
275 /* Set section, do not recurse into aliases.
276 When one wants to change section of symbol and its aliases,
277 use set_section. */
278 void set_section_for_node (const char *section);
280 /* Set initialization priority to PRIORITY. */
281 void set_init_priority (priority_type priority);
283 /* Return the initialization priority. */
284 priority_type get_init_priority ();
286 /* Return availability of NODE. */
287 enum availability get_availability (void);
289 /* Make DECL local. */
290 void make_decl_local (void);
292 /* Return desired alignment of the definition. This is NOT alignment useful
293 to access THIS, because THIS may be interposable and DECL_ALIGN should
294 be used instead. It however must be guaranteed when output definition
295 of THIS. */
296 unsigned int definition_alignment ();
298 /* Return true if alignment can be increased. */
299 bool can_increase_alignment_p ();
301 /* Increase alignment of symbol to ALIGN. */
302 void increase_alignment (unsigned int align);
304 /* Return true if list contains an alias. */
305 bool has_aliases_p (void);
307 /* Return true when the symbol is real symbol, i.e. it is not inline clone
308 or abstract function kept for debug info purposes only. */
309 bool real_symbol_p (void);
311 /* Determine if symbol declaration is needed. That is, visible to something
312 either outside this translation unit, something magic in the system
313 configury. This function is used just during symbol creation. */
314 bool needed_p (void);
316 /* Return true when there are references to the node. */
317 bool referred_to_p (bool include_self = true);
319 /* Return true if NODE can be discarded by linker from the binary. */
320 inline bool
321 can_be_discarded_p (void)
323 return (DECL_EXTERNAL (decl)
324 || (get_comdat_group ()
325 && resolution != LDPR_PREVAILING_DEF
326 && resolution != LDPR_PREVAILING_DEF_IRONLY
327 && resolution != LDPR_PREVAILING_DEF_IRONLY_EXP));
330 /* Return true if NODE is local to a particular COMDAT group, and must not
331 be named from outside the COMDAT. This is used for C++ decloned
332 constructors. */
333 inline bool comdat_local_p (void)
335 return (same_comdat_group && !TREE_PUBLIC (decl));
338 /* Return true if ONE and TWO are part of the same COMDAT group. */
339 inline bool in_same_comdat_group_p (symtab_node *target);
341 /* Return true if symbol is known to be nonzero. */
342 bool nonzero_address ();
344 /* Return 0 if symbol is known to have different address than S2,
345 Return 1 if symbol is known to have same address as S2,
346 return 2 otherwise. */
347 int equal_address_to (symtab_node *s2);
349 /* Return true if symbol's address may possibly be compared to other
350 symbol's address. */
351 bool address_matters_p ();
353 /* Return true if NODE's address can be compared. This use properties
354 of NODE only and does not look if the address is actually taken in
355 interesting way. For that use ADDRESS_MATTERS_P instead. */
356 bool address_can_be_compared_p (void);
358 /* Return symbol table node associated with DECL, if any,
359 and NULL otherwise. */
360 static inline symtab_node *get (const_tree decl)
362 #ifdef ENABLE_CHECKING
363 /* Check that we are called for sane type of object - functions
364 and static or external variables. */
365 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL
366 || (TREE_CODE (decl) == VAR_DECL
367 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl)
368 || in_lto_p)));
369 /* Check that the mapping is sane - perhaps this check can go away,
370 but at the moment frontends tends to corrupt the mapping by calling
371 memcpy/memset on the tree nodes. */
372 gcc_checking_assert (!decl->decl_with_vis.symtab_node
373 || decl->decl_with_vis.symtab_node->decl == decl);
374 #endif
375 return decl->decl_with_vis.symtab_node;
378 /* Try to find a symtab node for declaration DECL and if it does not
379 exist or if it corresponds to an inline clone, create a new one. */
380 static inline symtab_node * get_create (tree node);
382 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
383 Return NULL if there's no such node. */
384 static symtab_node *get_for_asmname (const_tree asmname);
386 /* Dump symbol table to F. */
387 static void dump_table (FILE *);
389 /* Dump symbol table to stderr. */
390 static inline DEBUG_FUNCTION void debug_symtab (void)
392 dump_table (stderr);
395 /* Verify symbol table for internal consistency. */
396 static DEBUG_FUNCTION void verify_symtab_nodes (void);
398 /* Type of the symbol. */
399 ENUM_BITFIELD (symtab_type) type : 8;
401 /* The symbols resolution. */
402 ENUM_BITFIELD (ld_plugin_symbol_resolution) resolution : 8;
404 /*** Flags representing the symbol type. ***/
406 /* True when symbol corresponds to a definition in current unit.
407 set via finalize_function or finalize_decl */
408 unsigned definition : 1;
409 /* True when symbol is an alias.
410 Set by ssemble_alias. */
411 unsigned alias : 1;
412 /* True when alias is a weakref. */
413 unsigned weakref : 1;
414 /* C++ frontend produce same body aliases and extra name aliases for
415 virtual functions and vtables that are obviously equivalent.
416 Those aliases are bit special, especially because C++ frontend
417 visibility code is so ugly it can not get them right at first time
418 and their visibility needs to be copied from their "masters" at
419 the end of parsing. */
420 unsigned cpp_implicit_alias : 1;
421 /* Set once the definition was analyzed. The list of references and
422 other properties are built during analysis. */
423 unsigned analyzed : 1;
424 /* Set for write-only variables. */
425 unsigned writeonly : 1;
426 /* Visibility of symbol was used for further optimization; do not
427 permit further changes. */
428 unsigned refuse_visibility_changes : 1;
430 /*** Visibility and linkage flags. ***/
432 /* Set when function is visible by other units. */
433 unsigned externally_visible : 1;
434 /* Don't reorder to other symbols having this set. */
435 unsigned no_reorder : 1;
436 /* The symbol will be assumed to be used in an invisible way (like
437 by an toplevel asm statement). */
438 unsigned force_output : 1;
439 /* Like FORCE_OUTPUT, but in the case it is ABI requiring the symbol to be
440 exported. Unlike FORCE_OUTPUT this flag gets cleared to symbols promoted
441 to static and it does not inhibit optimization. */
442 unsigned forced_by_abi : 1;
443 /* True when the name is known to be unique and thus it does not need mangling. */
444 unsigned unique_name : 1;
445 /* Specify whether the section was set by user or by
446 compiler via -ffunction-sections. */
447 unsigned implicit_section : 1;
448 /* True when body and other characteristics have been removed by
449 symtab_remove_unreachable_nodes. */
450 unsigned body_removed : 1;
452 /*** WHOPR Partitioning flags.
453 These flags are used at ltrans stage when only part of the callgraph is
454 available. ***/
456 /* Set when variable is used from other LTRANS partition. */
457 unsigned used_from_other_partition : 1;
458 /* Set when function is available in the other LTRANS partition.
459 During WPA output it is used to mark nodes that are present in
460 multiple partitions. */
461 unsigned in_other_partition : 1;
465 /*** other flags. ***/
467 /* Set when symbol has address taken. */
468 unsigned address_taken : 1;
469 /* Set when init priority is set. */
470 unsigned in_init_priority_hash : 1;
472 /* Set when symbol needs to be streamed into LTO bytecode for LTO, or in case
473 of offloading, for separate compilation for a different target. */
474 unsigned need_lto_streaming : 1;
476 /* Set when symbol can be streamed into bytecode for offloading. */
477 unsigned offloadable : 1;
480 /* Ordering of all symtab entries. */
481 int order;
483 /* Declaration representing the symbol. */
484 tree decl;
486 /* Linked list of symbol table entries starting with symtab_nodes. */
487 symtab_node *next;
488 symtab_node *previous;
490 /* Linked list of symbols with the same asm name. There may be multiple
491 entries for single symbol name during LTO, because symbols are renamed
492 only after partitioning.
494 Because inline clones are kept in the assembler name has, they also produce
495 duplicate entries.
497 There are also several long standing bugs where frontends and builtin
498 code produce duplicated decls. */
499 symtab_node *next_sharing_asm_name;
500 symtab_node *previous_sharing_asm_name;
502 /* Circular list of nodes in the same comdat group if non-NULL. */
503 symtab_node *same_comdat_group;
505 /* Vectors of referring and referenced entities. */
506 ipa_ref_list ref_list;
508 /* Alias target. May be either DECL pointer or ASSEMBLER_NAME pointer
509 depending to what was known to frontend on the creation time.
510 Once alias is resolved, this pointer become NULL. */
511 tree alias_target;
513 /* File stream where this node is being written to. */
514 struct lto_file_decl_data * lto_file_data;
516 PTR GTY ((skip)) aux;
518 /* Comdat group the symbol is in. Can be private if GGC allowed that. */
519 tree x_comdat_group;
521 /* Section name. Again can be private, if allowed. */
522 section_hash_entry *x_section;
524 protected:
525 /* Dump base fields of symtab nodes to F. Not to be used directly. */
526 void dump_base (FILE *);
528 /* Verify common part of symtab node. */
529 bool DEBUG_FUNCTION verify_base (void);
531 /* Remove node from symbol table. This function is not used directly, but via
532 cgraph/varpool node removal routines. */
533 void unregister (void);
535 /* Return the initialization and finalization priority information for
536 DECL. If there is no previous priority information, a freshly
537 allocated structure is returned. */
538 struct symbol_priority_map *priority_info (void);
540 /* Worker for call_for_symbol_and_aliases_1. */
541 bool call_for_symbol_and_aliases_1 (bool (*callback) (symtab_node *, void *),
542 void *data,
543 bool include_overwrite);
544 private:
545 /* Worker for set_section. */
546 static bool set_section (symtab_node *n, void *s);
548 /* Worker for symtab_resolve_alias. */
549 static bool set_implicit_section (symtab_node *n, void *);
551 /* Worker searching noninterposable alias. */
552 static bool noninterposable_alias (symtab_node *node, void *data);
554 /* Worker for ultimate_alias_target. */
555 symtab_node *ultimate_alias_target_1 (enum availability *avail = NULL);
558 /* Walk all aliases for NODE. */
559 #define FOR_EACH_ALIAS(node, alias) \
560 for (unsigned x_i = 0; node->iterate_direct_aliases (x_i, alias); x_i++)
562 /* This is the information that is put into the cgraph local structure
563 to recover a function. */
564 struct lto_file_decl_data;
566 extern const char * const cgraph_availability_names[];
567 extern const char * const ld_plugin_symbol_resolution_names[];
568 extern const char * const tls_model_names[];
570 /* Information about thunk, used only for same body aliases. */
572 struct GTY(()) cgraph_thunk_info {
573 /* Information about the thunk. */
574 HOST_WIDE_INT fixed_offset;
575 HOST_WIDE_INT virtual_value;
576 tree alias;
577 bool this_adjusting;
578 bool virtual_offset_p;
579 bool add_pointer_bounds_args;
580 /* Set to true when alias node is thunk. */
581 bool thunk_p;
584 /* Information about the function collected locally.
585 Available after function is analyzed. */
587 struct GTY(()) cgraph_local_info {
588 /* Set when function function is visible in current compilation unit only
589 and its address is never taken. */
590 unsigned local : 1;
592 /* False when there is something makes versioning impossible. */
593 unsigned versionable : 1;
595 /* False when function calling convention and signature can not be changed.
596 This is the case when __builtin_apply_args is used. */
597 unsigned can_change_signature : 1;
599 /* True when the function has been originally extern inline, but it is
600 redefined now. */
601 unsigned redefined_extern_inline : 1;
603 /* True if the function may enter serial irrevocable mode. */
604 unsigned tm_may_enter_irr : 1;
607 /* Information about the function that needs to be computed globally
608 once compilation is finished. Available only with -funit-at-a-time. */
610 struct GTY(()) cgraph_global_info {
611 /* For inline clones this points to the function they will be
612 inlined into. */
613 cgraph_node *inlined_to;
616 /* Represent which DECL tree (or reference to such tree)
617 will be replaced by another tree while versioning. */
618 struct GTY(()) ipa_replace_map
620 /* The tree that will be replaced. */
621 tree old_tree;
622 /* The new (replacing) tree. */
623 tree new_tree;
624 /* Parameter number to replace, when old_tree is NULL. */
625 int parm_num;
626 /* True when a substitution should be done, false otherwise. */
627 bool replace_p;
628 /* True when we replace a reference to old_tree. */
629 bool ref_p;
632 struct GTY(()) cgraph_clone_info
634 vec<ipa_replace_map *, va_gc> *tree_map;
635 bitmap args_to_skip;
636 bitmap combined_args_to_skip;
639 enum cgraph_simd_clone_arg_type
641 SIMD_CLONE_ARG_TYPE_VECTOR,
642 SIMD_CLONE_ARG_TYPE_UNIFORM,
643 SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP,
644 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP,
645 SIMD_CLONE_ARG_TYPE_MASK
648 /* Function arguments in the original function of a SIMD clone.
649 Supplementary data for `struct simd_clone'. */
651 struct GTY(()) cgraph_simd_clone_arg {
652 /* Original function argument as it originally existed in
653 DECL_ARGUMENTS. */
654 tree orig_arg;
656 /* orig_arg's function (or for extern functions type from
657 TYPE_ARG_TYPES). */
658 tree orig_type;
660 /* If argument is a vector, this holds the vector version of
661 orig_arg that after adjusting the argument types will live in
662 DECL_ARGUMENTS. Otherwise, this is NULL.
664 This basically holds:
665 vector(simdlen) __typeof__(orig_arg) new_arg. */
666 tree vector_arg;
668 /* vector_arg's type (or for extern functions new vector type. */
669 tree vector_type;
671 /* If argument is a vector, this holds the array where the simd
672 argument is held while executing the simd clone function. This
673 is a local variable in the cloned function. Its content is
674 copied from vector_arg upon entry to the clone.
676 This basically holds:
677 __typeof__(orig_arg) simd_array[simdlen]. */
678 tree simd_array;
680 /* A SIMD clone's argument can be either linear (constant or
681 variable), uniform, or vector. */
682 enum cgraph_simd_clone_arg_type arg_type;
684 /* For arg_type SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP this is
685 the constant linear step, if arg_type is
686 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP, this is index of
687 the uniform argument holding the step, otherwise 0. */
688 HOST_WIDE_INT linear_step;
690 /* Variable alignment if available, otherwise 0. */
691 unsigned int alignment;
694 /* Specific data for a SIMD function clone. */
696 struct GTY(()) cgraph_simd_clone {
697 /* Number of words in the SIMD lane associated with this clone. */
698 unsigned int simdlen;
700 /* Number of annotated function arguments in `args'. This is
701 usually the number of named arguments in FNDECL. */
702 unsigned int nargs;
704 /* Max hardware vector size in bits for integral vectors. */
705 unsigned int vecsize_int;
707 /* Max hardware vector size in bits for floating point vectors. */
708 unsigned int vecsize_float;
710 /* The mangling character for a given vector size. This is is used
711 to determine the ISA mangling bit as specified in the Intel
712 Vector ABI. */
713 unsigned char vecsize_mangle;
715 /* True if this is the masked, in-branch version of the clone,
716 otherwise false. */
717 unsigned int inbranch : 1;
719 /* True if this is a Cilk Plus variant. */
720 unsigned int cilk_elemental : 1;
722 /* Doubly linked list of SIMD clones. */
723 cgraph_node *prev_clone, *next_clone;
725 /* Original cgraph node the SIMD clones were created for. */
726 cgraph_node *origin;
728 /* Annotated function arguments for the original function. */
729 cgraph_simd_clone_arg GTY((length ("%h.nargs"))) args[1];
732 /* Function Multiversioning info. */
733 struct GTY((for_user)) cgraph_function_version_info {
734 /* The cgraph_node for which the function version info is stored. */
735 cgraph_node *this_node;
736 /* Chains all the semantically identical function versions. The
737 first function in this chain is the version_info node of the
738 default function. */
739 cgraph_function_version_info *prev;
740 /* If this version node corresponds to a dispatcher for function
741 versions, this points to the version info node of the default
742 function, the first node in the chain. */
743 cgraph_function_version_info *next;
744 /* If this node corresponds to a function version, this points
745 to the dispatcher function decl, which is the function that must
746 be called to execute the right function version at run-time.
748 If this cgraph node is a dispatcher (if dispatcher_function is
749 true, in the cgraph_node struct) for function versions, this
750 points to resolver function, which holds the function body of the
751 dispatcher. The dispatcher decl is an alias to the resolver
752 function decl. */
753 tree dispatcher_resolver;
756 #define DEFCIFCODE(code, type, string) CIF_ ## code,
757 /* Reasons for inlining failures. */
759 enum cgraph_inline_failed_t {
760 #include "cif-code.def"
761 CIF_N_REASONS
764 enum cgraph_inline_failed_type_t
766 CIF_FINAL_NORMAL = 0,
767 CIF_FINAL_ERROR
770 struct cgraph_edge;
772 struct cgraph_edge_hasher : ggc_hasher<cgraph_edge *>
774 typedef gimple compare_type;
776 static hashval_t hash (cgraph_edge *);
777 static hashval_t hash (gimple);
778 static bool equal (cgraph_edge *, gimple);
781 /* The cgraph data structure.
782 Each function decl has assigned cgraph_node listing callees and callers. */
784 struct GTY((tag ("SYMTAB_FUNCTION"))) cgraph_node : public symtab_node {
785 public:
786 /* Remove the node from cgraph and all inline clones inlined into it.
787 Skip however removal of FORBIDDEN_NODE and return true if it needs to be
788 removed. This allows to call the function from outer loop walking clone
789 tree. */
790 bool remove_symbol_and_inline_clones (cgraph_node *forbidden_node = NULL);
792 /* Record all references from cgraph_node that are taken
793 in statement STMT. */
794 void record_stmt_references (gimple stmt);
796 /* Like cgraph_set_call_stmt but walk the clone tree and update all
797 clones sharing the same function body.
798 When WHOLE_SPECULATIVE_EDGES is true, all three components of
799 speculative edge gets updated. Otherwise we update only direct
800 call. */
801 void set_call_stmt_including_clones (gimple old_stmt, gcall *new_stmt,
802 bool update_speculative = true);
804 /* Walk the alias chain to return the function cgraph_node is alias of.
805 Walk through thunk, too.
806 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
807 cgraph_node *function_symbol (enum availability *avail = NULL);
809 /* Walk the alias chain to return the function cgraph_node is alias of.
810 Walk through non virtual thunks, too. Thus we return either a function
811 or a virtual thunk node.
812 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
813 cgraph_node *function_or_virtual_thunk_symbol
814 (enum availability *avail = NULL);
816 /* Create node representing clone of N executed COUNT times. Decrease
817 the execution counts from original node too.
818 The new clone will have decl set to DECL that may or may not be the same
819 as decl of N.
821 When UPDATE_ORIGINAL is true, the counts are subtracted from the original
822 function's profile to reflect the fact that part of execution is handled
823 by node.
824 When CALL_DUPLICATOIN_HOOK is true, the ipa passes are acknowledged about
825 the new clone. Otherwise the caller is responsible for doing so later.
827 If the new node is being inlined into another one, NEW_INLINED_TO should be
828 the outline function the new one is (even indirectly) inlined to.
829 All hooks will see this in node's global.inlined_to, when invoked.
830 Can be NULL if the node is not inlined. */
831 cgraph_node *create_clone (tree decl, gcov_type count, int freq,
832 bool update_original,
833 vec<cgraph_edge *> redirect_callers,
834 bool call_duplication_hook,
835 cgraph_node *new_inlined_to,
836 bitmap args_to_skip);
838 /* Create callgraph node clone with new declaration. The actual body will
839 be copied later at compilation stage. */
840 cgraph_node *create_virtual_clone (vec<cgraph_edge *> redirect_callers,
841 vec<ipa_replace_map *, va_gc> *tree_map,
842 bitmap args_to_skip, const char * suffix);
844 /* cgraph node being removed from symbol table; see if its entry can be
845 replaced by other inline clone. */
846 cgraph_node *find_replacement (void);
848 /* Create a new cgraph node which is the new version of
849 callgraph node. REDIRECT_CALLERS holds the callers
850 edges which should be redirected to point to
851 NEW_VERSION. ALL the callees edges of the node
852 are cloned to the new version node. Return the new
853 version node.
855 If non-NULL BLOCK_TO_COPY determine what basic blocks
856 was copied to prevent duplications of calls that are dead
857 in the clone. */
859 cgraph_node *create_version_clone (tree new_decl,
860 vec<cgraph_edge *> redirect_callers,
861 bitmap bbs_to_copy);
863 /* Perform function versioning.
864 Function versioning includes copying of the tree and
865 a callgraph update (creating a new cgraph node and updating
866 its callees and callers).
868 REDIRECT_CALLERS varray includes the edges to be redirected
869 to the new version.
871 TREE_MAP is a mapping of tree nodes we want to replace with
872 new ones (according to results of prior analysis).
874 If non-NULL ARGS_TO_SKIP determine function parameters to remove
875 from new version.
876 If SKIP_RETURN is true, the new version will return void.
877 If non-NULL BLOCK_TO_COPY determine what basic blocks to copy.
878 If non_NULL NEW_ENTRY determine new entry BB of the clone.
880 Return the new version's cgraph node. */
881 cgraph_node *create_version_clone_with_body
882 (vec<cgraph_edge *> redirect_callers,
883 vec<ipa_replace_map *, va_gc> *tree_map, bitmap args_to_skip,
884 bool skip_return, bitmap bbs_to_copy, basic_block new_entry_block,
885 const char *clone_name);
887 /* Insert a new cgraph_function_version_info node into cgraph_fnver_htab
888 corresponding to cgraph_node. */
889 cgraph_function_version_info *insert_new_function_version (void);
891 /* Get the cgraph_function_version_info node corresponding to node. */
892 cgraph_function_version_info *function_version (void);
894 /* Discover all functions and variables that are trivially needed, analyze
895 them as well as all functions and variables referred by them */
896 void analyze (void);
898 /* Add thunk alias into callgraph. The alias declaration is ALIAS and it
899 aliases DECL with an adjustments made into the first parameter.
900 See comments in thunk_adjust for detail on the parameters. */
901 cgraph_node * create_thunk (tree alias, tree, bool this_adjusting,
902 HOST_WIDE_INT fixed_offset,
903 HOST_WIDE_INT virtual_value,
904 tree virtual_offset,
905 tree real_alias);
908 /* Return node that alias is aliasing. */
909 inline cgraph_node *get_alias_target (void);
911 /* Given function symbol, walk the alias chain to return the function node
912 is alias of. Do not walk through thunks.
913 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
915 cgraph_node *ultimate_alias_target (availability *availability = NULL);
917 /* Expand thunk NODE to gimple if possible.
918 When FORCE_GIMPLE_THUNK is true, gimple thunk is created and
919 no assembler is produced.
920 When OUTPUT_ASM_THUNK is true, also produce assembler for
921 thunks that are not lowered. */
922 bool expand_thunk (bool output_asm_thunks, bool force_gimple_thunk);
924 /* Call expand_thunk on all callers that are thunks and analyze those
925 nodes that were expanded. */
926 void expand_all_artificial_thunks ();
928 /* Assemble thunks and aliases associated to node. */
929 void assemble_thunks_and_aliases (void);
931 /* Expand function specified by node. */
932 void expand (void);
934 /* As an GCC extension we allow redefinition of the function. The
935 semantics when both copies of bodies differ is not well defined.
936 We replace the old body with new body so in unit at a time mode
937 we always use new body, while in normal mode we may end up with
938 old body inlined into some functions and new body expanded and
939 inlined in others. */
940 void reset (void);
942 /* Creates a wrapper from cgraph_node to TARGET node. Thunk is used for this
943 kind of wrapper method. */
944 void create_wrapper (cgraph_node *target);
946 /* Verify cgraph nodes of the cgraph node. */
947 void DEBUG_FUNCTION verify_node (void);
949 /* Remove function from symbol table. */
950 void remove (void);
952 /* Dump call graph node to file F. */
953 void dump (FILE *f);
955 /* Dump call graph node to stderr. */
956 void DEBUG_FUNCTION debug (void);
958 /* When doing LTO, read cgraph_node's body from disk if it is not already
959 present. */
960 bool get_untransformed_body (void);
962 /* Prepare function body. When doing LTO, read cgraph_node's body from disk
963 if it is not already present. When some IPA transformations are scheduled,
964 apply them. */
965 bool get_body (void);
967 /* Release memory used to represent body of function.
968 Use this only for functions that are released before being translated to
969 target code (i.e. RTL). Functions that are compiled to RTL and beyond
970 are free'd in final.c via free_after_compilation(). */
971 void release_body (bool keep_arguments = false);
973 /* Return the DECL_STRUCT_FUNCTION of the function. */
974 struct function *get_fun (void);
976 /* cgraph_node is no longer nested function; update cgraph accordingly. */
977 void unnest (void);
979 /* Bring cgraph node local. */
980 void make_local (void);
982 /* Likewise indicate that a node is having address taken. */
983 void mark_address_taken (void);
985 /* Set fialization priority to PRIORITY. */
986 void set_fini_priority (priority_type priority);
988 /* Return the finalization priority. */
989 priority_type get_fini_priority (void);
991 /* Create edge from a given function to CALLEE in the cgraph. */
992 cgraph_edge *create_edge (cgraph_node *callee,
993 gcall *call_stmt, gcov_type count,
994 int freq);
996 /* Create an indirect edge with a yet-undetermined callee where the call
997 statement destination is a formal parameter of the caller with index
998 PARAM_INDEX. */
999 cgraph_edge *create_indirect_edge (gcall *call_stmt, int ecf_flags,
1000 gcov_type count, int freq,
1001 bool compute_indirect_info = true);
1003 /* Like cgraph_create_edge walk the clone tree and update all clones sharing
1004 same function body. If clones already have edge for OLD_STMT; only
1005 update the edge same way as cgraph_set_call_stmt_including_clones does. */
1006 void create_edge_including_clones (cgraph_node *callee,
1007 gimple old_stmt, gcall *stmt,
1008 gcov_type count,
1009 int freq,
1010 cgraph_inline_failed_t reason);
1012 /* Return the callgraph edge representing the GIMPLE_CALL statement
1013 CALL_STMT. */
1014 cgraph_edge *get_edge (gimple call_stmt);
1016 /* Collect all callers of cgraph_node and its aliases that are known to lead
1017 to NODE (i.e. are not overwritable). */
1018 vec<cgraph_edge *> collect_callers (void);
1020 /* Remove all callers from the node. */
1021 void remove_callers (void);
1023 /* Remove all callees from the node. */
1024 void remove_callees (void);
1026 /* Return function availability. See cgraph.h for description of individual
1027 return values. */
1028 enum availability get_availability (void);
1030 /* Set TREE_NOTHROW on cgraph_node's decl and on aliases of the node
1031 if any to NOTHROW. */
1032 void set_nothrow_flag (bool nothrow);
1034 /* Set TREE_READONLY on cgraph_node's decl and on aliases of the node
1035 if any to READONLY. */
1036 void set_const_flag (bool readonly, bool looping);
1038 /* Set DECL_PURE_P on cgraph_node's decl and on aliases of the node
1039 if any to PURE. */
1040 void set_pure_flag (bool pure, bool looping);
1042 /* Call callback on function and aliases associated to the function.
1043 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1044 skipped. */
1046 bool call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
1047 void *),
1048 void *data, bool include_overwritable);
1050 /* Call callback on cgraph_node, thunks and aliases associated to NODE.
1051 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1052 skipped. When EXCLUDE_VIRTUAL_THUNKS is true, virtual thunks are
1053 skipped. */
1054 bool call_for_symbol_thunks_and_aliases (bool (*callback) (cgraph_node *node,
1055 void *data),
1056 void *data,
1057 bool include_overwritable,
1058 bool exclude_virtual_thunks = false);
1060 /* Likewise indicate that a node is needed, i.e. reachable via some
1061 external means. */
1062 inline void mark_force_output (void);
1064 /* Return true when function can be marked local. */
1065 bool local_p (void);
1067 /* Return true if cgraph_node can be made local for API change.
1068 Extern inline functions and C++ COMDAT functions can be made local
1069 at the expense of possible code size growth if function is used in multiple
1070 compilation units. */
1071 bool can_be_local_p (void);
1073 /* Return true when cgraph_node can not return or throw and thus
1074 it is safe to ignore its side effects for IPA analysis. */
1075 bool cannot_return_p (void);
1077 /* Return true when function cgraph_node and all its aliases are only called
1078 directly.
1079 i.e. it is not externally visible, address was not taken and
1080 it is not used in any other non-standard way. */
1081 bool only_called_directly_p (void);
1083 /* Return true when function is only called directly or it has alias.
1084 i.e. it is not externally visible, address was not taken and
1085 it is not used in any other non-standard way. */
1086 inline bool only_called_directly_or_aliased_p (void);
1088 /* Return true when function cgraph_node can be expected to be removed
1089 from program when direct calls in this compilation unit are removed.
1091 As a special case COMDAT functions are
1092 cgraph_can_remove_if_no_direct_calls_p while the are not
1093 cgraph_only_called_directly_p (it is possible they are called from other
1094 unit)
1096 This function behaves as cgraph_only_called_directly_p because eliminating
1097 all uses of COMDAT function does not make it necessarily disappear from
1098 the program unless we are compiling whole program or we do LTO. In this
1099 case we know we win since dynamic linking will not really discard the
1100 linkonce section.
1102 If WILL_INLINE is true, assume that function will be inlined into all the
1103 direct calls. */
1104 bool will_be_removed_from_program_if_no_direct_calls_p
1105 (bool will_inline = false);
1107 /* Return true when function can be removed from callgraph
1108 if all direct calls and references are eliminated. The function does
1109 not take into account comdat groups. */
1110 bool can_remove_if_no_direct_calls_and_refs_p (void);
1112 /* Return true when function cgraph_node and its aliases can be removed from
1113 callgraph if all direct calls are eliminated.
1114 If WILL_INLINE is true, assume that function will be inlined into all the
1115 direct calls. */
1116 bool can_remove_if_no_direct_calls_p (bool will_inline = false);
1118 /* Return true when callgraph node is a function with Gimple body defined
1119 in current unit. Functions can also be define externally or they
1120 can be thunks with no Gimple representation.
1122 Note that at WPA stage, the function body may not be present in memory. */
1123 inline bool has_gimple_body_p (void);
1125 /* Return true if function should be optimized for size. */
1126 bool optimize_for_size_p (void);
1128 /* Dump the callgraph to file F. */
1129 static void dump_cgraph (FILE *f);
1131 /* Dump the call graph to stderr. */
1132 static inline
1133 void debug_cgraph (void)
1135 dump_cgraph (stderr);
1138 /* Record that DECL1 and DECL2 are semantically identical function
1139 versions. */
1140 static void record_function_versions (tree decl1, tree decl2);
1142 /* Remove the cgraph_function_version_info and cgraph_node for DECL. This
1143 DECL is a duplicate declaration. */
1144 static void delete_function_version (tree decl);
1146 /* Add the function FNDECL to the call graph.
1147 Unlike finalize_function, this function is intended to be used
1148 by middle end and allows insertion of new function at arbitrary point
1149 of compilation. The function can be either in high, low or SSA form
1150 GIMPLE.
1152 The function is assumed to be reachable and have address taken (so no
1153 API breaking optimizations are performed on it).
1155 Main work done by this function is to enqueue the function for later
1156 processing to avoid need the passes to be re-entrant. */
1157 static void add_new_function (tree fndecl, bool lowered);
1159 /* Return callgraph node for given symbol and check it is a function. */
1160 static inline cgraph_node *get (const_tree decl)
1162 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL);
1163 return dyn_cast <cgraph_node *> (symtab_node::get (decl));
1166 /* DECL has been parsed. Take it, queue it, compile it at the whim of the
1167 logic in effect. If NO_COLLECT is true, then our caller cannot stand to
1168 have the garbage collector run at the moment. We would need to either
1169 create a new GC context, or just not compile right now. */
1170 static void finalize_function (tree, bool);
1172 /* Return cgraph node assigned to DECL. Create new one when needed. */
1173 static cgraph_node * create (tree decl);
1175 /* Try to find a call graph node for declaration DECL and if it does not
1176 exist or if it corresponds to an inline clone, create a new one. */
1177 static cgraph_node * get_create (tree);
1179 /* Return local info for the compiled function. */
1180 static cgraph_local_info *local_info (tree decl);
1182 /* Return local info for the compiled function. */
1183 static struct cgraph_rtl_info *rtl_info (tree);
1185 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
1186 Return NULL if there's no such node. */
1187 static cgraph_node *get_for_asmname (tree asmname);
1189 /* Attempt to mark ALIAS as an alias to DECL. Return alias node if
1190 successful and NULL otherwise.
1191 Same body aliases are output whenever the body of DECL is output,
1192 and cgraph_node::get (ALIAS) transparently
1193 returns cgraph_node::get (DECL). */
1194 static cgraph_node * create_same_body_alias (tree alias, tree decl);
1196 /* Verify whole cgraph structure. */
1197 static void DEBUG_FUNCTION verify_cgraph_nodes (void);
1199 /* Worker to bring NODE local. */
1200 static bool make_local (cgraph_node *node, void *);
1202 /* Mark ALIAS as an alias to DECL. DECL_NODE is cgraph node representing
1203 the function body is associated
1204 with (not necessarily cgraph_node (DECL). */
1205 static cgraph_node *create_alias (tree alias, tree target);
1207 /* Return true if NODE has thunk. */
1208 static bool has_thunk_p (cgraph_node *node, void *);
1210 cgraph_edge *callees;
1211 cgraph_edge *callers;
1212 /* List of edges representing indirect calls with a yet undetermined
1213 callee. */
1214 cgraph_edge *indirect_calls;
1215 /* For nested functions points to function the node is nested in. */
1216 cgraph_node *origin;
1217 /* Points to first nested function, if any. */
1218 cgraph_node *nested;
1219 /* Pointer to the next function with same origin, if any. */
1220 cgraph_node *next_nested;
1221 /* Pointer to the next clone. */
1222 cgraph_node *next_sibling_clone;
1223 cgraph_node *prev_sibling_clone;
1224 cgraph_node *clones;
1225 cgraph_node *clone_of;
1226 /* If instrumentation_clone is 1 then instrumented_version points
1227 to the original function used to make instrumented version.
1228 Otherwise points to instrumented version of the function. */
1229 cgraph_node *instrumented_version;
1230 /* If instrumentation_clone is 1 then orig_decl is the original
1231 function declaration. */
1232 tree orig_decl;
1233 /* For functions with many calls sites it holds map from call expression
1234 to the edge to speed up cgraph_edge function. */
1235 hash_table<cgraph_edge_hasher> *GTY(()) call_site_hash;
1236 /* Declaration node used to be clone of. */
1237 tree former_clone_of;
1239 /* If this is a SIMD clone, this points to the SIMD specific
1240 information for it. */
1241 cgraph_simd_clone *simdclone;
1242 /* If this function has SIMD clones, this points to the first clone. */
1243 cgraph_node *simd_clones;
1245 /* Interprocedural passes scheduled to have their transform functions
1246 applied next time we execute local pass on them. We maintain it
1247 per-function in order to allow IPA passes to introduce new functions. */
1248 vec<ipa_opt_pass> GTY((skip)) ipa_transforms_to_apply;
1250 cgraph_local_info local;
1251 cgraph_global_info global;
1252 struct cgraph_rtl_info *rtl;
1253 cgraph_clone_info clone;
1254 cgraph_thunk_info thunk;
1256 /* Expected number of executions: calculated in profile.c. */
1257 gcov_type count;
1258 /* How to scale counts at materialization time; used to merge
1259 LTO units with different number of profile runs. */
1260 int count_materialization_scale;
1261 /* Unique id of the node. */
1262 int uid;
1263 /* Summary unique id of the node. */
1264 int summary_uid;
1265 /* ID assigned by the profiling. */
1266 unsigned int profile_id;
1267 /* Time profiler: first run of function. */
1268 int tp_first_run;
1270 /* Set when decl is an abstract function pointed to by the
1271 ABSTRACT_DECL_ORIGIN of a reachable function. */
1272 unsigned used_as_abstract_origin : 1;
1273 /* Set once the function is lowered (i.e. its CFG is built). */
1274 unsigned lowered : 1;
1275 /* Set once the function has been instantiated and its callee
1276 lists created. */
1277 unsigned process : 1;
1278 /* How commonly executed the node is. Initialized during branch
1279 probabilities pass. */
1280 ENUM_BITFIELD (node_frequency) frequency : 2;
1281 /* True when function can only be called at startup (from static ctor). */
1282 unsigned only_called_at_startup : 1;
1283 /* True when function can only be called at startup (from static dtor). */
1284 unsigned only_called_at_exit : 1;
1285 /* True when function is the transactional clone of a function which
1286 is called only from inside transactions. */
1287 /* ?? We should be able to remove this. We have enough bits in
1288 cgraph to calculate it. */
1289 unsigned tm_clone : 1;
1290 /* True if this decl is a dispatcher for function versions. */
1291 unsigned dispatcher_function : 1;
1292 /* True if this decl calls a COMDAT-local function. This is set up in
1293 compute_inline_parameters and inline_call. */
1294 unsigned calls_comdat_local : 1;
1295 /* True if node has been created by merge operation in IPA-ICF. */
1296 unsigned icf_merged: 1;
1297 /* True when function is clone created for Pointer Bounds Checker
1298 instrumentation. */
1299 unsigned instrumentation_clone : 1;
1300 /* True if call to node can't result in a call to free, munmap or
1301 other operation that could make previously non-trapping memory
1302 accesses trapping. */
1303 unsigned nonfreeing_fn : 1;
1304 /* True if there was multiple COMDAT bodies merged by lto-symtab. */
1305 unsigned merged : 1;
1306 /* True if function was created to be executed in parallel. */
1307 unsigned parallelized_function : 1;
1308 /* True if function is part split out by ipa-split. */
1309 unsigned split_part : 1;
1311 private:
1312 /* Worker for call_for_symbol_and_aliases. */
1313 bool call_for_symbol_and_aliases_1 (bool (*callback) (cgraph_node *,
1314 void *),
1315 void *data, bool include_overwritable);
1318 /* A cgraph node set is a collection of cgraph nodes. A cgraph node
1319 can appear in multiple sets. */
1320 struct cgraph_node_set_def
1322 hash_map<cgraph_node *, size_t> *map;
1323 vec<cgraph_node *> nodes;
1326 typedef cgraph_node_set_def *cgraph_node_set;
1327 typedef struct varpool_node_set_def *varpool_node_set;
1329 class varpool_node;
1331 /* A varpool node set is a collection of varpool nodes. A varpool node
1332 can appear in multiple sets. */
1333 struct varpool_node_set_def
1335 hash_map<varpool_node *, size_t> * map;
1336 vec<varpool_node *> nodes;
1339 /* Iterator structure for cgraph node sets. */
1340 struct cgraph_node_set_iterator
1342 cgraph_node_set set;
1343 unsigned index;
1346 /* Iterator structure for varpool node sets. */
1347 struct varpool_node_set_iterator
1349 varpool_node_set set;
1350 unsigned index;
1353 /* Context of polymorphic call. It represent information about the type of
1354 instance that may reach the call. This is used by ipa-devirt walkers of the
1355 type inheritance graph. */
1357 class GTY(()) ipa_polymorphic_call_context {
1358 public:
1359 /* The called object appears in an object of type OUTER_TYPE
1360 at offset OFFSET. When information is not 100% reliable, we
1361 use SPECULATIVE_OUTER_TYPE and SPECULATIVE_OFFSET. */
1362 HOST_WIDE_INT offset;
1363 HOST_WIDE_INT speculative_offset;
1364 tree outer_type;
1365 tree speculative_outer_type;
1366 /* True if outer object may be in construction or destruction. */
1367 unsigned maybe_in_construction : 1;
1368 /* True if outer object may be of derived type. */
1369 unsigned maybe_derived_type : 1;
1370 /* True if speculative outer object may be of derived type. We always
1371 speculate that construction does not happen. */
1372 unsigned speculative_maybe_derived_type : 1;
1373 /* True if the context is invalid and all calls should be redirected
1374 to BUILTIN_UNREACHABLE. */
1375 unsigned invalid : 1;
1376 /* True if the outer type is dynamic. */
1377 unsigned dynamic : 1;
1379 /* Build empty "I know nothing" context. */
1380 ipa_polymorphic_call_context ();
1381 /* Build polymorphic call context for indirect call E. */
1382 ipa_polymorphic_call_context (cgraph_edge *e);
1383 /* Build polymorphic call context for IP invariant CST.
1384 If specified, OTR_TYPE specify the type of polymorphic call
1385 that takes CST+OFFSET as a prameter. */
1386 ipa_polymorphic_call_context (tree cst, tree otr_type = NULL,
1387 HOST_WIDE_INT offset = 0);
1388 /* Build context for pointer REF contained in FNDECL at statement STMT.
1389 if INSTANCE is non-NULL, return pointer to the object described by
1390 the context. */
1391 ipa_polymorphic_call_context (tree fndecl, tree ref, gimple stmt,
1392 tree *instance = NULL);
1394 /* Look for vtable stores or constructor calls to work out dynamic type
1395 of memory location. */
1396 bool get_dynamic_type (tree, tree, tree, gimple);
1398 /* Make context non-speculative. */
1399 void clear_speculation ();
1401 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
1402 NULL, the context is set to dummy "I know nothing" setting. */
1403 void clear_outer_type (tree otr_type = NULL);
1405 /* Walk container types and modify context to point to actual class
1406 containing OTR_TYPE (if non-NULL) as base class.
1407 Return true if resulting context is valid.
1409 When CONSIDER_PLACEMENT_NEW is false, reject contexts that may be made
1410 valid only via alocation of new polymorphic type inside by means
1411 of placement new.
1413 When CONSIDER_BASES is false, only look for actual fields, not base types
1414 of TYPE. */
1415 bool restrict_to_inner_class (tree otr_type,
1416 bool consider_placement_new = true,
1417 bool consider_bases = true);
1419 /* Adjust all offsets in contexts by given number of bits. */
1420 void offset_by (HOST_WIDE_INT);
1421 /* Use when we can not track dynamic type change. This speculatively assume
1422 type change is not happening. */
1423 void possible_dynamic_type_change (bool, tree otr_type = NULL);
1424 /* Assume that both THIS and a given context is valid and strenghten THIS
1425 if possible. Return true if any strenghtening was made.
1426 If actual type the context is being used in is known, OTR_TYPE should be
1427 set accordingly. This improves quality of combined result. */
1428 bool combine_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1429 bool meet_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1431 /* Return TRUE if context is fully useless. */
1432 bool useless_p () const;
1433 /* Return TRUE if this context conveys the same information as X. */
1434 bool equal_to (const ipa_polymorphic_call_context &x) const;
1436 /* Dump human readable context to F. If NEWLINE is true, it will be
1437 terminated by a newline. */
1438 void dump (FILE *f, bool newline = true) const;
1439 void DEBUG_FUNCTION debug () const;
1441 /* LTO streaming. */
1442 void stream_out (struct output_block *) const;
1443 void stream_in (struct lto_input_block *, struct data_in *data_in);
1445 private:
1446 bool combine_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1447 bool meet_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1448 void set_by_decl (tree, HOST_WIDE_INT);
1449 bool set_by_invariant (tree, tree, HOST_WIDE_INT);
1450 bool speculation_consistent_p (tree, HOST_WIDE_INT, bool, tree) const;
1451 void make_speculative (tree otr_type = NULL);
1454 /* Structure containing additional information about an indirect call. */
1456 struct GTY(()) cgraph_indirect_call_info
1458 /* When agg_content is set, an offset where the call pointer is located
1459 within the aggregate. */
1460 HOST_WIDE_INT offset;
1461 /* Context of the polymorphic call; use only when POLYMORPHIC flag is set. */
1462 ipa_polymorphic_call_context context;
1463 /* OBJ_TYPE_REF_TOKEN of a polymorphic call (if polymorphic is set). */
1464 HOST_WIDE_INT otr_token;
1465 /* Type of the object from OBJ_TYPE_REF_OBJECT. */
1466 tree otr_type;
1467 /* Index of the parameter that is called. */
1468 int param_index;
1469 /* ECF flags determined from the caller. */
1470 int ecf_flags;
1471 /* Profile_id of common target obtrained from profile. */
1472 int common_target_id;
1473 /* Probability that call will land in function with COMMON_TARGET_ID. */
1474 int common_target_probability;
1476 /* Set when the call is a virtual call with the parameter being the
1477 associated object pointer rather than a simple direct call. */
1478 unsigned polymorphic : 1;
1479 /* Set when the call is a call of a pointer loaded from contents of an
1480 aggregate at offset. */
1481 unsigned agg_contents : 1;
1482 /* Set when this is a call through a member pointer. */
1483 unsigned member_ptr : 1;
1484 /* When the previous bit is set, this one determines whether the destination
1485 is loaded from a parameter passed by reference. */
1486 unsigned by_ref : 1;
1487 /* For polymorphic calls this specify whether the virtual table pointer
1488 may have changed in between function entry and the call. */
1489 unsigned vptr_changed : 1;
1492 struct GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller"),
1493 for_user)) cgraph_edge {
1494 friend class cgraph_node;
1496 /* Remove the edge in the cgraph. */
1497 void remove (void);
1499 /* Change field call_stmt of edge to NEW_STMT.
1500 If UPDATE_SPECULATIVE and E is any component of speculative
1501 edge, then update all components. */
1502 void set_call_stmt (gcall *new_stmt, bool update_speculative = true);
1504 /* Redirect callee of the edge to N. The function does not update underlying
1505 call expression. */
1506 void redirect_callee (cgraph_node *n);
1508 /* If the edge does not lead to a thunk, simply redirect it to N. Otherwise
1509 create one or more equivalent thunks for N and redirect E to the first in
1510 the chain. Note that it is then necessary to call
1511 n->expand_all_artificial_thunks once all callers are redirected. */
1512 void redirect_callee_duplicating_thunks (cgraph_node *n);
1514 /* Make an indirect edge with an unknown callee an ordinary edge leading to
1515 CALLEE. DELTA is an integer constant that is to be added to the this
1516 pointer (first parameter) to compensate for skipping
1517 a thunk adjustment. */
1518 cgraph_edge *make_direct (cgraph_node *callee);
1520 /* Turn edge into speculative call calling N2. Update
1521 the profile so the direct call is taken COUNT times
1522 with FREQUENCY. */
1523 cgraph_edge *make_speculative (cgraph_node *n2, gcov_type direct_count,
1524 int direct_frequency);
1526 /* Given speculative call edge, return all three components. */
1527 void speculative_call_info (cgraph_edge *&direct, cgraph_edge *&indirect,
1528 ipa_ref *&reference);
1530 /* Speculative call edge turned out to be direct call to CALLE_DECL.
1531 Remove the speculative call sequence and return edge representing the call.
1532 It is up to caller to redirect the call as appropriate. */
1533 cgraph_edge *resolve_speculation (tree callee_decl = NULL);
1535 /* If necessary, change the function declaration in the call statement
1536 associated with the edge so that it corresponds to the edge callee. */
1537 gimple redirect_call_stmt_to_callee (void);
1539 /* Create clone of edge in the node N represented
1540 by CALL_EXPR the callgraph. */
1541 cgraph_edge * clone (cgraph_node *n, gcall *call_stmt, unsigned stmt_uid,
1542 gcov_type count_scale, int freq_scale, bool update_original);
1544 /* Verify edge count and frequency. */
1545 bool verify_count_and_frequency ();
1547 /* Return true when call of edge can not lead to return from caller
1548 and thus it is safe to ignore its side effects for IPA analysis
1549 when computing side effects of the caller. */
1550 bool cannot_lead_to_return_p (void);
1552 /* Return true when the edge represents a direct recursion. */
1553 bool recursive_p (void);
1555 /* Return true if the call can be hot. */
1556 bool maybe_hot_p (void);
1558 /* Rebuild cgraph edges for current function node. This needs to be run after
1559 passes that don't update the cgraph. */
1560 static unsigned int rebuild_edges (void);
1562 /* Rebuild cgraph references for current function node. This needs to be run
1563 after passes that don't update the cgraph. */
1564 static void rebuild_references (void);
1566 /* Expected number of executions: calculated in profile.c. */
1567 gcov_type count;
1568 cgraph_node *caller;
1569 cgraph_node *callee;
1570 cgraph_edge *prev_caller;
1571 cgraph_edge *next_caller;
1572 cgraph_edge *prev_callee;
1573 cgraph_edge *next_callee;
1574 gcall *call_stmt;
1575 /* Additional information about an indirect call. Not cleared when an edge
1576 becomes direct. */
1577 cgraph_indirect_call_info *indirect_info;
1578 PTR GTY ((skip (""))) aux;
1579 /* When equal to CIF_OK, inline this call. Otherwise, points to the
1580 explanation why function was not inlined. */
1581 enum cgraph_inline_failed_t inline_failed;
1582 /* The stmt_uid of call_stmt. This is used by LTO to recover the call_stmt
1583 when the function is serialized in. */
1584 unsigned int lto_stmt_uid;
1585 /* Expected frequency of executions within the function.
1586 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
1587 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
1588 int frequency;
1589 /* Unique id of the edge. */
1590 int uid;
1591 /* Whether this edge was made direct by indirect inlining. */
1592 unsigned int indirect_inlining_edge : 1;
1593 /* Whether this edge describes an indirect call with an undetermined
1594 callee. */
1595 unsigned int indirect_unknown_callee : 1;
1596 /* Whether this edge is still a dangling */
1597 /* True if the corresponding CALL stmt cannot be inlined. */
1598 unsigned int call_stmt_cannot_inline_p : 1;
1599 /* Can this call throw externally? */
1600 unsigned int can_throw_external : 1;
1601 /* Edges with SPECULATIVE flag represents indirect calls that was
1602 speculatively turned into direct (i.e. by profile feedback).
1603 The final code sequence will have form:
1605 if (call_target == expected_fn)
1606 expected_fn ();
1607 else
1608 call_target ();
1610 Every speculative call is represented by three components attached
1611 to a same call statement:
1612 1) a direct call (to expected_fn)
1613 2) an indirect call (to call_target)
1614 3) a IPA_REF_ADDR refrence to expected_fn.
1616 Optimizers may later redirect direct call to clone, so 1) and 3)
1617 do not need to necesarily agree with destination. */
1618 unsigned int speculative : 1;
1619 /* Set to true when caller is a constructor or destructor of polymorphic
1620 type. */
1621 unsigned in_polymorphic_cdtor : 1;
1623 private:
1624 /* Remove the edge from the list of the callers of the callee. */
1625 void remove_caller (void);
1627 /* Remove the edge from the list of the callees of the caller. */
1628 void remove_callee (void);
1630 /* Set callee N of call graph edge and add it to the corresponding set of
1631 callers. */
1632 void set_callee (cgraph_node *n);
1634 /* Output flags of edge to a file F. */
1635 void dump_edge_flags (FILE *f);
1637 /* Verify that call graph edge corresponds to DECL from the associated
1638 statement. Return true if the verification should fail. */
1639 bool verify_corresponds_to_fndecl (tree decl);
1642 #define CGRAPH_FREQ_BASE 1000
1643 #define CGRAPH_FREQ_MAX 100000
1645 /* The varpool data structure.
1646 Each static variable decl has assigned varpool_node. */
1648 class GTY((tag ("SYMTAB_VARIABLE"))) varpool_node : public symtab_node {
1649 public:
1650 /* Dump given varpool node to F. */
1651 void dump (FILE *f);
1653 /* Dump given varpool node to stderr. */
1654 void DEBUG_FUNCTION debug (void);
1656 /* Remove variable from symbol table. */
1657 void remove (void);
1659 /* Remove node initializer when it is no longer needed. */
1660 void remove_initializer (void);
1662 void analyze (void);
1664 /* Return variable availability. */
1665 availability get_availability (void);
1667 /* When doing LTO, read variable's constructor from disk if
1668 it is not already present. */
1669 tree get_constructor (void);
1671 /* Return true if variable has constructor that can be used for folding. */
1672 bool ctor_useable_for_folding_p (void);
1674 /* For given variable pool node, walk the alias chain to return the function
1675 the variable is alias of. Do not walk through thunks.
1676 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
1677 inline varpool_node *ultimate_alias_target
1678 (availability *availability = NULL);
1680 /* Return node that alias is aliasing. */
1681 inline varpool_node *get_alias_target (void);
1683 /* Output one variable, if necessary. Return whether we output it. */
1684 bool assemble_decl (void);
1686 /* For variables in named sections make sure get_variable_section
1687 is called before we switch to those sections. Then section
1688 conflicts between read-only and read-only requiring relocations
1689 sections can be resolved. */
1690 void finalize_named_section_flags (void);
1692 /* Call calback on varpool symbol and aliases associated to varpool symbol.
1693 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1694 skipped. */
1695 bool call_for_symbol_and_aliases (bool (*callback) (varpool_node *, void *),
1696 void *data,
1697 bool include_overwritable);
1699 /* Return true when variable should be considered externally visible. */
1700 bool externally_visible_p (void);
1702 /* Return true when all references to variable must be visible
1703 in ipa_ref_list.
1704 i.e. if the variable is not externally visible or not used in some magic
1705 way (asm statement or such).
1706 The magic uses are all summarized in force_output flag. */
1707 inline bool all_refs_explicit_p ();
1709 /* Return true when variable can be removed from variable pool
1710 if all direct calls are eliminated. */
1711 inline bool can_remove_if_no_refs_p (void);
1713 /* Add the variable DECL to the varpool.
1714 Unlike finalize_decl function is intended to be used
1715 by middle end and allows insertion of new variable at arbitrary point
1716 of compilation. */
1717 static void add (tree decl);
1719 /* Return varpool node for given symbol and check it is a function. */
1720 static inline varpool_node *get (const_tree decl);
1722 /* Mark DECL as finalized. By finalizing the declaration, frontend instruct
1723 the middle end to output the variable to asm file, if needed or externally
1724 visible. */
1725 static void finalize_decl (tree decl);
1727 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1728 Extra name aliases are output whenever DECL is output. */
1729 static varpool_node * create_extra_name_alias (tree alias, tree decl);
1731 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1732 Extra name aliases are output whenever DECL is output. */
1733 static varpool_node * create_alias (tree, tree);
1735 /* Dump the variable pool to F. */
1736 static void dump_varpool (FILE *f);
1738 /* Dump the variable pool to stderr. */
1739 static void DEBUG_FUNCTION debug_varpool (void);
1741 /* Allocate new callgraph node and insert it into basic data structures. */
1742 static varpool_node *create_empty (void);
1744 /* Return varpool node assigned to DECL. Create new one when needed. */
1745 static varpool_node *get_create (tree decl);
1747 /* Given an assembler name, lookup node. */
1748 static varpool_node *get_for_asmname (tree asmname);
1750 /* Set when variable is scheduled to be assembled. */
1751 unsigned output : 1;
1753 /* Set when variable has statically initialized pointer
1754 or is a static bounds variable and needs initalization. */
1755 unsigned need_bounds_init : 1;
1757 /* Set if the variable is dynamically initialized, except for
1758 function local statics. */
1759 unsigned dynamically_initialized : 1;
1761 ENUM_BITFIELD(tls_model) tls_model : 3;
1763 /* Set if the variable is known to be used by single function only.
1764 This is computed by ipa_signle_use pass and used by late optimizations
1765 in places where optimization would be valid for local static variable
1766 if we did not do any inter-procedural code movement. */
1767 unsigned used_by_single_function : 1;
1769 private:
1770 /* Assemble thunks and aliases associated to varpool node. */
1771 void assemble_aliases (void);
1773 /* Worker for call_for_node_and_aliases. */
1774 bool call_for_symbol_and_aliases_1 (bool (*callback) (varpool_node *, void *),
1775 void *data,
1776 bool include_overwritable);
1779 /* Every top level asm statement is put into a asm_node. */
1781 struct GTY(()) asm_node {
1784 /* Next asm node. */
1785 asm_node *next;
1786 /* String for this asm node. */
1787 tree asm_str;
1788 /* Ordering of all cgraph nodes. */
1789 int order;
1792 /* Report whether or not THIS symtab node is a function, aka cgraph_node. */
1794 template <>
1795 template <>
1796 inline bool
1797 is_a_helper <cgraph_node *>::test (symtab_node *p)
1799 return p && p->type == SYMTAB_FUNCTION;
1802 /* Report whether or not THIS symtab node is a vriable, aka varpool_node. */
1804 template <>
1805 template <>
1806 inline bool
1807 is_a_helper <varpool_node *>::test (symtab_node *p)
1809 return p && p->type == SYMTAB_VARIABLE;
1812 /* Macros to access the next item in the list of free cgraph nodes and
1813 edges. */
1814 #define NEXT_FREE_NODE(NODE) dyn_cast<cgraph_node *> ((NODE)->next)
1815 #define SET_NEXT_FREE_NODE(NODE,NODE2) ((NODE))->next = NODE2
1816 #define NEXT_FREE_EDGE(EDGE) (EDGE)->prev_caller
1818 typedef void (*cgraph_edge_hook)(cgraph_edge *, void *);
1819 typedef void (*cgraph_node_hook)(cgraph_node *, void *);
1820 typedef void (*varpool_node_hook)(varpool_node *, void *);
1821 typedef void (*cgraph_2edge_hook)(cgraph_edge *, cgraph_edge *, void *);
1822 typedef void (*cgraph_2node_hook)(cgraph_node *, cgraph_node *, void *);
1824 struct cgraph_edge_hook_list;
1825 struct cgraph_node_hook_list;
1826 struct varpool_node_hook_list;
1827 struct cgraph_2edge_hook_list;
1828 struct cgraph_2node_hook_list;
1830 /* Map from a symbol to initialization/finalization priorities. */
1831 struct GTY(()) symbol_priority_map {
1832 priority_type init;
1833 priority_type fini;
1836 enum symtab_state
1838 /* Frontend is parsing and finalizing functions. */
1839 PARSING,
1840 /* Callgraph is being constructed. It is safe to add new functions. */
1841 CONSTRUCTION,
1842 /* Callgraph is being streamed-in at LTO time. */
1843 LTO_STREAMING,
1844 /* Callgraph is built and early IPA passes are being run. */
1845 IPA,
1846 /* Callgraph is built and all functions are transformed to SSA form. */
1847 IPA_SSA,
1848 /* All inline decisions are done; it is now possible to remove extern inline
1849 functions and virtual call targets. */
1850 IPA_SSA_AFTER_INLINING,
1851 /* Functions are now ordered and being passed to RTL expanders. */
1852 EXPANSION,
1853 /* All cgraph expansion is done. */
1854 FINISHED
1857 struct asmname_hasher
1859 typedef symtab_node *value_type;
1860 typedef const_tree compare_type;
1862 static hashval_t hash (symtab_node *n);
1863 static bool equal (symtab_node *n, const_tree t);
1864 static void ggc_mx (symtab_node *n);
1865 static void pch_nx (symtab_node *&);
1866 static void pch_nx (symtab_node *&, gt_pointer_operator, void *);
1867 static void remove (symtab_node *) {}
1870 class GTY((tag ("SYMTAB"))) symbol_table
1872 public:
1873 friend class symtab_node;
1874 friend class cgraph_node;
1875 friend class cgraph_edge;
1877 symbol_table (): cgraph_max_summary_uid (1)
1881 /* Initialize callgraph dump file. */
1882 void initialize (void);
1884 /* Register a top-level asm statement ASM_STR. */
1885 inline asm_node *finalize_toplevel_asm (tree asm_str);
1887 /* Analyze the whole compilation unit once it is parsed completely. */
1888 void finalize_compilation_unit (void);
1890 /* C++ frontend produce same body aliases all over the place, even before PCH
1891 gets streamed out. It relies on us linking the aliases with their function
1892 in order to do the fixups, but ipa-ref is not PCH safe. Consequentely we
1893 first produce aliases without links, but once C++ FE is sure he won't sream
1894 PCH we build the links via this function. */
1895 void process_same_body_aliases (void);
1897 /* Perform simple optimizations based on callgraph. */
1898 void compile (void);
1900 /* Process CGRAPH_NEW_FUNCTIONS and perform actions necessary to add these
1901 functions into callgraph in a way so they look like ordinary reachable
1902 functions inserted into callgraph already at construction time. */
1903 void process_new_functions (void);
1905 /* Once all functions from compilation unit are in memory, produce all clones
1906 and update all calls. We might also do this on demand if we don't want to
1907 bring all functions to memory prior compilation, but current WHOPR
1908 implementation does that and it is is bit easier to keep everything right
1909 in this order. */
1910 void materialize_all_clones (void);
1912 /* Register a symbol NODE. */
1913 inline void register_symbol (symtab_node *node);
1915 inline void
1916 clear_asm_symbols (void)
1918 asmnodes = NULL;
1919 asm_last_node = NULL;
1922 /* Perform reachability analysis and reclaim all unreachable nodes. */
1923 bool remove_unreachable_nodes (FILE *file);
1925 /* Optimization of function bodies might've rendered some variables as
1926 unnecessary so we want to avoid these from being compiled. Re-do
1927 reachability starting from variables that are either externally visible
1928 or was referred from the asm output routines. */
1929 void remove_unreferenced_decls (void);
1931 /* Unregister a symbol NODE. */
1932 inline void unregister (symtab_node *node);
1934 /* Allocate new callgraph node and insert it into basic data structures. */
1935 cgraph_node *create_empty (void);
1937 /* Release a callgraph NODE with UID and put in to the list
1938 of free nodes. */
1939 void release_symbol (cgraph_node *node, int uid);
1941 /* Output all variables enqueued to be assembled. */
1942 bool output_variables (void);
1944 /* Weakrefs may be associated to external decls and thus not output
1945 at expansion time. Emit all necessary aliases. */
1946 void output_weakrefs (void);
1948 /* Return first static symbol with definition. */
1949 inline symtab_node *first_symbol (void);
1951 /* Return first assembler symbol. */
1952 inline asm_node *
1953 first_asm_symbol (void)
1955 return asmnodes;
1958 /* Return first static symbol with definition. */
1959 inline symtab_node *first_defined_symbol (void);
1961 /* Return first variable. */
1962 inline varpool_node *first_variable (void);
1964 /* Return next variable after NODE. */
1965 inline varpool_node *next_variable (varpool_node *node);
1967 /* Return first static variable with initializer. */
1968 inline varpool_node *first_static_initializer (void);
1970 /* Return next static variable with initializer after NODE. */
1971 inline varpool_node *next_static_initializer (varpool_node *node);
1973 /* Return first static variable with definition. */
1974 inline varpool_node *first_defined_variable (void);
1976 /* Return next static variable with definition after NODE. */
1977 inline varpool_node *next_defined_variable (varpool_node *node);
1979 /* Return first function with body defined. */
1980 inline cgraph_node *first_defined_function (void);
1982 /* Return next function with body defined after NODE. */
1983 inline cgraph_node *next_defined_function (cgraph_node *node);
1985 /* Return first function. */
1986 inline cgraph_node *first_function (void);
1988 /* Return next function. */
1989 inline cgraph_node *next_function (cgraph_node *node);
1991 /* Return first function with body defined. */
1992 cgraph_node *first_function_with_gimple_body (void);
1994 /* Return next reachable static variable with initializer after NODE. */
1995 inline cgraph_node *next_function_with_gimple_body (cgraph_node *node);
1997 /* Register HOOK to be called with DATA on each removed edge. */
1998 cgraph_edge_hook_list *add_edge_removal_hook (cgraph_edge_hook hook,
1999 void *data);
2001 /* Remove ENTRY from the list of hooks called on removing edges. */
2002 void remove_edge_removal_hook (cgraph_edge_hook_list *entry);
2004 /* Register HOOK to be called with DATA on each removed node. */
2005 cgraph_node_hook_list *add_cgraph_removal_hook (cgraph_node_hook hook,
2006 void *data);
2008 /* Remove ENTRY from the list of hooks called on removing nodes. */
2009 void remove_cgraph_removal_hook (cgraph_node_hook_list *entry);
2011 /* Register HOOK to be called with DATA on each removed node. */
2012 varpool_node_hook_list *add_varpool_removal_hook (varpool_node_hook hook,
2013 void *data);
2015 /* Remove ENTRY from the list of hooks called on removing nodes. */
2016 void remove_varpool_removal_hook (varpool_node_hook_list *entry);
2018 /* Register HOOK to be called with DATA on each inserted node. */
2019 cgraph_node_hook_list *add_cgraph_insertion_hook (cgraph_node_hook hook,
2020 void *data);
2022 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2023 void remove_cgraph_insertion_hook (cgraph_node_hook_list *entry);
2025 /* Register HOOK to be called with DATA on each inserted node. */
2026 varpool_node_hook_list *add_varpool_insertion_hook (varpool_node_hook hook,
2027 void *data);
2029 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2030 void remove_varpool_insertion_hook (varpool_node_hook_list *entry);
2032 /* Register HOOK to be called with DATA on each duplicated edge. */
2033 cgraph_2edge_hook_list *add_edge_duplication_hook (cgraph_2edge_hook hook,
2034 void *data);
2035 /* Remove ENTRY from the list of hooks called on duplicating edges. */
2036 void remove_edge_duplication_hook (cgraph_2edge_hook_list *entry);
2038 /* Register HOOK to be called with DATA on each duplicated node. */
2039 cgraph_2node_hook_list *add_cgraph_duplication_hook (cgraph_2node_hook hook,
2040 void *data);
2042 /* Remove ENTRY from the list of hooks called on duplicating nodes. */
2043 void remove_cgraph_duplication_hook (cgraph_2node_hook_list *entry);
2045 /* Call all edge removal hooks. */
2046 void call_edge_removal_hooks (cgraph_edge *e);
2048 /* Call all node insertion hooks. */
2049 void call_cgraph_insertion_hooks (cgraph_node *node);
2051 /* Call all node removal hooks. */
2052 void call_cgraph_removal_hooks (cgraph_node *node);
2054 /* Call all node duplication hooks. */
2055 void call_cgraph_duplication_hooks (cgraph_node *node, cgraph_node *node2);
2057 /* Call all edge duplication hooks. */
2058 void call_edge_duplication_hooks (cgraph_edge *cs1, cgraph_edge *cs2);
2060 /* Call all node removal hooks. */
2061 void call_varpool_removal_hooks (varpool_node *node);
2063 /* Call all node insertion hooks. */
2064 void call_varpool_insertion_hooks (varpool_node *node);
2066 /* Arrange node to be first in its entry of assembler_name_hash. */
2067 void symtab_prevail_in_asm_name_hash (symtab_node *node);
2069 /* Initalize asm name hash unless. */
2070 void symtab_initialize_asm_name_hash (void);
2072 /* Set the DECL_ASSEMBLER_NAME and update symtab hashtables. */
2073 void change_decl_assembler_name (tree decl, tree name);
2075 int cgraph_count;
2076 int cgraph_max_uid;
2077 int cgraph_max_summary_uid;
2079 int edges_count;
2080 int edges_max_uid;
2082 symtab_node* GTY(()) nodes;
2083 asm_node* GTY(()) asmnodes;
2084 asm_node* GTY(()) asm_last_node;
2085 cgraph_node* GTY(()) free_nodes;
2087 /* Head of a linked list of unused (freed) call graph edges.
2088 Do not GTY((delete)) this list so UIDs gets reliably recycled. */
2089 cgraph_edge * GTY(()) free_edges;
2091 /* The order index of the next symtab node to be created. This is
2092 used so that we can sort the cgraph nodes in order by when we saw
2093 them, to support -fno-toplevel-reorder. */
2094 int order;
2096 /* Set when whole unit has been analyzed so we can access global info. */
2097 bool global_info_ready;
2098 /* What state callgraph is in right now. */
2099 enum symtab_state state;
2100 /* Set when the cgraph is fully build and the basic flags are computed. */
2101 bool function_flags_ready;
2103 bool cpp_implicit_aliases_done;
2105 /* Hash table used to hold sectoons. */
2106 hash_table<section_name_hasher> *GTY(()) section_hash;
2108 /* Hash table used to convert assembler names into nodes. */
2109 hash_table<asmname_hasher> *assembler_name_hash;
2111 /* Hash table used to hold init priorities. */
2112 hash_map<symtab_node *, symbol_priority_map> *init_priority_hash;
2114 FILE* GTY ((skip)) dump_file;
2116 private:
2117 /* Allocate new callgraph node. */
2118 inline cgraph_node * allocate_cgraph_symbol (void);
2120 /* Allocate a cgraph_edge structure and fill it with data according to the
2121 parameters of which only CALLEE can be NULL (when creating an indirect call
2122 edge). */
2123 cgraph_edge *create_edge (cgraph_node *caller, cgraph_node *callee,
2124 gcall *call_stmt, gcov_type count, int freq,
2125 bool indir_unknown_callee);
2127 /* Put the edge onto the free list. */
2128 void free_edge (cgraph_edge *e);
2130 /* Insert NODE to assembler name hash. */
2131 void insert_to_assembler_name_hash (symtab_node *node, bool with_clones);
2133 /* Remove NODE from assembler name hash. */
2134 void unlink_from_assembler_name_hash (symtab_node *node, bool with_clones);
2136 /* Hash asmnames ignoring the user specified marks. */
2137 static hashval_t decl_assembler_name_hash (const_tree asmname);
2139 /* Compare ASMNAME with the DECL_ASSEMBLER_NAME of DECL. */
2140 static bool decl_assembler_name_equal (tree decl, const_tree asmname);
2142 friend struct asmname_hasher;
2144 /* List of hooks triggered when an edge is removed. */
2145 cgraph_edge_hook_list * GTY((skip)) m_first_edge_removal_hook;
2146 /* List of hooks triggem_red when a cgraph node is removed. */
2147 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_removal_hook;
2148 /* List of hooks triggered when an edge is duplicated. */
2149 cgraph_2edge_hook_list * GTY((skip)) m_first_edge_duplicated_hook;
2150 /* List of hooks triggered when a node is duplicated. */
2151 cgraph_2node_hook_list * GTY((skip)) m_first_cgraph_duplicated_hook;
2152 /* List of hooks triggered when an function is inserted. */
2153 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_insertion_hook;
2154 /* List of hooks triggered when an variable is inserted. */
2155 varpool_node_hook_list * GTY((skip)) m_first_varpool_insertion_hook;
2156 /* List of hooks triggered when a node is removed. */
2157 varpool_node_hook_list * GTY((skip)) m_first_varpool_removal_hook;
2160 extern GTY(()) symbol_table *symtab;
2162 extern vec<cgraph_node *> cgraph_new_nodes;
2164 inline hashval_t
2165 asmname_hasher::hash (symtab_node *n)
2167 return symbol_table::decl_assembler_name_hash
2168 (DECL_ASSEMBLER_NAME (n->decl));
2171 inline bool
2172 asmname_hasher::equal (symtab_node *n, const_tree t)
2174 return symbol_table::decl_assembler_name_equal (n->decl, t);
2177 extern void gt_ggc_mx (symtab_node *&);
2179 inline void
2180 asmname_hasher::ggc_mx (symtab_node *n)
2182 gt_ggc_mx (n);
2185 extern void gt_pch_nx (symtab_node *&);
2187 inline void
2188 asmname_hasher::pch_nx (symtab_node *&n)
2190 gt_pch_nx (n);
2193 inline void
2194 asmname_hasher::pch_nx (symtab_node *&n, gt_pointer_operator op, void *cookie)
2196 op (&n, cookie);
2199 /* In cgraph.c */
2200 void cgraph_c_finalize (void);
2201 void release_function_body (tree);
2202 cgraph_indirect_call_info *cgraph_allocate_init_indirect_info (void);
2204 void cgraph_update_edges_for_call_stmt (gimple, tree, gimple);
2205 bool cgraph_function_possibly_inlined_p (tree);
2207 const char* cgraph_inline_failed_string (cgraph_inline_failed_t);
2208 cgraph_inline_failed_type_t cgraph_inline_failed_type (cgraph_inline_failed_t);
2210 extern bool gimple_check_call_matching_types (gimple, tree, bool);
2212 /* In cgraphunit.c */
2213 void cgraphunit_c_finalize (void);
2215 /* Initialize datastructures so DECL is a function in lowered gimple form.
2216 IN_SSA is true if the gimple is in SSA. */
2217 basic_block init_lowered_empty_function (tree, bool, gcov_type);
2219 /* In cgraphclones.c */
2221 tree clone_function_name_1 (const char *, const char *);
2222 tree clone_function_name (tree decl, const char *);
2224 void tree_function_versioning (tree, tree, vec<ipa_replace_map *, va_gc> *,
2225 bool, bitmap, bool, bitmap, basic_block);
2227 /* In cgraphbuild.c */
2228 int compute_call_stmt_bb_frequency (tree, basic_block bb);
2229 void record_references_in_initializer (tree, bool);
2231 /* In ipa.c */
2232 void cgraph_build_static_cdtor (char which, tree body, int priority);
2233 bool ipa_discover_readonly_nonaddressable_vars (void);
2235 /* In varpool.c */
2236 tree ctor_for_folding (tree);
2238 /* In tree-chkp.c */
2239 extern bool chkp_function_instrumented_p (tree fndecl);
2241 /* Return true when the symbol is real symbol, i.e. it is not inline clone
2242 or abstract function kept for debug info purposes only. */
2243 inline bool
2244 symtab_node::real_symbol_p (void)
2246 cgraph_node *cnode;
2248 if (DECL_ABSTRACT_P (decl))
2249 return false;
2250 if (!is_a <cgraph_node *> (this))
2251 return true;
2252 cnode = dyn_cast <cgraph_node *> (this);
2253 if (cnode->global.inlined_to)
2254 return false;
2255 return true;
2258 /* Return true if DECL should have entry in symbol table if used.
2259 Those are functions and static & external veriables*/
2261 static inline bool
2262 decl_in_symtab_p (const_tree decl)
2264 return (TREE_CODE (decl) == FUNCTION_DECL
2265 || (TREE_CODE (decl) == VAR_DECL
2266 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl))));
2269 inline bool
2270 symtab_node::in_same_comdat_group_p (symtab_node *target)
2272 symtab_node *source = this;
2274 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2276 if (cn->global.inlined_to)
2277 source = cn->global.inlined_to;
2279 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2281 if (cn->global.inlined_to)
2282 target = cn->global.inlined_to;
2285 return source->get_comdat_group () == target->get_comdat_group ();
2288 /* Return node that alias is aliasing. */
2290 inline symtab_node *
2291 symtab_node::get_alias_target (void)
2293 ipa_ref *ref = NULL;
2294 iterate_reference (0, ref);
2295 if (ref->use == IPA_REF_CHKP)
2296 iterate_reference (1, ref);
2297 gcc_checking_assert (ref->use == IPA_REF_ALIAS);
2298 return ref->referred;
2301 /* Return next reachable static symbol with initializer after the node. */
2303 inline symtab_node *
2304 symtab_node::next_defined_symbol (void)
2306 symtab_node *node1 = next;
2308 for (; node1; node1 = node1->next)
2309 if (node1->definition)
2310 return node1;
2312 return NULL;
2315 /* Iterates I-th reference in the list, REF is also set. */
2317 inline ipa_ref *
2318 symtab_node::iterate_reference (unsigned i, ipa_ref *&ref)
2320 vec_safe_iterate (ref_list.references, i, &ref);
2322 return ref;
2325 /* Iterates I-th referring item in the list, REF is also set. */
2327 inline ipa_ref *
2328 symtab_node::iterate_referring (unsigned i, ipa_ref *&ref)
2330 ref_list.referring.iterate (i, &ref);
2332 return ref;
2335 /* Iterates I-th referring alias item in the list, REF is also set. */
2337 inline ipa_ref *
2338 symtab_node::iterate_direct_aliases (unsigned i, ipa_ref *&ref)
2340 ref_list.referring.iterate (i, &ref);
2342 if (ref && ref->use != IPA_REF_ALIAS)
2343 return NULL;
2345 return ref;
2348 /* Return true if list contains an alias. */
2350 inline bool
2351 symtab_node::has_aliases_p (void)
2353 ipa_ref *ref = NULL;
2355 return (iterate_direct_aliases (0, ref) != NULL);
2358 /* Return true when RESOLUTION indicate that linker will use
2359 the symbol from non-LTO object files. */
2361 inline bool
2362 resolution_used_from_other_file_p (enum ld_plugin_symbol_resolution resolution)
2364 return (resolution == LDPR_PREVAILING_DEF
2365 || resolution == LDPR_PREEMPTED_REG
2366 || resolution == LDPR_RESOLVED_EXEC
2367 || resolution == LDPR_RESOLVED_DYN);
2370 /* Return true when symtab_node is known to be used from other (non-LTO)
2371 object file. Known only when doing LTO via linker plugin. */
2373 inline bool
2374 symtab_node::used_from_object_file_p (void)
2376 if (!TREE_PUBLIC (decl) || DECL_EXTERNAL (decl))
2377 return false;
2378 if (resolution_used_from_other_file_p (resolution))
2379 return true;
2380 return false;
2383 /* Return varpool node for given symbol and check it is a function. */
2385 inline varpool_node *
2386 varpool_node::get (const_tree decl)
2388 gcc_checking_assert (TREE_CODE (decl) == VAR_DECL);
2389 return dyn_cast<varpool_node *> (symtab_node::get (decl));
2392 /* Register a symbol NODE. */
2394 inline void
2395 symbol_table::register_symbol (symtab_node *node)
2397 node->next = nodes;
2398 node->previous = NULL;
2400 if (nodes)
2401 nodes->previous = node;
2402 nodes = node;
2404 node->order = order++;
2407 /* Register a top-level asm statement ASM_STR. */
2409 asm_node *
2410 symbol_table::finalize_toplevel_asm (tree asm_str)
2412 asm_node *node;
2414 node = ggc_cleared_alloc<asm_node> ();
2415 node->asm_str = asm_str;
2416 node->order = order++;
2417 node->next = NULL;
2419 if (asmnodes == NULL)
2420 asmnodes = node;
2421 else
2422 asm_last_node->next = node;
2424 asm_last_node = node;
2425 return node;
2428 /* Unregister a symbol NODE. */
2429 inline void
2430 symbol_table::unregister (symtab_node *node)
2432 if (node->previous)
2433 node->previous->next = node->next;
2434 else
2435 nodes = node->next;
2437 if (node->next)
2438 node->next->previous = node->previous;
2440 node->next = NULL;
2441 node->previous = NULL;
2444 /* Release a callgraph NODE with UID and put in to the list of free nodes. */
2446 inline void
2447 symbol_table::release_symbol (cgraph_node *node, int uid)
2449 cgraph_count--;
2451 /* Clear out the node to NULL all pointers and add the node to the free
2452 list. */
2453 memset (node, 0, sizeof (*node));
2454 node->type = SYMTAB_FUNCTION;
2455 node->uid = uid;
2456 SET_NEXT_FREE_NODE (node, free_nodes);
2457 free_nodes = node;
2460 /* Allocate new callgraph node. */
2462 inline cgraph_node *
2463 symbol_table::allocate_cgraph_symbol (void)
2465 cgraph_node *node;
2467 if (free_nodes)
2469 node = free_nodes;
2470 free_nodes = NEXT_FREE_NODE (node);
2472 else
2474 node = ggc_cleared_alloc<cgraph_node> ();
2475 node->uid = cgraph_max_uid++;
2478 node->summary_uid = cgraph_max_summary_uid++;
2479 return node;
2483 /* Return first static symbol with definition. */
2484 inline symtab_node *
2485 symbol_table::first_symbol (void)
2487 return nodes;
2490 /* Walk all symbols. */
2491 #define FOR_EACH_SYMBOL(node) \
2492 for ((node) = symtab->first_symbol (); (node); (node) = (node)->next)
2494 /* Return first static symbol with definition. */
2495 inline symtab_node *
2496 symbol_table::first_defined_symbol (void)
2498 symtab_node *node;
2500 for (node = nodes; node; node = node->next)
2501 if (node->definition)
2502 return node;
2504 return NULL;
2507 /* Walk all symbols with definitions in current unit. */
2508 #define FOR_EACH_DEFINED_SYMBOL(node) \
2509 for ((node) = symtab->first_defined_symbol (); (node); \
2510 (node) = node->next_defined_symbol ())
2512 /* Return first variable. */
2513 inline varpool_node *
2514 symbol_table::first_variable (void)
2516 symtab_node *node;
2517 for (node = nodes; node; node = node->next)
2518 if (varpool_node *vnode = dyn_cast <varpool_node *> (node))
2519 return vnode;
2520 return NULL;
2523 /* Return next variable after NODE. */
2524 inline varpool_node *
2525 symbol_table::next_variable (varpool_node *node)
2527 symtab_node *node1 = node->next;
2528 for (; node1; node1 = node1->next)
2529 if (varpool_node *vnode1 = dyn_cast <varpool_node *> (node1))
2530 return vnode1;
2531 return NULL;
2533 /* Walk all variables. */
2534 #define FOR_EACH_VARIABLE(node) \
2535 for ((node) = symtab->first_variable (); \
2536 (node); \
2537 (node) = symtab->next_variable ((node)))
2539 /* Return first static variable with initializer. */
2540 inline varpool_node *
2541 symbol_table::first_static_initializer (void)
2543 symtab_node *node;
2544 for (node = nodes; node; node = node->next)
2546 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2547 if (vnode && DECL_INITIAL (node->decl))
2548 return vnode;
2550 return NULL;
2553 /* Return next static variable with initializer after NODE. */
2554 inline varpool_node *
2555 symbol_table::next_static_initializer (varpool_node *node)
2557 symtab_node *node1 = node->next;
2558 for (; node1; node1 = node1->next)
2560 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2561 if (vnode1 && DECL_INITIAL (node1->decl))
2562 return vnode1;
2564 return NULL;
2567 /* Walk all static variables with initializer set. */
2568 #define FOR_EACH_STATIC_INITIALIZER(node) \
2569 for ((node) = symtab->first_static_initializer (); (node); \
2570 (node) = symtab->next_static_initializer (node))
2572 /* Return first static variable with definition. */
2573 inline varpool_node *
2574 symbol_table::first_defined_variable (void)
2576 symtab_node *node;
2577 for (node = nodes; node; node = node->next)
2579 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2580 if (vnode && vnode->definition)
2581 return vnode;
2583 return NULL;
2586 /* Return next static variable with definition after NODE. */
2587 inline varpool_node *
2588 symbol_table::next_defined_variable (varpool_node *node)
2590 symtab_node *node1 = node->next;
2591 for (; node1; node1 = node1->next)
2593 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2594 if (vnode1 && vnode1->definition)
2595 return vnode1;
2597 return NULL;
2599 /* Walk all variables with definitions in current unit. */
2600 #define FOR_EACH_DEFINED_VARIABLE(node) \
2601 for ((node) = symtab->first_defined_variable (); (node); \
2602 (node) = symtab->next_defined_variable (node))
2604 /* Return first function with body defined. */
2605 inline cgraph_node *
2606 symbol_table::first_defined_function (void)
2608 symtab_node *node;
2609 for (node = nodes; node; node = node->next)
2611 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2612 if (cn && cn->definition)
2613 return cn;
2615 return NULL;
2618 /* Return next function with body defined after NODE. */
2619 inline cgraph_node *
2620 symbol_table::next_defined_function (cgraph_node *node)
2622 symtab_node *node1 = node->next;
2623 for (; node1; node1 = node1->next)
2625 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2626 if (cn1 && cn1->definition)
2627 return cn1;
2629 return NULL;
2632 /* Walk all functions with body defined. */
2633 #define FOR_EACH_DEFINED_FUNCTION(node) \
2634 for ((node) = symtab->first_defined_function (); (node); \
2635 (node) = symtab->next_defined_function ((node)))
2637 /* Return first function. */
2638 inline cgraph_node *
2639 symbol_table::first_function (void)
2641 symtab_node *node;
2642 for (node = nodes; node; node = node->next)
2643 if (cgraph_node *cn = dyn_cast <cgraph_node *> (node))
2644 return cn;
2645 return NULL;
2648 /* Return next function. */
2649 inline cgraph_node *
2650 symbol_table::next_function (cgraph_node *node)
2652 symtab_node *node1 = node->next;
2653 for (; node1; node1 = node1->next)
2654 if (cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1))
2655 return cn1;
2656 return NULL;
2659 /* Return first function with body defined. */
2660 inline cgraph_node *
2661 symbol_table::first_function_with_gimple_body (void)
2663 symtab_node *node;
2664 for (node = nodes; node; node = node->next)
2666 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2667 if (cn && cn->has_gimple_body_p ())
2668 return cn;
2670 return NULL;
2673 /* Return next reachable static variable with initializer after NODE. */
2674 inline cgraph_node *
2675 symbol_table::next_function_with_gimple_body (cgraph_node *node)
2677 symtab_node *node1 = node->next;
2678 for (; node1; node1 = node1->next)
2680 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2681 if (cn1 && cn1->has_gimple_body_p ())
2682 return cn1;
2684 return NULL;
2687 /* Walk all functions. */
2688 #define FOR_EACH_FUNCTION(node) \
2689 for ((node) = symtab->first_function (); (node); \
2690 (node) = symtab->next_function ((node)))
2692 /* Return true when callgraph node is a function with Gimple body defined
2693 in current unit. Functions can also be define externally or they
2694 can be thunks with no Gimple representation.
2696 Note that at WPA stage, the function body may not be present in memory. */
2698 inline bool
2699 cgraph_node::has_gimple_body_p (void)
2701 return definition && !thunk.thunk_p && !alias;
2704 /* Walk all functions with body defined. */
2705 #define FOR_EACH_FUNCTION_WITH_GIMPLE_BODY(node) \
2706 for ((node) = symtab->first_function_with_gimple_body (); (node); \
2707 (node) = symtab->next_function_with_gimple_body (node))
2709 /* Uniquize all constants that appear in memory.
2710 Each constant in memory thus far output is recorded
2711 in `const_desc_table'. */
2713 struct GTY((for_user)) constant_descriptor_tree {
2714 /* A MEM for the constant. */
2715 rtx rtl;
2717 /* The value of the constant. */
2718 tree value;
2720 /* Hash of value. Computing the hash from value each time
2721 hashfn is called can't work properly, as that means recursive
2722 use of the hash table during hash table expansion. */
2723 hashval_t hash;
2726 /* Return true when function is only called directly or it has alias.
2727 i.e. it is not externally visible, address was not taken and
2728 it is not used in any other non-standard way. */
2730 inline bool
2731 cgraph_node::only_called_directly_or_aliased_p (void)
2733 gcc_assert (!global.inlined_to);
2734 return (!force_output && !address_taken
2735 && !used_from_other_partition
2736 && !DECL_VIRTUAL_P (decl)
2737 && !DECL_STATIC_CONSTRUCTOR (decl)
2738 && !DECL_STATIC_DESTRUCTOR (decl)
2739 && !used_from_object_file_p ()
2740 && !externally_visible);
2743 /* Return true when function can be removed from callgraph
2744 if all direct calls are eliminated. */
2746 inline bool
2747 cgraph_node::can_remove_if_no_direct_calls_and_refs_p (void)
2749 gcc_checking_assert (!global.inlined_to);
2750 /* Instrumentation clones should not be removed before
2751 instrumentation happens. New callers may appear after
2752 instrumentation. */
2753 if (instrumentation_clone
2754 && !chkp_function_instrumented_p (decl))
2755 return false;
2756 /* Extern inlines can always go, we will use the external definition. */
2757 if (DECL_EXTERNAL (decl))
2758 return true;
2759 /* When function is needed, we can not remove it. */
2760 if (force_output || used_from_other_partition)
2761 return false;
2762 if (DECL_STATIC_CONSTRUCTOR (decl)
2763 || DECL_STATIC_DESTRUCTOR (decl))
2764 return false;
2765 /* Only COMDAT functions can be removed if externally visible. */
2766 if (externally_visible
2767 && (!DECL_COMDAT (decl)
2768 || forced_by_abi
2769 || used_from_object_file_p ()))
2770 return false;
2771 return true;
2774 /* Return true when variable can be removed from variable pool
2775 if all direct calls are eliminated. */
2777 inline bool
2778 varpool_node::can_remove_if_no_refs_p (void)
2780 if (DECL_EXTERNAL (decl))
2781 return true;
2782 return (!force_output && !used_from_other_partition
2783 && ((DECL_COMDAT (decl)
2784 && !forced_by_abi
2785 && !used_from_object_file_p ())
2786 || !externally_visible
2787 || DECL_HAS_VALUE_EXPR_P (decl)));
2790 /* Return true when all references to variable must be visible in ipa_ref_list.
2791 i.e. if the variable is not externally visible or not used in some magic
2792 way (asm statement or such).
2793 The magic uses are all summarized in force_output flag. */
2795 inline bool
2796 varpool_node::all_refs_explicit_p ()
2798 return (definition
2799 && !externally_visible
2800 && !used_from_other_partition
2801 && !force_output);
2804 struct tree_descriptor_hasher : ggc_hasher<constant_descriptor_tree *>
2806 static hashval_t hash (constant_descriptor_tree *);
2807 static bool equal (constant_descriptor_tree *, constant_descriptor_tree *);
2810 /* Constant pool accessor function. */
2811 hash_table<tree_descriptor_hasher> *constant_pool_htab (void);
2813 /* Return node that alias is aliasing. */
2815 inline cgraph_node *
2816 cgraph_node::get_alias_target (void)
2818 return dyn_cast <cgraph_node *> (symtab_node::get_alias_target ());
2821 /* Return node that alias is aliasing. */
2823 inline varpool_node *
2824 varpool_node::get_alias_target (void)
2826 return dyn_cast <varpool_node *> (symtab_node::get_alias_target ());
2829 /* Walk the alias chain to return the symbol NODE is alias of.
2830 If NODE is not an alias, return NODE.
2831 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2833 inline symtab_node *
2834 symtab_node::ultimate_alias_target (enum availability *availability)
2836 if (!alias)
2838 if (availability)
2839 *availability = get_availability ();
2840 return this;
2843 return ultimate_alias_target_1 (availability);
2846 /* Given function symbol, walk the alias chain to return the function node
2847 is alias of. Do not walk through thunks.
2848 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2850 inline cgraph_node *
2851 cgraph_node::ultimate_alias_target (enum availability *availability)
2853 cgraph_node *n = dyn_cast <cgraph_node *>
2854 (symtab_node::ultimate_alias_target (availability));
2855 if (!n && availability)
2856 *availability = AVAIL_NOT_AVAILABLE;
2857 return n;
2860 /* For given variable pool node, walk the alias chain to return the function
2861 the variable is alias of. Do not walk through thunks.
2862 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2864 inline varpool_node *
2865 varpool_node::ultimate_alias_target (availability *availability)
2867 varpool_node *n = dyn_cast <varpool_node *>
2868 (symtab_node::ultimate_alias_target (availability));
2870 if (!n && availability)
2871 *availability = AVAIL_NOT_AVAILABLE;
2872 return n;
2875 /* Set callee N of call graph edge and add it to the corresponding set of
2876 callers. */
2878 inline void
2879 cgraph_edge::set_callee (cgraph_node *n)
2881 prev_caller = NULL;
2882 if (n->callers)
2883 n->callers->prev_caller = this;
2884 next_caller = n->callers;
2885 n->callers = this;
2886 callee = n;
2889 /* Redirect callee of the edge to N. The function does not update underlying
2890 call expression. */
2892 inline void
2893 cgraph_edge::redirect_callee (cgraph_node *n)
2895 /* Remove from callers list of the current callee. */
2896 remove_callee ();
2898 /* Insert to callers list of the new callee. */
2899 set_callee (n);
2902 /* Return true when the edge represents a direct recursion. */
2904 inline bool
2905 cgraph_edge::recursive_p (void)
2907 cgraph_node *c = callee->ultimate_alias_target ();
2908 if (caller->global.inlined_to)
2909 return caller->global.inlined_to->decl == c->decl;
2910 else
2911 return caller->decl == c->decl;
2914 /* Remove the edge from the list of the callers of the callee. */
2916 inline void
2917 cgraph_edge::remove_callee (void)
2919 gcc_assert (!indirect_unknown_callee);
2920 if (prev_caller)
2921 prev_caller->next_caller = next_caller;
2922 if (next_caller)
2923 next_caller->prev_caller = prev_caller;
2924 if (!prev_caller)
2925 callee->callers = next_caller;
2928 /* Return true if the TM_CLONE bit is set for a given FNDECL. */
2929 static inline bool
2930 decl_is_tm_clone (const_tree fndecl)
2932 cgraph_node *n = cgraph_node::get (fndecl);
2933 if (n)
2934 return n->tm_clone;
2935 return false;
2938 /* Likewise indicate that a node is needed, i.e. reachable via some
2939 external means. */
2941 inline void
2942 cgraph_node::mark_force_output (void)
2944 force_output = 1;
2945 gcc_checking_assert (!global.inlined_to);
2948 /* Return true if function should be optimized for size. */
2950 inline bool
2951 cgraph_node::optimize_for_size_p (void)
2953 if (opt_for_fn (decl, optimize_size))
2954 return true;
2955 if (frequency == NODE_FREQUENCY_UNLIKELY_EXECUTED)
2956 return true;
2957 else
2958 return false;
2961 /* Return symtab_node for NODE or create one if it is not present
2962 in symtab. */
2964 inline symtab_node *
2965 symtab_node::get_create (tree node)
2967 if (TREE_CODE (node) == VAR_DECL)
2968 return varpool_node::get_create (node);
2969 else
2970 return cgraph_node::get_create (node);
2973 /* Return availability of NODE. */
2975 inline enum availability
2976 symtab_node::get_availability (void)
2978 if (is_a <cgraph_node *> (this))
2979 return dyn_cast <cgraph_node *> (this)->get_availability ();
2980 else
2981 return dyn_cast <varpool_node *> (this)->get_availability ();
2984 /* Call calback on symtab node and aliases associated to this node.
2985 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
2986 skipped. */
2988 inline bool
2989 symtab_node::call_for_symbol_and_aliases (bool (*callback) (symtab_node *,
2990 void *),
2991 void *data,
2992 bool include_overwritable)
2994 if (callback (this, data))
2995 return true;
2996 if (has_aliases_p ())
2997 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
2998 return false;
3001 /* Call callback on function and aliases associated to the function.
3002 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
3003 skipped. */
3005 inline bool
3006 cgraph_node::call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
3007 void *),
3008 void *data,
3009 bool include_overwritable)
3011 if (callback (this, data))
3012 return true;
3013 if (has_aliases_p ())
3014 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3015 return false;
3018 /* Call calback on varpool symbol and aliases associated to varpool symbol.
3019 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
3020 skipped. */
3022 inline bool
3023 varpool_node::call_for_symbol_and_aliases (bool (*callback) (varpool_node *,
3024 void *),
3025 void *data,
3026 bool include_overwritable)
3028 if (callback (this, data))
3029 return true;
3030 if (has_aliases_p ())
3031 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3032 return false;
3035 /* Return true if NODE's address can be compared. */
3037 inline bool
3038 symtab_node::address_can_be_compared_p ()
3040 /* Address of virtual tables and functions is never compared. */
3041 if (DECL_VIRTUAL_P (decl))
3042 return false;
3043 /* Address of C++ cdtors is never compared. */
3044 if (is_a <cgraph_node *> (this)
3045 && (DECL_CXX_CONSTRUCTOR_P (decl)
3046 || DECL_CXX_DESTRUCTOR_P (decl)))
3047 return false;
3048 /* Constant pool symbols addresses are never compared.
3049 flag_merge_constants permits us to assume the same on readonly vars. */
3050 if (is_a <varpool_node *> (this)
3051 && (DECL_IN_CONSTANT_POOL (decl)
3052 || (flag_merge_constants >= 2
3053 && TREE_READONLY (decl) && !TREE_THIS_VOLATILE (decl))))
3054 return false;
3055 return true;
3058 /* Return true if refernece may be used in address compare. */
3060 inline bool
3061 ipa_ref::address_matters_p ()
3063 if (use != IPA_REF_ADDR)
3064 return false;
3065 /* Addresses taken from virtual tables are never compared. */
3066 if (is_a <varpool_node *> (referring)
3067 && DECL_VIRTUAL_P (referring->decl))
3068 return false;
3069 return referred->address_can_be_compared_p ();
3072 /* Build polymorphic call context for indirect call E. */
3074 inline
3075 ipa_polymorphic_call_context::ipa_polymorphic_call_context (cgraph_edge *e)
3077 gcc_checking_assert (e->indirect_info->polymorphic);
3078 *this = e->indirect_info->context;
3081 /* Build empty "I know nothing" context. */
3083 inline
3084 ipa_polymorphic_call_context::ipa_polymorphic_call_context ()
3086 clear_speculation ();
3087 clear_outer_type ();
3088 invalid = false;
3091 /* Make context non-speculative. */
3093 inline void
3094 ipa_polymorphic_call_context::clear_speculation ()
3096 speculative_outer_type = NULL;
3097 speculative_offset = 0;
3098 speculative_maybe_derived_type = false;
3101 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
3102 NULL, the context is set to dummy "I know nothing" setting. */
3104 inline void
3105 ipa_polymorphic_call_context::clear_outer_type (tree otr_type)
3107 outer_type = otr_type ? TYPE_MAIN_VARIANT (otr_type) : NULL;
3108 offset = 0;
3109 maybe_derived_type = true;
3110 maybe_in_construction = true;
3111 dynamic = true;
3114 /* Adjust all offsets in contexts by OFF bits. */
3116 inline void
3117 ipa_polymorphic_call_context::offset_by (HOST_WIDE_INT off)
3119 if (outer_type)
3120 offset += off;
3121 if (speculative_outer_type)
3122 speculative_offset += off;
3125 /* Return TRUE if context is fully useless. */
3127 inline bool
3128 ipa_polymorphic_call_context::useless_p () const
3130 return (!outer_type && !speculative_outer_type);
3133 /* Return true if NODE is local. Instrumentation clones are counted as local
3134 only when original function is local. */
3136 static inline bool
3137 cgraph_local_p (cgraph_node *node)
3139 if (!node->instrumentation_clone || !node->instrumented_version)
3140 return node->local.local;
3142 return node->local.local && node->instrumented_version->local.local;
3145 /* When using fprintf (or similar), problems can arise with
3146 transient generated strings. Many string-generation APIs
3147 only support one result being alive at once (e.g. by
3148 returning a pointer to a statically-allocated buffer).
3150 If there is more than one generated string within one
3151 fprintf call: the first string gets evicted or overwritten
3152 by the second, before fprintf is fully evaluated.
3153 See e.g. PR/53136.
3155 This function provides a workaround for this, by providing
3156 a simple way to create copies of these transient strings,
3157 without the need to have explicit cleanup:
3159 fprintf (dumpfile, "string 1: %s string 2:%s\n",
3160 xstrdup_for_dump (EXPR_1),
3161 xstrdup_for_dump (EXPR_2));
3163 This is actually a simple wrapper around ggc_strdup, but
3164 the name documents the intent. We require that no GC can occur
3165 within the fprintf call. */
3167 static inline const char *
3168 xstrdup_for_dump (const char *transient_str)
3170 return ggc_strdup (transient_str);
3173 #endif /* GCC_CGRAPH_H */