PR target/65871
[official-gcc.git] / gcc / cgraph.h
blob108cc801c6eb05ffccf3b1e938d7ec79e4b4f03b
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 (void);
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 /* Information about the function that is propagated by the RTL backend.
617 Available only for functions that has been already assembled. */
619 struct GTY(()) cgraph_rtl_info {
620 unsigned int preferred_incoming_stack_boundary;
622 /* Call unsaved hard registers really used by the corresponding
623 function (including ones used by functions called by the
624 function). */
625 HARD_REG_SET function_used_regs;
626 /* Set if function_used_regs is valid. */
627 unsigned function_used_regs_valid: 1;
630 /* Represent which DECL tree (or reference to such tree)
631 will be replaced by another tree while versioning. */
632 struct GTY(()) ipa_replace_map
634 /* The tree that will be replaced. */
635 tree old_tree;
636 /* The new (replacing) tree. */
637 tree new_tree;
638 /* Parameter number to replace, when old_tree is NULL. */
639 int parm_num;
640 /* True when a substitution should be done, false otherwise. */
641 bool replace_p;
642 /* True when we replace a reference to old_tree. */
643 bool ref_p;
646 struct GTY(()) cgraph_clone_info
648 vec<ipa_replace_map *, va_gc> *tree_map;
649 bitmap args_to_skip;
650 bitmap combined_args_to_skip;
653 enum cgraph_simd_clone_arg_type
655 SIMD_CLONE_ARG_TYPE_VECTOR,
656 SIMD_CLONE_ARG_TYPE_UNIFORM,
657 SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP,
658 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP,
659 SIMD_CLONE_ARG_TYPE_MASK
662 /* Function arguments in the original function of a SIMD clone.
663 Supplementary data for `struct simd_clone'. */
665 struct GTY(()) cgraph_simd_clone_arg {
666 /* Original function argument as it originally existed in
667 DECL_ARGUMENTS. */
668 tree orig_arg;
670 /* orig_arg's function (or for extern functions type from
671 TYPE_ARG_TYPES). */
672 tree orig_type;
674 /* If argument is a vector, this holds the vector version of
675 orig_arg that after adjusting the argument types will live in
676 DECL_ARGUMENTS. Otherwise, this is NULL.
678 This basically holds:
679 vector(simdlen) __typeof__(orig_arg) new_arg. */
680 tree vector_arg;
682 /* vector_arg's type (or for extern functions new vector type. */
683 tree vector_type;
685 /* If argument is a vector, this holds the array where the simd
686 argument is held while executing the simd clone function. This
687 is a local variable in the cloned function. Its content is
688 copied from vector_arg upon entry to the clone.
690 This basically holds:
691 __typeof__(orig_arg) simd_array[simdlen]. */
692 tree simd_array;
694 /* A SIMD clone's argument can be either linear (constant or
695 variable), uniform, or vector. */
696 enum cgraph_simd_clone_arg_type arg_type;
698 /* For arg_type SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP this is
699 the constant linear step, if arg_type is
700 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP, this is index of
701 the uniform argument holding the step, otherwise 0. */
702 HOST_WIDE_INT linear_step;
704 /* Variable alignment if available, otherwise 0. */
705 unsigned int alignment;
708 /* Specific data for a SIMD function clone. */
710 struct GTY(()) cgraph_simd_clone {
711 /* Number of words in the SIMD lane associated with this clone. */
712 unsigned int simdlen;
714 /* Number of annotated function arguments in `args'. This is
715 usually the number of named arguments in FNDECL. */
716 unsigned int nargs;
718 /* Max hardware vector size in bits for integral vectors. */
719 unsigned int vecsize_int;
721 /* Max hardware vector size in bits for floating point vectors. */
722 unsigned int vecsize_float;
724 /* The mangling character for a given vector size. This is is used
725 to determine the ISA mangling bit as specified in the Intel
726 Vector ABI. */
727 unsigned char vecsize_mangle;
729 /* True if this is the masked, in-branch version of the clone,
730 otherwise false. */
731 unsigned int inbranch : 1;
733 /* True if this is a Cilk Plus variant. */
734 unsigned int cilk_elemental : 1;
736 /* Doubly linked list of SIMD clones. */
737 cgraph_node *prev_clone, *next_clone;
739 /* Original cgraph node the SIMD clones were created for. */
740 cgraph_node *origin;
742 /* Annotated function arguments for the original function. */
743 cgraph_simd_clone_arg GTY((length ("%h.nargs"))) args[1];
746 /* Function Multiversioning info. */
747 struct GTY((for_user)) cgraph_function_version_info {
748 /* The cgraph_node for which the function version info is stored. */
749 cgraph_node *this_node;
750 /* Chains all the semantically identical function versions. The
751 first function in this chain is the version_info node of the
752 default function. */
753 cgraph_function_version_info *prev;
754 /* If this version node corresponds to a dispatcher for function
755 versions, this points to the version info node of the default
756 function, the first node in the chain. */
757 cgraph_function_version_info *next;
758 /* If this node corresponds to a function version, this points
759 to the dispatcher function decl, which is the function that must
760 be called to execute the right function version at run-time.
762 If this cgraph node is a dispatcher (if dispatcher_function is
763 true, in the cgraph_node struct) for function versions, this
764 points to resolver function, which holds the function body of the
765 dispatcher. The dispatcher decl is an alias to the resolver
766 function decl. */
767 tree dispatcher_resolver;
770 #define DEFCIFCODE(code, type, string) CIF_ ## code,
771 /* Reasons for inlining failures. */
773 enum cgraph_inline_failed_t {
774 #include "cif-code.def"
775 CIF_N_REASONS
778 enum cgraph_inline_failed_type_t
780 CIF_FINAL_NORMAL = 0,
781 CIF_FINAL_ERROR
784 struct cgraph_edge;
786 struct cgraph_edge_hasher : ggc_hasher<cgraph_edge *>
788 typedef gimple compare_type;
790 static hashval_t hash (cgraph_edge *);
791 static hashval_t hash (gimple);
792 static bool equal (cgraph_edge *, gimple);
795 /* The cgraph data structure.
796 Each function decl has assigned cgraph_node listing callees and callers. */
798 struct GTY((tag ("SYMTAB_FUNCTION"))) cgraph_node : public symtab_node {
799 public:
800 /* Remove the node from cgraph and all inline clones inlined into it.
801 Skip however removal of FORBIDDEN_NODE and return true if it needs to be
802 removed. This allows to call the function from outer loop walking clone
803 tree. */
804 bool remove_symbol_and_inline_clones (cgraph_node *forbidden_node = NULL);
806 /* Record all references from cgraph_node that are taken
807 in statement STMT. */
808 void record_stmt_references (gimple stmt);
810 /* Like cgraph_set_call_stmt but walk the clone tree and update all
811 clones sharing the same function body.
812 When WHOLE_SPECULATIVE_EDGES is true, all three components of
813 speculative edge gets updated. Otherwise we update only direct
814 call. */
815 void set_call_stmt_including_clones (gimple old_stmt, gcall *new_stmt,
816 bool update_speculative = true);
818 /* Walk the alias chain to return the function cgraph_node is alias of.
819 Walk through thunk, too.
820 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
821 cgraph_node *function_symbol (enum availability *avail = NULL);
823 /* Walk the alias chain to return the function cgraph_node is alias of.
824 Walk through non virtual thunks, too. Thus we return either a function
825 or a virtual thunk node.
826 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
827 cgraph_node *function_or_virtual_thunk_symbol
828 (enum availability *avail = NULL);
830 /* Create node representing clone of N executed COUNT times. Decrease
831 the execution counts from original node too.
832 The new clone will have decl set to DECL that may or may not be the same
833 as decl of N.
835 When UPDATE_ORIGINAL is true, the counts are subtracted from the original
836 function's profile to reflect the fact that part of execution is handled
837 by node.
838 When CALL_DUPLICATOIN_HOOK is true, the ipa passes are acknowledged about
839 the new clone. Otherwise the caller is responsible for doing so later.
841 If the new node is being inlined into another one, NEW_INLINED_TO should be
842 the outline function the new one is (even indirectly) inlined to.
843 All hooks will see this in node's global.inlined_to, when invoked.
844 Can be NULL if the node is not inlined. */
845 cgraph_node *create_clone (tree decl, gcov_type count, int freq,
846 bool update_original,
847 vec<cgraph_edge *> redirect_callers,
848 bool call_duplication_hook,
849 cgraph_node *new_inlined_to,
850 bitmap args_to_skip);
852 /* Create callgraph node clone with new declaration. The actual body will
853 be copied later at compilation stage. */
854 cgraph_node *create_virtual_clone (vec<cgraph_edge *> redirect_callers,
855 vec<ipa_replace_map *, va_gc> *tree_map,
856 bitmap args_to_skip, const char * suffix);
858 /* cgraph node being removed from symbol table; see if its entry can be
859 replaced by other inline clone. */
860 cgraph_node *find_replacement (void);
862 /* Create a new cgraph node which is the new version of
863 callgraph node. REDIRECT_CALLERS holds the callers
864 edges which should be redirected to point to
865 NEW_VERSION. ALL the callees edges of the node
866 are cloned to the new version node. Return the new
867 version node.
869 If non-NULL BLOCK_TO_COPY determine what basic blocks
870 was copied to prevent duplications of calls that are dead
871 in the clone. */
873 cgraph_node *create_version_clone (tree new_decl,
874 vec<cgraph_edge *> redirect_callers,
875 bitmap bbs_to_copy);
877 /* Perform function versioning.
878 Function versioning includes copying of the tree and
879 a callgraph update (creating a new cgraph node and updating
880 its callees and callers).
882 REDIRECT_CALLERS varray includes the edges to be redirected
883 to the new version.
885 TREE_MAP is a mapping of tree nodes we want to replace with
886 new ones (according to results of prior analysis).
888 If non-NULL ARGS_TO_SKIP determine function parameters to remove
889 from new version.
890 If SKIP_RETURN is true, the new version will return void.
891 If non-NULL BLOCK_TO_COPY determine what basic blocks to copy.
892 If non_NULL NEW_ENTRY determine new entry BB of the clone.
894 Return the new version's cgraph node. */
895 cgraph_node *create_version_clone_with_body
896 (vec<cgraph_edge *> redirect_callers,
897 vec<ipa_replace_map *, va_gc> *tree_map, bitmap args_to_skip,
898 bool skip_return, bitmap bbs_to_copy, basic_block new_entry_block,
899 const char *clone_name);
901 /* Insert a new cgraph_function_version_info node into cgraph_fnver_htab
902 corresponding to cgraph_node. */
903 cgraph_function_version_info *insert_new_function_version (void);
905 /* Get the cgraph_function_version_info node corresponding to node. */
906 cgraph_function_version_info *function_version (void);
908 /* Discover all functions and variables that are trivially needed, analyze
909 them as well as all functions and variables referred by them */
910 void analyze (void);
912 /* Add thunk alias into callgraph. The alias declaration is ALIAS and it
913 aliases DECL with an adjustments made into the first parameter.
914 See comments in thunk_adjust for detail on the parameters. */
915 cgraph_node * create_thunk (tree alias, tree, bool this_adjusting,
916 HOST_WIDE_INT fixed_offset,
917 HOST_WIDE_INT virtual_value,
918 tree virtual_offset,
919 tree real_alias);
922 /* Return node that alias is aliasing. */
923 inline cgraph_node *get_alias_target (void);
925 /* Given function symbol, walk the alias chain to return the function node
926 is alias of. Do not walk through thunks.
927 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
929 cgraph_node *ultimate_alias_target (availability *availability = NULL);
931 /* Expand thunk NODE to gimple if possible.
932 When FORCE_GIMPLE_THUNK is true, gimple thunk is created and
933 no assembler is produced.
934 When OUTPUT_ASM_THUNK is true, also produce assembler for
935 thunks that are not lowered. */
936 bool expand_thunk (bool output_asm_thunks, bool force_gimple_thunk);
938 /* Call expand_thunk on all callers that are thunks and analyze those
939 nodes that were expanded. */
940 void expand_all_artificial_thunks ();
942 /* Assemble thunks and aliases associated to node. */
943 void assemble_thunks_and_aliases (void);
945 /* Expand function specified by node. */
946 void expand (void);
948 /* As an GCC extension we allow redefinition of the function. The
949 semantics when both copies of bodies differ is not well defined.
950 We replace the old body with new body so in unit at a time mode
951 we always use new body, while in normal mode we may end up with
952 old body inlined into some functions and new body expanded and
953 inlined in others. */
954 void reset (void);
956 /* Creates a wrapper from cgraph_node to TARGET node. Thunk is used for this
957 kind of wrapper method. */
958 void create_wrapper (cgraph_node *target);
960 /* Verify cgraph nodes of the cgraph node. */
961 void DEBUG_FUNCTION verify_node (void);
963 /* Remove function from symbol table. */
964 void remove (void);
966 /* Dump call graph node to file F. */
967 void dump (FILE *f);
969 /* Dump call graph node to stderr. */
970 void DEBUG_FUNCTION debug (void);
972 /* When doing LTO, read cgraph_node's body from disk if it is not already
973 present. */
974 bool get_untransformed_body (void);
976 /* Prepare function body. When doing LTO, read cgraph_node's body from disk
977 if it is not already present. When some IPA transformations are scheduled,
978 apply them. */
979 bool get_body (void);
981 /* Release memory used to represent body of function.
982 Use this only for functions that are released before being translated to
983 target code (i.e. RTL). Functions that are compiled to RTL and beyond
984 are free'd in final.c via free_after_compilation(). */
985 void release_body (bool keep_arguments = false);
987 /* Return the DECL_STRUCT_FUNCTION of the function. */
988 struct function *get_fun (void);
990 /* cgraph_node is no longer nested function; update cgraph accordingly. */
991 void unnest (void);
993 /* Bring cgraph node local. */
994 void make_local (void);
996 /* Likewise indicate that a node is having address taken. */
997 void mark_address_taken (void);
999 /* Set fialization priority to PRIORITY. */
1000 void set_fini_priority (priority_type priority);
1002 /* Return the finalization priority. */
1003 priority_type get_fini_priority (void);
1005 /* Create edge from a given function to CALLEE in the cgraph. */
1006 cgraph_edge *create_edge (cgraph_node *callee,
1007 gcall *call_stmt, gcov_type count,
1008 int freq);
1010 /* Create an indirect edge with a yet-undetermined callee where the call
1011 statement destination is a formal parameter of the caller with index
1012 PARAM_INDEX. */
1013 cgraph_edge *create_indirect_edge (gcall *call_stmt, int ecf_flags,
1014 gcov_type count, int freq,
1015 bool compute_indirect_info = true);
1017 /* Like cgraph_create_edge walk the clone tree and update all clones sharing
1018 same function body. If clones already have edge for OLD_STMT; only
1019 update the edge same way as cgraph_set_call_stmt_including_clones does. */
1020 void create_edge_including_clones (cgraph_node *callee,
1021 gimple old_stmt, gcall *stmt,
1022 gcov_type count,
1023 int freq,
1024 cgraph_inline_failed_t reason);
1026 /* Return the callgraph edge representing the GIMPLE_CALL statement
1027 CALL_STMT. */
1028 cgraph_edge *get_edge (gimple call_stmt);
1030 /* Collect all callers of cgraph_node and its aliases that are known to lead
1031 to NODE (i.e. are not overwritable). */
1032 vec<cgraph_edge *> collect_callers (void);
1034 /* Remove all callers from the node. */
1035 void remove_callers (void);
1037 /* Remove all callees from the node. */
1038 void remove_callees (void);
1040 /* Return function availability. See cgraph.h for description of individual
1041 return values. */
1042 enum availability get_availability (void);
1044 /* Set TREE_NOTHROW on cgraph_node's decl and on aliases of the node
1045 if any to NOTHROW. */
1046 void set_nothrow_flag (bool nothrow);
1048 /* Set TREE_READONLY on cgraph_node's decl and on aliases of the node
1049 if any to READONLY. */
1050 void set_const_flag (bool readonly, bool looping);
1052 /* Set DECL_PURE_P on cgraph_node's decl and on aliases of the node
1053 if any to PURE. */
1054 void set_pure_flag (bool pure, bool looping);
1056 /* Call callback on function and aliases associated to the function.
1057 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1058 skipped. */
1060 bool call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
1061 void *),
1062 void *data, bool include_overwritable);
1064 /* Call callback on cgraph_node, thunks and aliases associated to NODE.
1065 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1066 skipped. When EXCLUDE_VIRTUAL_THUNKS is true, virtual thunks are
1067 skipped. */
1068 bool call_for_symbol_thunks_and_aliases (bool (*callback) (cgraph_node *node,
1069 void *data),
1070 void *data,
1071 bool include_overwritable,
1072 bool exclude_virtual_thunks = false);
1074 /* Likewise indicate that a node is needed, i.e. reachable via some
1075 external means. */
1076 inline void mark_force_output (void);
1078 /* Return true when function can be marked local. */
1079 bool local_p (void);
1081 /* Return true if cgraph_node can be made local for API change.
1082 Extern inline functions and C++ COMDAT functions can be made local
1083 at the expense of possible code size growth if function is used in multiple
1084 compilation units. */
1085 bool can_be_local_p (void);
1087 /* Return true when cgraph_node can not return or throw and thus
1088 it is safe to ignore its side effects for IPA analysis. */
1089 bool cannot_return_p (void);
1091 /* Return true when function cgraph_node and all its aliases are only called
1092 directly.
1093 i.e. it is not externally visible, address was not taken and
1094 it is not used in any other non-standard way. */
1095 bool only_called_directly_p (void);
1097 /* Return true when function is only called directly or it has alias.
1098 i.e. it is not externally visible, address was not taken and
1099 it is not used in any other non-standard way. */
1100 inline bool only_called_directly_or_aliased_p (void);
1102 /* Return true when function cgraph_node can be expected to be removed
1103 from program when direct calls in this compilation unit are removed.
1105 As a special case COMDAT functions are
1106 cgraph_can_remove_if_no_direct_calls_p while the are not
1107 cgraph_only_called_directly_p (it is possible they are called from other
1108 unit)
1110 This function behaves as cgraph_only_called_directly_p because eliminating
1111 all uses of COMDAT function does not make it necessarily disappear from
1112 the program unless we are compiling whole program or we do LTO. In this
1113 case we know we win since dynamic linking will not really discard the
1114 linkonce section.
1116 If WILL_INLINE is true, assume that function will be inlined into all the
1117 direct calls. */
1118 bool will_be_removed_from_program_if_no_direct_calls_p
1119 (bool will_inline = false);
1121 /* Return true when function can be removed from callgraph
1122 if all direct calls and references are eliminated. The function does
1123 not take into account comdat groups. */
1124 bool can_remove_if_no_direct_calls_and_refs_p (void);
1126 /* Return true when function cgraph_node and its aliases can be removed from
1127 callgraph if all direct calls are eliminated.
1128 If WILL_INLINE is true, assume that function will be inlined into all the
1129 direct calls. */
1130 bool can_remove_if_no_direct_calls_p (bool will_inline = false);
1132 /* Return true when callgraph node is a function with Gimple body defined
1133 in current unit. Functions can also be define externally or they
1134 can be thunks with no Gimple representation.
1136 Note that at WPA stage, the function body may not be present in memory. */
1137 inline bool has_gimple_body_p (void);
1139 /* Return true if function should be optimized for size. */
1140 bool optimize_for_size_p (void);
1142 /* Dump the callgraph to file F. */
1143 static void dump_cgraph (FILE *f);
1145 /* Dump the call graph to stderr. */
1146 static inline
1147 void debug_cgraph (void)
1149 dump_cgraph (stderr);
1152 /* Record that DECL1 and DECL2 are semantically identical function
1153 versions. */
1154 static void record_function_versions (tree decl1, tree decl2);
1156 /* Remove the cgraph_function_version_info and cgraph_node for DECL. This
1157 DECL is a duplicate declaration. */
1158 static void delete_function_version (tree decl);
1160 /* Add the function FNDECL to the call graph.
1161 Unlike finalize_function, this function is intended to be used
1162 by middle end and allows insertion of new function at arbitrary point
1163 of compilation. The function can be either in high, low or SSA form
1164 GIMPLE.
1166 The function is assumed to be reachable and have address taken (so no
1167 API breaking optimizations are performed on it).
1169 Main work done by this function is to enqueue the function for later
1170 processing to avoid need the passes to be re-entrant. */
1171 static void add_new_function (tree fndecl, bool lowered);
1173 /* Return callgraph node for given symbol and check it is a function. */
1174 static inline cgraph_node *get (const_tree decl)
1176 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL);
1177 return dyn_cast <cgraph_node *> (symtab_node::get (decl));
1180 /* DECL has been parsed. Take it, queue it, compile it at the whim of the
1181 logic in effect. If NO_COLLECT is true, then our caller cannot stand to
1182 have the garbage collector run at the moment. We would need to either
1183 create a new GC context, or just not compile right now. */
1184 static void finalize_function (tree, bool);
1186 /* Return cgraph node assigned to DECL. Create new one when needed. */
1187 static cgraph_node * create (tree decl);
1189 /* Try to find a call graph node for declaration DECL and if it does not
1190 exist or if it corresponds to an inline clone, create a new one. */
1191 static cgraph_node * get_create (tree);
1193 /* Return local info for the compiled function. */
1194 static cgraph_local_info *local_info (tree decl);
1196 /* Return local info for the compiled function. */
1197 static cgraph_rtl_info *rtl_info (tree);
1199 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
1200 Return NULL if there's no such node. */
1201 static cgraph_node *get_for_asmname (tree asmname);
1203 /* Attempt to mark ALIAS as an alias to DECL. Return alias node if
1204 successful and NULL otherwise.
1205 Same body aliases are output whenever the body of DECL is output,
1206 and cgraph_node::get (ALIAS) transparently
1207 returns cgraph_node::get (DECL). */
1208 static cgraph_node * create_same_body_alias (tree alias, tree decl);
1210 /* Verify whole cgraph structure. */
1211 static void DEBUG_FUNCTION verify_cgraph_nodes (void);
1213 /* Worker to bring NODE local. */
1214 static bool make_local (cgraph_node *node, void *);
1216 /* Mark ALIAS as an alias to DECL. DECL_NODE is cgraph node representing
1217 the function body is associated
1218 with (not necessarily cgraph_node (DECL). */
1219 static cgraph_node *create_alias (tree alias, tree target);
1221 /* Return true if NODE has thunk. */
1222 static bool has_thunk_p (cgraph_node *node, void *);
1224 cgraph_edge *callees;
1225 cgraph_edge *callers;
1226 /* List of edges representing indirect calls with a yet undetermined
1227 callee. */
1228 cgraph_edge *indirect_calls;
1229 /* For nested functions points to function the node is nested in. */
1230 cgraph_node *origin;
1231 /* Points to first nested function, if any. */
1232 cgraph_node *nested;
1233 /* Pointer to the next function with same origin, if any. */
1234 cgraph_node *next_nested;
1235 /* Pointer to the next clone. */
1236 cgraph_node *next_sibling_clone;
1237 cgraph_node *prev_sibling_clone;
1238 cgraph_node *clones;
1239 cgraph_node *clone_of;
1240 /* If instrumentation_clone is 1 then instrumented_version points
1241 to the original function used to make instrumented version.
1242 Otherwise points to instrumented version of the function. */
1243 cgraph_node *instrumented_version;
1244 /* If instrumentation_clone is 1 then orig_decl is the original
1245 function declaration. */
1246 tree orig_decl;
1247 /* For functions with many calls sites it holds map from call expression
1248 to the edge to speed up cgraph_edge function. */
1249 hash_table<cgraph_edge_hasher> *GTY(()) call_site_hash;
1250 /* Declaration node used to be clone of. */
1251 tree former_clone_of;
1253 /* If this is a SIMD clone, this points to the SIMD specific
1254 information for it. */
1255 cgraph_simd_clone *simdclone;
1256 /* If this function has SIMD clones, this points to the first clone. */
1257 cgraph_node *simd_clones;
1259 /* Interprocedural passes scheduled to have their transform functions
1260 applied next time we execute local pass on them. We maintain it
1261 per-function in order to allow IPA passes to introduce new functions. */
1262 vec<ipa_opt_pass> GTY((skip)) ipa_transforms_to_apply;
1264 cgraph_local_info local;
1265 cgraph_global_info global;
1266 cgraph_rtl_info rtl;
1267 cgraph_clone_info clone;
1268 cgraph_thunk_info thunk;
1270 /* Expected number of executions: calculated in profile.c. */
1271 gcov_type count;
1272 /* How to scale counts at materialization time; used to merge
1273 LTO units with different number of profile runs. */
1274 int count_materialization_scale;
1275 /* Unique id of the node. */
1276 int uid;
1277 /* Summary unique id of the node. */
1278 int summary_uid;
1279 /* ID assigned by the profiling. */
1280 unsigned int profile_id;
1281 /* Time profiler: first run of function. */
1282 int tp_first_run;
1284 /* Set when decl is an abstract function pointed to by the
1285 ABSTRACT_DECL_ORIGIN of a reachable function. */
1286 unsigned used_as_abstract_origin : 1;
1287 /* Set once the function is lowered (i.e. its CFG is built). */
1288 unsigned lowered : 1;
1289 /* Set once the function has been instantiated and its callee
1290 lists created. */
1291 unsigned process : 1;
1292 /* How commonly executed the node is. Initialized during branch
1293 probabilities pass. */
1294 ENUM_BITFIELD (node_frequency) frequency : 2;
1295 /* True when function can only be called at startup (from static ctor). */
1296 unsigned only_called_at_startup : 1;
1297 /* True when function can only be called at startup (from static dtor). */
1298 unsigned only_called_at_exit : 1;
1299 /* True when function is the transactional clone of a function which
1300 is called only from inside transactions. */
1301 /* ?? We should be able to remove this. We have enough bits in
1302 cgraph to calculate it. */
1303 unsigned tm_clone : 1;
1304 /* True if this decl is a dispatcher for function versions. */
1305 unsigned dispatcher_function : 1;
1306 /* True if this decl calls a COMDAT-local function. This is set up in
1307 compute_inline_parameters and inline_call. */
1308 unsigned calls_comdat_local : 1;
1309 /* True if node has been created by merge operation in IPA-ICF. */
1310 unsigned icf_merged: 1;
1311 /* True when function is clone created for Pointer Bounds Checker
1312 instrumentation. */
1313 unsigned instrumentation_clone : 1;
1314 /* True if call to node can't result in a call to free, munmap or
1315 other operation that could make previously non-trapping memory
1316 accesses trapping. */
1317 unsigned nonfreeing_fn : 1;
1318 /* True if there was multiple COMDAT bodies merged by lto-symtab. */
1319 unsigned merged : 1;
1320 /* True if function was created to be executed in parallel. */
1321 unsigned parallelized_function : 1;
1322 /* True if function is part split out by ipa-split. */
1323 unsigned split_part : 1;
1325 private:
1326 /* Worker for call_for_symbol_and_aliases. */
1327 bool call_for_symbol_and_aliases_1 (bool (*callback) (cgraph_node *,
1328 void *),
1329 void *data, bool include_overwritable);
1332 /* A cgraph node set is a collection of cgraph nodes. A cgraph node
1333 can appear in multiple sets. */
1334 struct cgraph_node_set_def
1336 hash_map<cgraph_node *, size_t> *map;
1337 vec<cgraph_node *> nodes;
1340 typedef cgraph_node_set_def *cgraph_node_set;
1341 typedef struct varpool_node_set_def *varpool_node_set;
1343 class varpool_node;
1345 /* A varpool node set is a collection of varpool nodes. A varpool node
1346 can appear in multiple sets. */
1347 struct varpool_node_set_def
1349 hash_map<varpool_node *, size_t> * map;
1350 vec<varpool_node *> nodes;
1353 /* Iterator structure for cgraph node sets. */
1354 struct cgraph_node_set_iterator
1356 cgraph_node_set set;
1357 unsigned index;
1360 /* Iterator structure for varpool node sets. */
1361 struct varpool_node_set_iterator
1363 varpool_node_set set;
1364 unsigned index;
1367 /* Context of polymorphic call. It represent information about the type of
1368 instance that may reach the call. This is used by ipa-devirt walkers of the
1369 type inheritance graph. */
1371 class GTY(()) ipa_polymorphic_call_context {
1372 public:
1373 /* The called object appears in an object of type OUTER_TYPE
1374 at offset OFFSET. When information is not 100% reliable, we
1375 use SPECULATIVE_OUTER_TYPE and SPECULATIVE_OFFSET. */
1376 HOST_WIDE_INT offset;
1377 HOST_WIDE_INT speculative_offset;
1378 tree outer_type;
1379 tree speculative_outer_type;
1380 /* True if outer object may be in construction or destruction. */
1381 unsigned maybe_in_construction : 1;
1382 /* True if outer object may be of derived type. */
1383 unsigned maybe_derived_type : 1;
1384 /* True if speculative outer object may be of derived type. We always
1385 speculate that construction does not happen. */
1386 unsigned speculative_maybe_derived_type : 1;
1387 /* True if the context is invalid and all calls should be redirected
1388 to BUILTIN_UNREACHABLE. */
1389 unsigned invalid : 1;
1390 /* True if the outer type is dynamic. */
1391 unsigned dynamic : 1;
1393 /* Build empty "I know nothing" context. */
1394 ipa_polymorphic_call_context ();
1395 /* Build polymorphic call context for indirect call E. */
1396 ipa_polymorphic_call_context (cgraph_edge *e);
1397 /* Build polymorphic call context for IP invariant CST.
1398 If specified, OTR_TYPE specify the type of polymorphic call
1399 that takes CST+OFFSET as a prameter. */
1400 ipa_polymorphic_call_context (tree cst, tree otr_type = NULL,
1401 HOST_WIDE_INT offset = 0);
1402 /* Build context for pointer REF contained in FNDECL at statement STMT.
1403 if INSTANCE is non-NULL, return pointer to the object described by
1404 the context. */
1405 ipa_polymorphic_call_context (tree fndecl, tree ref, gimple stmt,
1406 tree *instance = NULL);
1408 /* Look for vtable stores or constructor calls to work out dynamic type
1409 of memory location. */
1410 bool get_dynamic_type (tree, tree, tree, gimple);
1412 /* Make context non-speculative. */
1413 void clear_speculation ();
1415 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
1416 NULL, the context is set to dummy "I know nothing" setting. */
1417 void clear_outer_type (tree otr_type = NULL);
1419 /* Walk container types and modify context to point to actual class
1420 containing OTR_TYPE (if non-NULL) as base class.
1421 Return true if resulting context is valid.
1423 When CONSIDER_PLACEMENT_NEW is false, reject contexts that may be made
1424 valid only via alocation of new polymorphic type inside by means
1425 of placement new.
1427 When CONSIDER_BASES is false, only look for actual fields, not base types
1428 of TYPE. */
1429 bool restrict_to_inner_class (tree otr_type,
1430 bool consider_placement_new = true,
1431 bool consider_bases = true);
1433 /* Adjust all offsets in contexts by given number of bits. */
1434 void offset_by (HOST_WIDE_INT);
1435 /* Use when we can not track dynamic type change. This speculatively assume
1436 type change is not happening. */
1437 void possible_dynamic_type_change (bool, tree otr_type = NULL);
1438 /* Assume that both THIS and a given context is valid and strenghten THIS
1439 if possible. Return true if any strenghtening was made.
1440 If actual type the context is being used in is known, OTR_TYPE should be
1441 set accordingly. This improves quality of combined result. */
1442 bool combine_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1443 bool meet_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1445 /* Return TRUE if context is fully useless. */
1446 bool useless_p () const;
1447 /* Return TRUE if this context conveys the same information as X. */
1448 bool equal_to (const ipa_polymorphic_call_context &x) const;
1450 /* Dump human readable context to F. If NEWLINE is true, it will be
1451 terminated by a newline. */
1452 void dump (FILE *f, bool newline = true) const;
1453 void DEBUG_FUNCTION debug () const;
1455 /* LTO streaming. */
1456 void stream_out (struct output_block *) const;
1457 void stream_in (struct lto_input_block *, struct data_in *data_in);
1459 private:
1460 bool combine_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1461 bool meet_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1462 void set_by_decl (tree, HOST_WIDE_INT);
1463 bool set_by_invariant (tree, tree, HOST_WIDE_INT);
1464 bool speculation_consistent_p (tree, HOST_WIDE_INT, bool, tree) const;
1465 void make_speculative (tree otr_type = NULL);
1468 /* Structure containing additional information about an indirect call. */
1470 struct GTY(()) cgraph_indirect_call_info
1472 /* When agg_content is set, an offset where the call pointer is located
1473 within the aggregate. */
1474 HOST_WIDE_INT offset;
1475 /* Context of the polymorphic call; use only when POLYMORPHIC flag is set. */
1476 ipa_polymorphic_call_context context;
1477 /* OBJ_TYPE_REF_TOKEN of a polymorphic call (if polymorphic is set). */
1478 HOST_WIDE_INT otr_token;
1479 /* Type of the object from OBJ_TYPE_REF_OBJECT. */
1480 tree otr_type;
1481 /* Index of the parameter that is called. */
1482 int param_index;
1483 /* ECF flags determined from the caller. */
1484 int ecf_flags;
1485 /* Profile_id of common target obtrained from profile. */
1486 int common_target_id;
1487 /* Probability that call will land in function with COMMON_TARGET_ID. */
1488 int common_target_probability;
1490 /* Set when the call is a virtual call with the parameter being the
1491 associated object pointer rather than a simple direct call. */
1492 unsigned polymorphic : 1;
1493 /* Set when the call is a call of a pointer loaded from contents of an
1494 aggregate at offset. */
1495 unsigned agg_contents : 1;
1496 /* Set when this is a call through a member pointer. */
1497 unsigned member_ptr : 1;
1498 /* When the previous bit is set, this one determines whether the destination
1499 is loaded from a parameter passed by reference. */
1500 unsigned by_ref : 1;
1501 /* For polymorphic calls this specify whether the virtual table pointer
1502 may have changed in between function entry and the call. */
1503 unsigned vptr_changed : 1;
1506 struct GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller"),
1507 for_user)) cgraph_edge {
1508 friend class cgraph_node;
1510 /* Remove the edge in the cgraph. */
1511 void remove (void);
1513 /* Change field call_stmt of edge to NEW_STMT.
1514 If UPDATE_SPECULATIVE and E is any component of speculative
1515 edge, then update all components. */
1516 void set_call_stmt (gcall *new_stmt, bool update_speculative = true);
1518 /* Redirect callee of the edge to N. The function does not update underlying
1519 call expression. */
1520 void redirect_callee (cgraph_node *n);
1522 /* If the edge does not lead to a thunk, simply redirect it to N. Otherwise
1523 create one or more equivalent thunks for N and redirect E to the first in
1524 the chain. Note that it is then necessary to call
1525 n->expand_all_artificial_thunks once all callers are redirected. */
1526 void redirect_callee_duplicating_thunks (cgraph_node *n);
1528 /* Make an indirect edge with an unknown callee an ordinary edge leading to
1529 CALLEE. DELTA is an integer constant that is to be added to the this
1530 pointer (first parameter) to compensate for skipping
1531 a thunk adjustment. */
1532 cgraph_edge *make_direct (cgraph_node *callee);
1534 /* Turn edge into speculative call calling N2. Update
1535 the profile so the direct call is taken COUNT times
1536 with FREQUENCY. */
1537 cgraph_edge *make_speculative (cgraph_node *n2, gcov_type direct_count,
1538 int direct_frequency);
1540 /* Given speculative call edge, return all three components. */
1541 void speculative_call_info (cgraph_edge *&direct, cgraph_edge *&indirect,
1542 ipa_ref *&reference);
1544 /* Speculative call edge turned out to be direct call to CALLE_DECL.
1545 Remove the speculative call sequence and return edge representing the call.
1546 It is up to caller to redirect the call as appropriate. */
1547 cgraph_edge *resolve_speculation (tree callee_decl = NULL);
1549 /* If necessary, change the function declaration in the call statement
1550 associated with the edge so that it corresponds to the edge callee. */
1551 gimple redirect_call_stmt_to_callee (void);
1553 /* Create clone of edge in the node N represented
1554 by CALL_EXPR the callgraph. */
1555 cgraph_edge * clone (cgraph_node *n, gcall *call_stmt, unsigned stmt_uid,
1556 gcov_type count_scale, int freq_scale, bool update_original);
1558 /* Verify edge count and frequency. */
1559 bool verify_count_and_frequency ();
1561 /* Return true when call of edge can not lead to return from caller
1562 and thus it is safe to ignore its side effects for IPA analysis
1563 when computing side effects of the caller. */
1564 bool cannot_lead_to_return_p (void);
1566 /* Return true when the edge represents a direct recursion. */
1567 bool recursive_p (void);
1569 /* Return true if the call can be hot. */
1570 bool maybe_hot_p (void);
1572 /* Rebuild cgraph edges for current function node. This needs to be run after
1573 passes that don't update the cgraph. */
1574 static unsigned int rebuild_edges (void);
1576 /* Rebuild cgraph references for current function node. This needs to be run
1577 after passes that don't update the cgraph. */
1578 static void rebuild_references (void);
1580 /* Expected number of executions: calculated in profile.c. */
1581 gcov_type count;
1582 cgraph_node *caller;
1583 cgraph_node *callee;
1584 cgraph_edge *prev_caller;
1585 cgraph_edge *next_caller;
1586 cgraph_edge *prev_callee;
1587 cgraph_edge *next_callee;
1588 gcall *call_stmt;
1589 /* Additional information about an indirect call. Not cleared when an edge
1590 becomes direct. */
1591 cgraph_indirect_call_info *indirect_info;
1592 PTR GTY ((skip (""))) aux;
1593 /* When equal to CIF_OK, inline this call. Otherwise, points to the
1594 explanation why function was not inlined. */
1595 enum cgraph_inline_failed_t inline_failed;
1596 /* The stmt_uid of call_stmt. This is used by LTO to recover the call_stmt
1597 when the function is serialized in. */
1598 unsigned int lto_stmt_uid;
1599 /* Expected frequency of executions within the function.
1600 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
1601 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
1602 int frequency;
1603 /* Unique id of the edge. */
1604 int uid;
1605 /* Whether this edge was made direct by indirect inlining. */
1606 unsigned int indirect_inlining_edge : 1;
1607 /* Whether this edge describes an indirect call with an undetermined
1608 callee. */
1609 unsigned int indirect_unknown_callee : 1;
1610 /* Whether this edge is still a dangling */
1611 /* True if the corresponding CALL stmt cannot be inlined. */
1612 unsigned int call_stmt_cannot_inline_p : 1;
1613 /* Can this call throw externally? */
1614 unsigned int can_throw_external : 1;
1615 /* Edges with SPECULATIVE flag represents indirect calls that was
1616 speculatively turned into direct (i.e. by profile feedback).
1617 The final code sequence will have form:
1619 if (call_target == expected_fn)
1620 expected_fn ();
1621 else
1622 call_target ();
1624 Every speculative call is represented by three components attached
1625 to a same call statement:
1626 1) a direct call (to expected_fn)
1627 2) an indirect call (to call_target)
1628 3) a IPA_REF_ADDR refrence to expected_fn.
1630 Optimizers may later redirect direct call to clone, so 1) and 3)
1631 do not need to necesarily agree with destination. */
1632 unsigned int speculative : 1;
1633 /* Set to true when caller is a constructor or destructor of polymorphic
1634 type. */
1635 unsigned in_polymorphic_cdtor : 1;
1637 private:
1638 /* Remove the edge from the list of the callers of the callee. */
1639 void remove_caller (void);
1641 /* Remove the edge from the list of the callees of the caller. */
1642 void remove_callee (void);
1644 /* Set callee N of call graph edge and add it to the corresponding set of
1645 callers. */
1646 void set_callee (cgraph_node *n);
1648 /* Output flags of edge to a file F. */
1649 void dump_edge_flags (FILE *f);
1651 /* Verify that call graph edge corresponds to DECL from the associated
1652 statement. Return true if the verification should fail. */
1653 bool verify_corresponds_to_fndecl (tree decl);
1656 #define CGRAPH_FREQ_BASE 1000
1657 #define CGRAPH_FREQ_MAX 100000
1659 /* The varpool data structure.
1660 Each static variable decl has assigned varpool_node. */
1662 class GTY((tag ("SYMTAB_VARIABLE"))) varpool_node : public symtab_node {
1663 public:
1664 /* Dump given varpool node to F. */
1665 void dump (FILE *f);
1667 /* Dump given varpool node to stderr. */
1668 void DEBUG_FUNCTION debug (void);
1670 /* Remove variable from symbol table. */
1671 void remove (void);
1673 /* Remove node initializer when it is no longer needed. */
1674 void remove_initializer (void);
1676 void analyze (void);
1678 /* Return variable availability. */
1679 availability get_availability (void);
1681 /* When doing LTO, read variable's constructor from disk if
1682 it is not already present. */
1683 tree get_constructor (void);
1685 /* Return true if variable has constructor that can be used for folding. */
1686 bool ctor_useable_for_folding_p (void);
1688 /* For given variable pool node, walk the alias chain to return the function
1689 the variable is alias of. Do not walk through thunks.
1690 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
1691 inline varpool_node *ultimate_alias_target
1692 (availability *availability = NULL);
1694 /* Return node that alias is aliasing. */
1695 inline varpool_node *get_alias_target (void);
1697 /* Output one variable, if necessary. Return whether we output it. */
1698 bool assemble_decl (void);
1700 /* For variables in named sections make sure get_variable_section
1701 is called before we switch to those sections. Then section
1702 conflicts between read-only and read-only requiring relocations
1703 sections can be resolved. */
1704 void finalize_named_section_flags (void);
1706 /* Call calback on varpool symbol and aliases associated to varpool symbol.
1707 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1708 skipped. */
1709 bool call_for_symbol_and_aliases (bool (*callback) (varpool_node *, void *),
1710 void *data,
1711 bool include_overwritable);
1713 /* Return true when variable should be considered externally visible. */
1714 bool externally_visible_p (void);
1716 /* Return true when all references to variable must be visible
1717 in ipa_ref_list.
1718 i.e. if the variable is not externally visible or not used in some magic
1719 way (asm statement or such).
1720 The magic uses are all summarized in force_output flag. */
1721 inline bool all_refs_explicit_p ();
1723 /* Return true when variable can be removed from variable pool
1724 if all direct calls are eliminated. */
1725 inline bool can_remove_if_no_refs_p (void);
1727 /* Add the variable DECL to the varpool.
1728 Unlike finalize_decl function is intended to be used
1729 by middle end and allows insertion of new variable at arbitrary point
1730 of compilation. */
1731 static void add (tree decl);
1733 /* Return varpool node for given symbol and check it is a function. */
1734 static inline varpool_node *get (const_tree decl);
1736 /* Mark DECL as finalized. By finalizing the declaration, frontend instruct
1737 the middle end to output the variable to asm file, if needed or externally
1738 visible. */
1739 static void finalize_decl (tree decl);
1741 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1742 Extra name aliases are output whenever DECL is output. */
1743 static varpool_node * create_extra_name_alias (tree alias, tree decl);
1745 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1746 Extra name aliases are output whenever DECL is output. */
1747 static varpool_node * create_alias (tree, tree);
1749 /* Dump the variable pool to F. */
1750 static void dump_varpool (FILE *f);
1752 /* Dump the variable pool to stderr. */
1753 static void DEBUG_FUNCTION debug_varpool (void);
1755 /* Allocate new callgraph node and insert it into basic data structures. */
1756 static varpool_node *create_empty (void);
1758 /* Return varpool node assigned to DECL. Create new one when needed. */
1759 static varpool_node *get_create (tree decl);
1761 /* Given an assembler name, lookup node. */
1762 static varpool_node *get_for_asmname (tree asmname);
1764 /* Set when variable is scheduled to be assembled. */
1765 unsigned output : 1;
1767 /* Set when variable has statically initialized pointer
1768 or is a static bounds variable and needs initalization. */
1769 unsigned need_bounds_init : 1;
1771 /* Set if the variable is dynamically initialized, except for
1772 function local statics. */
1773 unsigned dynamically_initialized : 1;
1775 ENUM_BITFIELD(tls_model) tls_model : 3;
1777 /* Set if the variable is known to be used by single function only.
1778 This is computed by ipa_signle_use pass and used by late optimizations
1779 in places where optimization would be valid for local static variable
1780 if we did not do any inter-procedural code movement. */
1781 unsigned used_by_single_function : 1;
1783 private:
1784 /* Assemble thunks and aliases associated to varpool node. */
1785 void assemble_aliases (void);
1787 /* Worker for call_for_node_and_aliases. */
1788 bool call_for_symbol_and_aliases_1 (bool (*callback) (varpool_node *, void *),
1789 void *data,
1790 bool include_overwritable);
1793 /* Every top level asm statement is put into a asm_node. */
1795 struct GTY(()) asm_node {
1798 /* Next asm node. */
1799 asm_node *next;
1800 /* String for this asm node. */
1801 tree asm_str;
1802 /* Ordering of all cgraph nodes. */
1803 int order;
1806 /* Report whether or not THIS symtab node is a function, aka cgraph_node. */
1808 template <>
1809 template <>
1810 inline bool
1811 is_a_helper <cgraph_node *>::test (symtab_node *p)
1813 return p && p->type == SYMTAB_FUNCTION;
1816 /* Report whether or not THIS symtab node is a vriable, aka varpool_node. */
1818 template <>
1819 template <>
1820 inline bool
1821 is_a_helper <varpool_node *>::test (symtab_node *p)
1823 return p && p->type == SYMTAB_VARIABLE;
1826 /* Macros to access the next item in the list of free cgraph nodes and
1827 edges. */
1828 #define NEXT_FREE_NODE(NODE) dyn_cast<cgraph_node *> ((NODE)->next)
1829 #define SET_NEXT_FREE_NODE(NODE,NODE2) ((NODE))->next = NODE2
1830 #define NEXT_FREE_EDGE(EDGE) (EDGE)->prev_caller
1832 typedef void (*cgraph_edge_hook)(cgraph_edge *, void *);
1833 typedef void (*cgraph_node_hook)(cgraph_node *, void *);
1834 typedef void (*varpool_node_hook)(varpool_node *, void *);
1835 typedef void (*cgraph_2edge_hook)(cgraph_edge *, cgraph_edge *, void *);
1836 typedef void (*cgraph_2node_hook)(cgraph_node *, cgraph_node *, void *);
1838 struct cgraph_edge_hook_list;
1839 struct cgraph_node_hook_list;
1840 struct varpool_node_hook_list;
1841 struct cgraph_2edge_hook_list;
1842 struct cgraph_2node_hook_list;
1844 /* Map from a symbol to initialization/finalization priorities. */
1845 struct GTY(()) symbol_priority_map {
1846 priority_type init;
1847 priority_type fini;
1850 enum symtab_state
1852 /* Frontend is parsing and finalizing functions. */
1853 PARSING,
1854 /* Callgraph is being constructed. It is safe to add new functions. */
1855 CONSTRUCTION,
1856 /* Callgraph is being streamed-in at LTO time. */
1857 LTO_STREAMING,
1858 /* Callgraph is built and early IPA passes are being run. */
1859 IPA,
1860 /* Callgraph is built and all functions are transformed to SSA form. */
1861 IPA_SSA,
1862 /* All inline decisions are done; it is now possible to remove extern inline
1863 functions and virtual call targets. */
1864 IPA_SSA_AFTER_INLINING,
1865 /* Functions are now ordered and being passed to RTL expanders. */
1866 EXPANSION,
1867 /* All cgraph expansion is done. */
1868 FINISHED
1871 struct asmname_hasher
1873 typedef symtab_node *value_type;
1874 typedef const_tree compare_type;
1876 static hashval_t hash (symtab_node *n);
1877 static bool equal (symtab_node *n, const_tree t);
1878 static void ggc_mx (symtab_node *n);
1879 static void pch_nx (symtab_node *&);
1880 static void pch_nx (symtab_node *&, gt_pointer_operator, void *);
1881 static void remove (symtab_node *) {}
1884 class GTY((tag ("SYMTAB"))) symbol_table
1886 public:
1887 friend class symtab_node;
1888 friend class cgraph_node;
1889 friend class cgraph_edge;
1891 symbol_table (): cgraph_max_summary_uid (1)
1895 /* Initialize callgraph dump file. */
1896 void initialize (void);
1898 /* Register a top-level asm statement ASM_STR. */
1899 inline asm_node *finalize_toplevel_asm (tree asm_str);
1901 /* Analyze the whole compilation unit once it is parsed completely. */
1902 void finalize_compilation_unit (void);
1904 /* C++ frontend produce same body aliases all over the place, even before PCH
1905 gets streamed out. It relies on us linking the aliases with their function
1906 in order to do the fixups, but ipa-ref is not PCH safe. Consequentely we
1907 first produce aliases without links, but once C++ FE is sure he won't sream
1908 PCH we build the links via this function. */
1909 void process_same_body_aliases (void);
1911 /* Perform simple optimizations based on callgraph. */
1912 void compile (void);
1914 /* Process CGRAPH_NEW_FUNCTIONS and perform actions necessary to add these
1915 functions into callgraph in a way so they look like ordinary reachable
1916 functions inserted into callgraph already at construction time. */
1917 void process_new_functions (void);
1919 /* Once all functions from compilation unit are in memory, produce all clones
1920 and update all calls. We might also do this on demand if we don't want to
1921 bring all functions to memory prior compilation, but current WHOPR
1922 implementation does that and it is is bit easier to keep everything right
1923 in this order. */
1924 void materialize_all_clones (void);
1926 /* Register a symbol NODE. */
1927 inline void register_symbol (symtab_node *node);
1929 inline void
1930 clear_asm_symbols (void)
1932 asmnodes = NULL;
1933 asm_last_node = NULL;
1936 /* Perform reachability analysis and reclaim all unreachable nodes. */
1937 bool remove_unreachable_nodes (FILE *file);
1939 /* Optimization of function bodies might've rendered some variables as
1940 unnecessary so we want to avoid these from being compiled. Re-do
1941 reachability starting from variables that are either externally visible
1942 or was referred from the asm output routines. */
1943 void remove_unreferenced_decls (void);
1945 /* Unregister a symbol NODE. */
1946 inline void unregister (symtab_node *node);
1948 /* Allocate new callgraph node and insert it into basic data structures. */
1949 cgraph_node *create_empty (void);
1951 /* Release a callgraph NODE with UID and put in to the list
1952 of free nodes. */
1953 void release_symbol (cgraph_node *node, int uid);
1955 /* Output all variables enqueued to be assembled. */
1956 bool output_variables (void);
1958 /* Weakrefs may be associated to external decls and thus not output
1959 at expansion time. Emit all necessary aliases. */
1960 void output_weakrefs (void);
1962 /* Return first static symbol with definition. */
1963 inline symtab_node *first_symbol (void);
1965 /* Return first assembler symbol. */
1966 inline asm_node *
1967 first_asm_symbol (void)
1969 return asmnodes;
1972 /* Return first static symbol with definition. */
1973 inline symtab_node *first_defined_symbol (void);
1975 /* Return first variable. */
1976 inline varpool_node *first_variable (void);
1978 /* Return next variable after NODE. */
1979 inline varpool_node *next_variable (varpool_node *node);
1981 /* Return first static variable with initializer. */
1982 inline varpool_node *first_static_initializer (void);
1984 /* Return next static variable with initializer after NODE. */
1985 inline varpool_node *next_static_initializer (varpool_node *node);
1987 /* Return first static variable with definition. */
1988 inline varpool_node *first_defined_variable (void);
1990 /* Return next static variable with definition after NODE. */
1991 inline varpool_node *next_defined_variable (varpool_node *node);
1993 /* Return first function with body defined. */
1994 inline cgraph_node *first_defined_function (void);
1996 /* Return next function with body defined after NODE. */
1997 inline cgraph_node *next_defined_function (cgraph_node *node);
1999 /* Return first function. */
2000 inline cgraph_node *first_function (void);
2002 /* Return next function. */
2003 inline cgraph_node *next_function (cgraph_node *node);
2005 /* Return first function with body defined. */
2006 cgraph_node *first_function_with_gimple_body (void);
2008 /* Return next reachable static variable with initializer after NODE. */
2009 inline cgraph_node *next_function_with_gimple_body (cgraph_node *node);
2011 /* Register HOOK to be called with DATA on each removed edge. */
2012 cgraph_edge_hook_list *add_edge_removal_hook (cgraph_edge_hook hook,
2013 void *data);
2015 /* Remove ENTRY from the list of hooks called on removing edges. */
2016 void remove_edge_removal_hook (cgraph_edge_hook_list *entry);
2018 /* Register HOOK to be called with DATA on each removed node. */
2019 cgraph_node_hook_list *add_cgraph_removal_hook (cgraph_node_hook hook,
2020 void *data);
2022 /* Remove ENTRY from the list of hooks called on removing nodes. */
2023 void remove_cgraph_removal_hook (cgraph_node_hook_list *entry);
2025 /* Register HOOK to be called with DATA on each removed node. */
2026 varpool_node_hook_list *add_varpool_removal_hook (varpool_node_hook hook,
2027 void *data);
2029 /* Remove ENTRY from the list of hooks called on removing nodes. */
2030 void remove_varpool_removal_hook (varpool_node_hook_list *entry);
2032 /* Register HOOK to be called with DATA on each inserted node. */
2033 cgraph_node_hook_list *add_cgraph_insertion_hook (cgraph_node_hook hook,
2034 void *data);
2036 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2037 void remove_cgraph_insertion_hook (cgraph_node_hook_list *entry);
2039 /* Register HOOK to be called with DATA on each inserted node. */
2040 varpool_node_hook_list *add_varpool_insertion_hook (varpool_node_hook hook,
2041 void *data);
2043 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2044 void remove_varpool_insertion_hook (varpool_node_hook_list *entry);
2046 /* Register HOOK to be called with DATA on each duplicated edge. */
2047 cgraph_2edge_hook_list *add_edge_duplication_hook (cgraph_2edge_hook hook,
2048 void *data);
2049 /* Remove ENTRY from the list of hooks called on duplicating edges. */
2050 void remove_edge_duplication_hook (cgraph_2edge_hook_list *entry);
2052 /* Register HOOK to be called with DATA on each duplicated node. */
2053 cgraph_2node_hook_list *add_cgraph_duplication_hook (cgraph_2node_hook hook,
2054 void *data);
2056 /* Remove ENTRY from the list of hooks called on duplicating nodes. */
2057 void remove_cgraph_duplication_hook (cgraph_2node_hook_list *entry);
2059 /* Call all edge removal hooks. */
2060 void call_edge_removal_hooks (cgraph_edge *e);
2062 /* Call all node insertion hooks. */
2063 void call_cgraph_insertion_hooks (cgraph_node *node);
2065 /* Call all node removal hooks. */
2066 void call_cgraph_removal_hooks (cgraph_node *node);
2068 /* Call all node duplication hooks. */
2069 void call_cgraph_duplication_hooks (cgraph_node *node, cgraph_node *node2);
2071 /* Call all edge duplication hooks. */
2072 void call_edge_duplication_hooks (cgraph_edge *cs1, cgraph_edge *cs2);
2074 /* Call all node removal hooks. */
2075 void call_varpool_removal_hooks (varpool_node *node);
2077 /* Call all node insertion hooks. */
2078 void call_varpool_insertion_hooks (varpool_node *node);
2080 /* Arrange node to be first in its entry of assembler_name_hash. */
2081 void symtab_prevail_in_asm_name_hash (symtab_node *node);
2083 /* Initalize asm name hash unless. */
2084 void symtab_initialize_asm_name_hash (void);
2086 /* Set the DECL_ASSEMBLER_NAME and update symtab hashtables. */
2087 void change_decl_assembler_name (tree decl, tree name);
2089 int cgraph_count;
2090 int cgraph_max_uid;
2091 int cgraph_max_summary_uid;
2093 int edges_count;
2094 int edges_max_uid;
2096 symtab_node* GTY(()) nodes;
2097 asm_node* GTY(()) asmnodes;
2098 asm_node* GTY(()) asm_last_node;
2099 cgraph_node* GTY(()) free_nodes;
2101 /* Head of a linked list of unused (freed) call graph edges.
2102 Do not GTY((delete)) this list so UIDs gets reliably recycled. */
2103 cgraph_edge * GTY(()) free_edges;
2105 /* The order index of the next symtab node to be created. This is
2106 used so that we can sort the cgraph nodes in order by when we saw
2107 them, to support -fno-toplevel-reorder. */
2108 int order;
2110 /* Set when whole unit has been analyzed so we can access global info. */
2111 bool global_info_ready;
2112 /* What state callgraph is in right now. */
2113 enum symtab_state state;
2114 /* Set when the cgraph is fully build and the basic flags are computed. */
2115 bool function_flags_ready;
2117 bool cpp_implicit_aliases_done;
2119 /* Hash table used to hold sectoons. */
2120 hash_table<section_name_hasher> *GTY(()) section_hash;
2122 /* Hash table used to convert assembler names into nodes. */
2123 hash_table<asmname_hasher> *assembler_name_hash;
2125 /* Hash table used to hold init priorities. */
2126 hash_map<symtab_node *, symbol_priority_map> *init_priority_hash;
2128 FILE* GTY ((skip)) dump_file;
2130 private:
2131 /* Allocate new callgraph node. */
2132 inline cgraph_node * allocate_cgraph_symbol (void);
2134 /* Allocate a cgraph_edge structure and fill it with data according to the
2135 parameters of which only CALLEE can be NULL (when creating an indirect call
2136 edge). */
2137 cgraph_edge *create_edge (cgraph_node *caller, cgraph_node *callee,
2138 gcall *call_stmt, gcov_type count, int freq,
2139 bool indir_unknown_callee);
2141 /* Put the edge onto the free list. */
2142 void free_edge (cgraph_edge *e);
2144 /* Insert NODE to assembler name hash. */
2145 void insert_to_assembler_name_hash (symtab_node *node, bool with_clones);
2147 /* Remove NODE from assembler name hash. */
2148 void unlink_from_assembler_name_hash (symtab_node *node, bool with_clones);
2150 /* Hash asmnames ignoring the user specified marks. */
2151 static hashval_t decl_assembler_name_hash (const_tree asmname);
2153 /* Compare ASMNAME with the DECL_ASSEMBLER_NAME of DECL. */
2154 static bool decl_assembler_name_equal (tree decl, const_tree asmname);
2156 friend struct asmname_hasher;
2158 /* List of hooks triggered when an edge is removed. */
2159 cgraph_edge_hook_list * GTY((skip)) m_first_edge_removal_hook;
2160 /* List of hooks triggem_red when a cgraph node is removed. */
2161 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_removal_hook;
2162 /* List of hooks triggered when an edge is duplicated. */
2163 cgraph_2edge_hook_list * GTY((skip)) m_first_edge_duplicated_hook;
2164 /* List of hooks triggered when a node is duplicated. */
2165 cgraph_2node_hook_list * GTY((skip)) m_first_cgraph_duplicated_hook;
2166 /* List of hooks triggered when an function is inserted. */
2167 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_insertion_hook;
2168 /* List of hooks triggered when an variable is inserted. */
2169 varpool_node_hook_list * GTY((skip)) m_first_varpool_insertion_hook;
2170 /* List of hooks triggered when a node is removed. */
2171 varpool_node_hook_list * GTY((skip)) m_first_varpool_removal_hook;
2174 extern GTY(()) symbol_table *symtab;
2176 extern vec<cgraph_node *> cgraph_new_nodes;
2178 inline hashval_t
2179 asmname_hasher::hash (symtab_node *n)
2181 return symbol_table::decl_assembler_name_hash
2182 (DECL_ASSEMBLER_NAME (n->decl));
2185 inline bool
2186 asmname_hasher::equal (symtab_node *n, const_tree t)
2188 return symbol_table::decl_assembler_name_equal (n->decl, t);
2191 extern void gt_ggc_mx (symtab_node *&);
2193 inline void
2194 asmname_hasher::ggc_mx (symtab_node *n)
2196 gt_ggc_mx (n);
2199 extern void gt_pch_nx (symtab_node *&);
2201 inline void
2202 asmname_hasher::pch_nx (symtab_node *&n)
2204 gt_pch_nx (n);
2207 inline void
2208 asmname_hasher::pch_nx (symtab_node *&n, gt_pointer_operator op, void *cookie)
2210 op (&n, cookie);
2213 /* In cgraph.c */
2214 void cgraph_c_finalize (void);
2215 void release_function_body (tree);
2216 cgraph_indirect_call_info *cgraph_allocate_init_indirect_info (void);
2218 void cgraph_update_edges_for_call_stmt (gimple, tree, gimple);
2219 bool cgraph_function_possibly_inlined_p (tree);
2221 const char* cgraph_inline_failed_string (cgraph_inline_failed_t);
2222 cgraph_inline_failed_type_t cgraph_inline_failed_type (cgraph_inline_failed_t);
2224 extern bool gimple_check_call_matching_types (gimple, tree, bool);
2226 /* In cgraphunit.c */
2227 void cgraphunit_c_finalize (void);
2229 /* Initialize datastructures so DECL is a function in lowered gimple form.
2230 IN_SSA is true if the gimple is in SSA. */
2231 basic_block init_lowered_empty_function (tree, bool, gcov_type);
2233 /* In cgraphclones.c */
2235 tree clone_function_name_1 (const char *, const char *);
2236 tree clone_function_name (tree decl, const char *);
2238 void tree_function_versioning (tree, tree, vec<ipa_replace_map *, va_gc> *,
2239 bool, bitmap, bool, bitmap, basic_block);
2241 /* In cgraphbuild.c */
2242 int compute_call_stmt_bb_frequency (tree, basic_block bb);
2243 void record_references_in_initializer (tree, bool);
2245 /* In ipa.c */
2246 void cgraph_build_static_cdtor (char which, tree body, int priority);
2247 bool ipa_discover_readonly_nonaddressable_vars (void);
2249 /* In varpool.c */
2250 tree ctor_for_folding (tree);
2252 /* In tree-chkp.c */
2253 extern bool chkp_function_instrumented_p (tree fndecl);
2255 /* Return true when the symbol is real symbol, i.e. it is not inline clone
2256 or abstract function kept for debug info purposes only. */
2257 inline bool
2258 symtab_node::real_symbol_p (void)
2260 cgraph_node *cnode;
2262 if (DECL_ABSTRACT_P (decl))
2263 return false;
2264 if (!is_a <cgraph_node *> (this))
2265 return true;
2266 cnode = dyn_cast <cgraph_node *> (this);
2267 if (cnode->global.inlined_to)
2268 return false;
2269 return true;
2272 /* Return true if DECL should have entry in symbol table if used.
2273 Those are functions and static & external veriables*/
2275 static inline bool
2276 decl_in_symtab_p (const_tree decl)
2278 return (TREE_CODE (decl) == FUNCTION_DECL
2279 || (TREE_CODE (decl) == VAR_DECL
2280 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl))));
2283 inline bool
2284 symtab_node::in_same_comdat_group_p (symtab_node *target)
2286 symtab_node *source = this;
2288 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2290 if (cn->global.inlined_to)
2291 source = cn->global.inlined_to;
2293 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2295 if (cn->global.inlined_to)
2296 target = cn->global.inlined_to;
2299 return source->get_comdat_group () == target->get_comdat_group ();
2302 /* Return node that alias is aliasing. */
2304 inline symtab_node *
2305 symtab_node::get_alias_target (void)
2307 ipa_ref *ref = NULL;
2308 iterate_reference (0, ref);
2309 if (ref->use == IPA_REF_CHKP)
2310 iterate_reference (1, ref);
2311 gcc_checking_assert (ref->use == IPA_REF_ALIAS);
2312 return ref->referred;
2315 /* Return next reachable static symbol with initializer after the node. */
2317 inline symtab_node *
2318 symtab_node::next_defined_symbol (void)
2320 symtab_node *node1 = next;
2322 for (; node1; node1 = node1->next)
2323 if (node1->definition)
2324 return node1;
2326 return NULL;
2329 /* Iterates I-th reference in the list, REF is also set. */
2331 inline ipa_ref *
2332 symtab_node::iterate_reference (unsigned i, ipa_ref *&ref)
2334 vec_safe_iterate (ref_list.references, i, &ref);
2336 return ref;
2339 /* Iterates I-th referring item in the list, REF is also set. */
2341 inline ipa_ref *
2342 symtab_node::iterate_referring (unsigned i, ipa_ref *&ref)
2344 ref_list.referring.iterate (i, &ref);
2346 return ref;
2349 /* Iterates I-th referring alias item in the list, REF is also set. */
2351 inline ipa_ref *
2352 symtab_node::iterate_direct_aliases (unsigned i, ipa_ref *&ref)
2354 ref_list.referring.iterate (i, &ref);
2356 if (ref && ref->use != IPA_REF_ALIAS)
2357 return NULL;
2359 return ref;
2362 /* Return true if list contains an alias. */
2364 inline bool
2365 symtab_node::has_aliases_p (void)
2367 ipa_ref *ref = NULL;
2369 return (iterate_direct_aliases (0, ref) != NULL);
2372 /* Return true when RESOLUTION indicate that linker will use
2373 the symbol from non-LTO object files. */
2375 inline bool
2376 resolution_used_from_other_file_p (enum ld_plugin_symbol_resolution resolution)
2378 return (resolution == LDPR_PREVAILING_DEF
2379 || resolution == LDPR_PREEMPTED_REG
2380 || resolution == LDPR_RESOLVED_EXEC
2381 || resolution == LDPR_RESOLVED_DYN);
2384 /* Return true when symtab_node is known to be used from other (non-LTO)
2385 object file. Known only when doing LTO via linker plugin. */
2387 inline bool
2388 symtab_node::used_from_object_file_p (void)
2390 if (!TREE_PUBLIC (decl) || DECL_EXTERNAL (decl))
2391 return false;
2392 if (resolution_used_from_other_file_p (resolution))
2393 return true;
2394 return false;
2397 /* Return varpool node for given symbol and check it is a function. */
2399 inline varpool_node *
2400 varpool_node::get (const_tree decl)
2402 gcc_checking_assert (TREE_CODE (decl) == VAR_DECL);
2403 return dyn_cast<varpool_node *> (symtab_node::get (decl));
2406 /* Register a symbol NODE. */
2408 inline void
2409 symbol_table::register_symbol (symtab_node *node)
2411 node->next = nodes;
2412 node->previous = NULL;
2414 if (nodes)
2415 nodes->previous = node;
2416 nodes = node;
2418 node->order = order++;
2421 /* Register a top-level asm statement ASM_STR. */
2423 asm_node *
2424 symbol_table::finalize_toplevel_asm (tree asm_str)
2426 asm_node *node;
2428 node = ggc_cleared_alloc<asm_node> ();
2429 node->asm_str = asm_str;
2430 node->order = order++;
2431 node->next = NULL;
2433 if (asmnodes == NULL)
2434 asmnodes = node;
2435 else
2436 asm_last_node->next = node;
2438 asm_last_node = node;
2439 return node;
2442 /* Unregister a symbol NODE. */
2443 inline void
2444 symbol_table::unregister (symtab_node *node)
2446 if (node->previous)
2447 node->previous->next = node->next;
2448 else
2449 nodes = node->next;
2451 if (node->next)
2452 node->next->previous = node->previous;
2454 node->next = NULL;
2455 node->previous = NULL;
2458 /* Release a callgraph NODE with UID and put in to the list of free nodes. */
2460 inline void
2461 symbol_table::release_symbol (cgraph_node *node, int uid)
2463 cgraph_count--;
2465 /* Clear out the node to NULL all pointers and add the node to the free
2466 list. */
2467 memset (node, 0, sizeof (*node));
2468 node->type = SYMTAB_FUNCTION;
2469 node->uid = uid;
2470 SET_NEXT_FREE_NODE (node, free_nodes);
2471 free_nodes = node;
2474 /* Allocate new callgraph node. */
2476 inline cgraph_node *
2477 symbol_table::allocate_cgraph_symbol (void)
2479 cgraph_node *node;
2481 if (free_nodes)
2483 node = free_nodes;
2484 free_nodes = NEXT_FREE_NODE (node);
2486 else
2488 node = ggc_cleared_alloc<cgraph_node> ();
2489 node->uid = cgraph_max_uid++;
2492 node->summary_uid = cgraph_max_summary_uid++;
2493 return node;
2497 /* Return first static symbol with definition. */
2498 inline symtab_node *
2499 symbol_table::first_symbol (void)
2501 return nodes;
2504 /* Walk all symbols. */
2505 #define FOR_EACH_SYMBOL(node) \
2506 for ((node) = symtab->first_symbol (); (node); (node) = (node)->next)
2508 /* Return first static symbol with definition. */
2509 inline symtab_node *
2510 symbol_table::first_defined_symbol (void)
2512 symtab_node *node;
2514 for (node = nodes; node; node = node->next)
2515 if (node->definition)
2516 return node;
2518 return NULL;
2521 /* Walk all symbols with definitions in current unit. */
2522 #define FOR_EACH_DEFINED_SYMBOL(node) \
2523 for ((node) = symtab->first_defined_symbol (); (node); \
2524 (node) = node->next_defined_symbol ())
2526 /* Return first variable. */
2527 inline varpool_node *
2528 symbol_table::first_variable (void)
2530 symtab_node *node;
2531 for (node = nodes; node; node = node->next)
2532 if (varpool_node *vnode = dyn_cast <varpool_node *> (node))
2533 return vnode;
2534 return NULL;
2537 /* Return next variable after NODE. */
2538 inline varpool_node *
2539 symbol_table::next_variable (varpool_node *node)
2541 symtab_node *node1 = node->next;
2542 for (; node1; node1 = node1->next)
2543 if (varpool_node *vnode1 = dyn_cast <varpool_node *> (node1))
2544 return vnode1;
2545 return NULL;
2547 /* Walk all variables. */
2548 #define FOR_EACH_VARIABLE(node) \
2549 for ((node) = symtab->first_variable (); \
2550 (node); \
2551 (node) = symtab->next_variable ((node)))
2553 /* Return first static variable with initializer. */
2554 inline varpool_node *
2555 symbol_table::first_static_initializer (void)
2557 symtab_node *node;
2558 for (node = nodes; node; node = node->next)
2560 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2561 if (vnode && DECL_INITIAL (node->decl))
2562 return vnode;
2564 return NULL;
2567 /* Return next static variable with initializer after NODE. */
2568 inline varpool_node *
2569 symbol_table::next_static_initializer (varpool_node *node)
2571 symtab_node *node1 = node->next;
2572 for (; node1; node1 = node1->next)
2574 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2575 if (vnode1 && DECL_INITIAL (node1->decl))
2576 return vnode1;
2578 return NULL;
2581 /* Walk all static variables with initializer set. */
2582 #define FOR_EACH_STATIC_INITIALIZER(node) \
2583 for ((node) = symtab->first_static_initializer (); (node); \
2584 (node) = symtab->next_static_initializer (node))
2586 /* Return first static variable with definition. */
2587 inline varpool_node *
2588 symbol_table::first_defined_variable (void)
2590 symtab_node *node;
2591 for (node = nodes; node; node = node->next)
2593 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2594 if (vnode && vnode->definition)
2595 return vnode;
2597 return NULL;
2600 /* Return next static variable with definition after NODE. */
2601 inline varpool_node *
2602 symbol_table::next_defined_variable (varpool_node *node)
2604 symtab_node *node1 = node->next;
2605 for (; node1; node1 = node1->next)
2607 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2608 if (vnode1 && vnode1->definition)
2609 return vnode1;
2611 return NULL;
2613 /* Walk all variables with definitions in current unit. */
2614 #define FOR_EACH_DEFINED_VARIABLE(node) \
2615 for ((node) = symtab->first_defined_variable (); (node); \
2616 (node) = symtab->next_defined_variable (node))
2618 /* Return first function with body defined. */
2619 inline cgraph_node *
2620 symbol_table::first_defined_function (void)
2622 symtab_node *node;
2623 for (node = nodes; node; node = node->next)
2625 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2626 if (cn && cn->definition)
2627 return cn;
2629 return NULL;
2632 /* Return next function with body defined after NODE. */
2633 inline cgraph_node *
2634 symbol_table::next_defined_function (cgraph_node *node)
2636 symtab_node *node1 = node->next;
2637 for (; node1; node1 = node1->next)
2639 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2640 if (cn1 && cn1->definition)
2641 return cn1;
2643 return NULL;
2646 /* Walk all functions with body defined. */
2647 #define FOR_EACH_DEFINED_FUNCTION(node) \
2648 for ((node) = symtab->first_defined_function (); (node); \
2649 (node) = symtab->next_defined_function ((node)))
2651 /* Return first function. */
2652 inline cgraph_node *
2653 symbol_table::first_function (void)
2655 symtab_node *node;
2656 for (node = nodes; node; node = node->next)
2657 if (cgraph_node *cn = dyn_cast <cgraph_node *> (node))
2658 return cn;
2659 return NULL;
2662 /* Return next function. */
2663 inline cgraph_node *
2664 symbol_table::next_function (cgraph_node *node)
2666 symtab_node *node1 = node->next;
2667 for (; node1; node1 = node1->next)
2668 if (cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1))
2669 return cn1;
2670 return NULL;
2673 /* Return first function with body defined. */
2674 inline cgraph_node *
2675 symbol_table::first_function_with_gimple_body (void)
2677 symtab_node *node;
2678 for (node = nodes; node; node = node->next)
2680 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2681 if (cn && cn->has_gimple_body_p ())
2682 return cn;
2684 return NULL;
2687 /* Return next reachable static variable with initializer after NODE. */
2688 inline cgraph_node *
2689 symbol_table::next_function_with_gimple_body (cgraph_node *node)
2691 symtab_node *node1 = node->next;
2692 for (; node1; node1 = node1->next)
2694 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2695 if (cn1 && cn1->has_gimple_body_p ())
2696 return cn1;
2698 return NULL;
2701 /* Walk all functions. */
2702 #define FOR_EACH_FUNCTION(node) \
2703 for ((node) = symtab->first_function (); (node); \
2704 (node) = symtab->next_function ((node)))
2706 /* Return true when callgraph node is a function with Gimple body defined
2707 in current unit. Functions can also be define externally or they
2708 can be thunks with no Gimple representation.
2710 Note that at WPA stage, the function body may not be present in memory. */
2712 inline bool
2713 cgraph_node::has_gimple_body_p (void)
2715 return definition && !thunk.thunk_p && !alias;
2718 /* Walk all functions with body defined. */
2719 #define FOR_EACH_FUNCTION_WITH_GIMPLE_BODY(node) \
2720 for ((node) = symtab->first_function_with_gimple_body (); (node); \
2721 (node) = symtab->next_function_with_gimple_body (node))
2723 /* Uniquize all constants that appear in memory.
2724 Each constant in memory thus far output is recorded
2725 in `const_desc_table'. */
2727 struct GTY((for_user)) constant_descriptor_tree {
2728 /* A MEM for the constant. */
2729 rtx rtl;
2731 /* The value of the constant. */
2732 tree value;
2734 /* Hash of value. Computing the hash from value each time
2735 hashfn is called can't work properly, as that means recursive
2736 use of the hash table during hash table expansion. */
2737 hashval_t hash;
2740 /* Return true when function is only called directly or it has alias.
2741 i.e. it is not externally visible, address was not taken and
2742 it is not used in any other non-standard way. */
2744 inline bool
2745 cgraph_node::only_called_directly_or_aliased_p (void)
2747 gcc_assert (!global.inlined_to);
2748 return (!force_output && !address_taken
2749 && !used_from_other_partition
2750 && !DECL_VIRTUAL_P (decl)
2751 && !DECL_STATIC_CONSTRUCTOR (decl)
2752 && !DECL_STATIC_DESTRUCTOR (decl)
2753 && !used_from_object_file_p ()
2754 && !externally_visible);
2757 /* Return true when function can be removed from callgraph
2758 if all direct calls are eliminated. */
2760 inline bool
2761 cgraph_node::can_remove_if_no_direct_calls_and_refs_p (void)
2763 gcc_checking_assert (!global.inlined_to);
2764 /* Instrumentation clones should not be removed before
2765 instrumentation happens. New callers may appear after
2766 instrumentation. */
2767 if (instrumentation_clone
2768 && !chkp_function_instrumented_p (decl))
2769 return false;
2770 /* Extern inlines can always go, we will use the external definition. */
2771 if (DECL_EXTERNAL (decl))
2772 return true;
2773 /* When function is needed, we can not remove it. */
2774 if (force_output || used_from_other_partition)
2775 return false;
2776 if (DECL_STATIC_CONSTRUCTOR (decl)
2777 || DECL_STATIC_DESTRUCTOR (decl))
2778 return false;
2779 /* Only COMDAT functions can be removed if externally visible. */
2780 if (externally_visible
2781 && (!DECL_COMDAT (decl)
2782 || forced_by_abi
2783 || used_from_object_file_p ()))
2784 return false;
2785 return true;
2788 /* Return true when variable can be removed from variable pool
2789 if all direct calls are eliminated. */
2791 inline bool
2792 varpool_node::can_remove_if_no_refs_p (void)
2794 if (DECL_EXTERNAL (decl))
2795 return true;
2796 return (!force_output && !used_from_other_partition
2797 && ((DECL_COMDAT (decl)
2798 && !forced_by_abi
2799 && !used_from_object_file_p ())
2800 || !externally_visible
2801 || DECL_HAS_VALUE_EXPR_P (decl)));
2804 /* Return true when all references to variable must be visible in ipa_ref_list.
2805 i.e. if the variable is not externally visible or not used in some magic
2806 way (asm statement or such).
2807 The magic uses are all summarized in force_output flag. */
2809 inline bool
2810 varpool_node::all_refs_explicit_p ()
2812 return (definition
2813 && !externally_visible
2814 && !used_from_other_partition
2815 && !force_output);
2818 struct tree_descriptor_hasher : ggc_hasher<constant_descriptor_tree *>
2820 static hashval_t hash (constant_descriptor_tree *);
2821 static bool equal (constant_descriptor_tree *, constant_descriptor_tree *);
2824 /* Constant pool accessor function. */
2825 hash_table<tree_descriptor_hasher> *constant_pool_htab (void);
2827 /* Return node that alias is aliasing. */
2829 inline cgraph_node *
2830 cgraph_node::get_alias_target (void)
2832 return dyn_cast <cgraph_node *> (symtab_node::get_alias_target ());
2835 /* Return node that alias is aliasing. */
2837 inline varpool_node *
2838 varpool_node::get_alias_target (void)
2840 return dyn_cast <varpool_node *> (symtab_node::get_alias_target ());
2843 /* Walk the alias chain to return the symbol NODE is alias of.
2844 If NODE is not an alias, return NODE.
2845 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2847 inline symtab_node *
2848 symtab_node::ultimate_alias_target (enum availability *availability)
2850 if (!alias)
2852 if (availability)
2853 *availability = get_availability ();
2854 return this;
2857 return ultimate_alias_target_1 (availability);
2860 /* Given function symbol, walk the alias chain to return the function node
2861 is alias of. Do not walk through thunks.
2862 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2864 inline cgraph_node *
2865 cgraph_node::ultimate_alias_target (enum availability *availability)
2867 cgraph_node *n = dyn_cast <cgraph_node *>
2868 (symtab_node::ultimate_alias_target (availability));
2869 if (!n && availability)
2870 *availability = AVAIL_NOT_AVAILABLE;
2871 return n;
2874 /* For given variable pool node, walk the alias chain to return the function
2875 the variable is alias of. Do not walk through thunks.
2876 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2878 inline varpool_node *
2879 varpool_node::ultimate_alias_target (availability *availability)
2881 varpool_node *n = dyn_cast <varpool_node *>
2882 (symtab_node::ultimate_alias_target (availability));
2884 if (!n && availability)
2885 *availability = AVAIL_NOT_AVAILABLE;
2886 return n;
2889 /* Set callee N of call graph edge and add it to the corresponding set of
2890 callers. */
2892 inline void
2893 cgraph_edge::set_callee (cgraph_node *n)
2895 prev_caller = NULL;
2896 if (n->callers)
2897 n->callers->prev_caller = this;
2898 next_caller = n->callers;
2899 n->callers = this;
2900 callee = n;
2903 /* Redirect callee of the edge to N. The function does not update underlying
2904 call expression. */
2906 inline void
2907 cgraph_edge::redirect_callee (cgraph_node *n)
2909 /* Remove from callers list of the current callee. */
2910 remove_callee ();
2912 /* Insert to callers list of the new callee. */
2913 set_callee (n);
2916 /* Return true when the edge represents a direct recursion. */
2918 inline bool
2919 cgraph_edge::recursive_p (void)
2921 cgraph_node *c = callee->ultimate_alias_target ();
2922 if (caller->global.inlined_to)
2923 return caller->global.inlined_to->decl == c->decl;
2924 else
2925 return caller->decl == c->decl;
2928 /* Remove the edge from the list of the callers of the callee. */
2930 inline void
2931 cgraph_edge::remove_callee (void)
2933 gcc_assert (!indirect_unknown_callee);
2934 if (prev_caller)
2935 prev_caller->next_caller = next_caller;
2936 if (next_caller)
2937 next_caller->prev_caller = prev_caller;
2938 if (!prev_caller)
2939 callee->callers = next_caller;
2942 /* Return true if the TM_CLONE bit is set for a given FNDECL. */
2943 static inline bool
2944 decl_is_tm_clone (const_tree fndecl)
2946 cgraph_node *n = cgraph_node::get (fndecl);
2947 if (n)
2948 return n->tm_clone;
2949 return false;
2952 /* Likewise indicate that a node is needed, i.e. reachable via some
2953 external means. */
2955 inline void
2956 cgraph_node::mark_force_output (void)
2958 force_output = 1;
2959 gcc_checking_assert (!global.inlined_to);
2962 /* Return true if function should be optimized for size. */
2964 inline bool
2965 cgraph_node::optimize_for_size_p (void)
2967 if (opt_for_fn (decl, optimize_size))
2968 return true;
2969 if (frequency == NODE_FREQUENCY_UNLIKELY_EXECUTED)
2970 return true;
2971 else
2972 return false;
2975 /* Return symtab_node for NODE or create one if it is not present
2976 in symtab. */
2978 inline symtab_node *
2979 symtab_node::get_create (tree node)
2981 if (TREE_CODE (node) == VAR_DECL)
2982 return varpool_node::get_create (node);
2983 else
2984 return cgraph_node::get_create (node);
2987 /* Return availability of NODE. */
2989 inline enum availability
2990 symtab_node::get_availability (void)
2992 if (is_a <cgraph_node *> (this))
2993 return dyn_cast <cgraph_node *> (this)->get_availability ();
2994 else
2995 return dyn_cast <varpool_node *> (this)->get_availability ();
2998 /* Call calback on symtab node and aliases associated to this node.
2999 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
3000 skipped. */
3002 inline bool
3003 symtab_node::call_for_symbol_and_aliases (bool (*callback) (symtab_node *,
3004 void *),
3005 void *data,
3006 bool include_overwritable)
3008 if (callback (this, data))
3009 return true;
3010 if (has_aliases_p ())
3011 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3012 return false;
3015 /* Call callback on function and aliases associated to the function.
3016 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
3017 skipped. */
3019 inline bool
3020 cgraph_node::call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
3021 void *),
3022 void *data,
3023 bool include_overwritable)
3025 if (callback (this, data))
3026 return true;
3027 if (has_aliases_p ())
3028 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3029 return false;
3032 /* Call calback on varpool symbol and aliases associated to varpool symbol.
3033 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
3034 skipped. */
3036 inline bool
3037 varpool_node::call_for_symbol_and_aliases (bool (*callback) (varpool_node *,
3038 void *),
3039 void *data,
3040 bool include_overwritable)
3042 if (callback (this, data))
3043 return true;
3044 if (has_aliases_p ())
3045 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3046 return false;
3049 /* Return true if NODE's address can be compared. */
3051 inline bool
3052 symtab_node::address_can_be_compared_p ()
3054 /* Address of virtual tables and functions is never compared. */
3055 if (DECL_VIRTUAL_P (decl))
3056 return false;
3057 /* Address of C++ cdtors is never compared. */
3058 if (is_a <cgraph_node *> (this)
3059 && (DECL_CXX_CONSTRUCTOR_P (decl)
3060 || DECL_CXX_DESTRUCTOR_P (decl)))
3061 return false;
3062 /* Constant pool symbols addresses are never compared.
3063 flag_merge_constants permits us to assume the same on readonly vars. */
3064 if (is_a <varpool_node *> (this)
3065 && (DECL_IN_CONSTANT_POOL (decl)
3066 || (flag_merge_constants >= 2
3067 && TREE_READONLY (decl) && !TREE_THIS_VOLATILE (decl))))
3068 return false;
3069 return true;
3072 /* Return true if refernece may be used in address compare. */
3074 inline bool
3075 ipa_ref::address_matters_p ()
3077 if (use != IPA_REF_ADDR)
3078 return false;
3079 /* Addresses taken from virtual tables are never compared. */
3080 if (is_a <varpool_node *> (referring)
3081 && DECL_VIRTUAL_P (referring->decl))
3082 return false;
3083 return referred->address_can_be_compared_p ();
3086 /* Build polymorphic call context for indirect call E. */
3088 inline
3089 ipa_polymorphic_call_context::ipa_polymorphic_call_context (cgraph_edge *e)
3091 gcc_checking_assert (e->indirect_info->polymorphic);
3092 *this = e->indirect_info->context;
3095 /* Build empty "I know nothing" context. */
3097 inline
3098 ipa_polymorphic_call_context::ipa_polymorphic_call_context ()
3100 clear_speculation ();
3101 clear_outer_type ();
3102 invalid = false;
3105 /* Make context non-speculative. */
3107 inline void
3108 ipa_polymorphic_call_context::clear_speculation ()
3110 speculative_outer_type = NULL;
3111 speculative_offset = 0;
3112 speculative_maybe_derived_type = false;
3115 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
3116 NULL, the context is set to dummy "I know nothing" setting. */
3118 inline void
3119 ipa_polymorphic_call_context::clear_outer_type (tree otr_type)
3121 outer_type = otr_type ? TYPE_MAIN_VARIANT (otr_type) : NULL;
3122 offset = 0;
3123 maybe_derived_type = true;
3124 maybe_in_construction = true;
3125 dynamic = true;
3128 /* Adjust all offsets in contexts by OFF bits. */
3130 inline void
3131 ipa_polymorphic_call_context::offset_by (HOST_WIDE_INT off)
3133 if (outer_type)
3134 offset += off;
3135 if (speculative_outer_type)
3136 speculative_offset += off;
3139 /* Return TRUE if context is fully useless. */
3141 inline bool
3142 ipa_polymorphic_call_context::useless_p () const
3144 return (!outer_type && !speculative_outer_type);
3147 /* Return true if NODE is local. Instrumentation clones are counted as local
3148 only when original function is local. */
3150 static inline bool
3151 cgraph_local_p (cgraph_node *node)
3153 if (!node->instrumentation_clone || !node->instrumented_version)
3154 return node->local.local;
3156 return node->local.local && node->instrumented_version->local.local;
3159 /* When using fprintf (or similar), problems can arise with
3160 transient generated strings. Many string-generation APIs
3161 only support one result being alive at once (e.g. by
3162 returning a pointer to a statically-allocated buffer).
3164 If there is more than one generated string within one
3165 fprintf call: the first string gets evicted or overwritten
3166 by the second, before fprintf is fully evaluated.
3167 See e.g. PR/53136.
3169 This function provides a workaround for this, by providing
3170 a simple way to create copies of these transient strings,
3171 without the need to have explicit cleanup:
3173 fprintf (dumpfile, "string 1: %s string 2:%s\n",
3174 xstrdup_for_dump (EXPR_1),
3175 xstrdup_for_dump (EXPR_2));
3177 This is actually a simple wrapper around ggc_strdup, but
3178 the name documents the intent. We require that no GC can occur
3179 within the fprintf call. */
3181 static inline const char *
3182 xstrdup_for_dump (const char *transient_str)
3184 return ggc_strdup (transient_str);
3187 #endif /* GCC_CGRAPH_H */