Fix whitespacing.
[official-gcc.git] / gcc / cgraph.h
blobb6390995ab939f530f805f9ceb2e388f9b43cd23
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
24 #include "ipa-ref.h"
25 #include "plugin-api.h"
27 class ipa_opt_pass_d;
28 typedef ipa_opt_pass_d *ipa_opt_pass;
30 /* Symbol table consists of functions and variables.
31 TODO: add labels and CONST_DECLs. */
32 enum symtab_type
34 SYMTAB_SYMBOL,
35 SYMTAB_FUNCTION,
36 SYMTAB_VARIABLE
39 /* Section names are stored as reference counted strings in GGC safe hashtable
40 (to make them survive through PCH). */
42 struct GTY((for_user)) section_hash_entry
44 int ref_count;
45 char *name; /* As long as this datastructure stays in GGC, we can not put
46 string at the tail of structure of GGC dies in horrible
47 way */
50 struct section_name_hasher : ggc_ptr_hash<section_hash_entry>
52 typedef const char *compare_type;
54 static hashval_t hash (section_hash_entry *);
55 static bool equal (section_hash_entry *, const char *);
58 enum availability
60 /* Not yet set by cgraph_function_body_availability. */
61 AVAIL_UNSET,
62 /* Function body/variable initializer is unknown. */
63 AVAIL_NOT_AVAILABLE,
64 /* Function body/variable initializer is known but might be replaced
65 by a different one from other compilation unit and thus needs to
66 be dealt with a care. Like AVAIL_NOT_AVAILABLE it can have
67 arbitrary side effects on escaping variables and functions, while
68 like AVAILABLE it might access static variables. */
69 AVAIL_INTERPOSABLE,
70 /* Function body/variable initializer is known and will be used in final
71 program. */
72 AVAIL_AVAILABLE,
73 /* Function body/variable initializer is known and all it's uses are
74 explicitly visible within current unit (ie it's address is never taken and
75 it is not exported to other units). Currently used only for functions. */
76 AVAIL_LOCAL
79 /* Classification of symbols WRT partitioning. */
80 enum symbol_partitioning_class
82 /* External declarations are ignored by partitioning algorithms and they are
83 added into the boundary later via compute_ltrans_boundary. */
84 SYMBOL_EXTERNAL,
85 /* Partitioned symbols are pur into one of partitions. */
86 SYMBOL_PARTITION,
87 /* Duplicated symbols (such as comdat or constant pool references) are
88 copied into every node needing them via add_symbol_to_partition. */
89 SYMBOL_DUPLICATE
92 /* Base of all entries in the symbol table.
93 The symtab_node is inherited by cgraph and varpol nodes. */
94 class GTY((desc ("%h.type"), tag ("SYMTAB_SYMBOL"),
95 chain_next ("%h.next"), chain_prev ("%h.previous")))
96 symtab_node
98 public:
99 /* Return name. */
100 const char *name () const;
102 /* Return asm name. */
103 const char * asm_name () const;
105 /* Add node into symbol table. This function is not used directly, but via
106 cgraph/varpool node creation routines. */
107 void register_symbol (void);
109 /* Remove symbol from symbol table. */
110 void remove (void);
112 /* Dump symtab node to F. */
113 void dump (FILE *f);
115 /* Dump symtab node to stderr. */
116 void DEBUG_FUNCTION debug (void);
118 /* Verify consistency of node. */
119 void DEBUG_FUNCTION verify (void);
121 /* Return ipa reference from this symtab_node to
122 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
123 of the use and STMT the statement (if it exists). */
124 ipa_ref *create_reference (symtab_node *referred_node,
125 enum ipa_ref_use use_type);
127 /* Return ipa reference from this symtab_node to
128 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
129 of the use and STMT the statement (if it exists). */
130 ipa_ref *create_reference (symtab_node *referred_node,
131 enum ipa_ref_use use_type, gimple *stmt);
133 /* If VAL is a reference to a function or a variable, add a reference from
134 this symtab_node to the corresponding symbol table node. USE_TYPE specify
135 type of the use and STMT the statement (if it exists). Return the new
136 reference or NULL if none was created. */
137 ipa_ref *maybe_create_reference (tree val, enum ipa_ref_use use_type,
138 gimple *stmt);
140 /* Clone all references from symtab NODE to this symtab_node. */
141 void clone_references (symtab_node *node);
143 /* Remove all stmt references in non-speculative references.
144 Those are not maintained during inlining & clonning.
145 The exception are speculative references that are updated along
146 with callgraph edges associated with them. */
147 void clone_referring (symtab_node *node);
149 /* Clone reference REF to this symtab_node and set its stmt to STMT. */
150 ipa_ref *clone_reference (ipa_ref *ref, gimple *stmt);
152 /* Find the structure describing a reference to REFERRED_NODE
153 and associated with statement STMT. */
154 ipa_ref *find_reference (symtab_node *referred_node, gimple *stmt,
155 unsigned int lto_stmt_uid);
157 /* Remove all references that are associated with statement STMT. */
158 void remove_stmt_references (gimple *stmt);
160 /* Remove all stmt references in non-speculative references.
161 Those are not maintained during inlining & clonning.
162 The exception are speculative references that are updated along
163 with callgraph edges associated with them. */
164 void clear_stmts_in_references (void);
166 /* Remove all references in ref list. */
167 void remove_all_references (void);
169 /* Remove all referring items in ref list. */
170 void remove_all_referring (void);
172 /* Dump references in ref list to FILE. */
173 void dump_references (FILE *file);
175 /* Dump referring in list to FILE. */
176 void dump_referring (FILE *);
178 /* Get number of references for this node. */
179 inline unsigned num_references (void)
181 return ref_list.references ? ref_list.references->length () : 0;
184 /* Iterates I-th reference in the list, REF is also set. */
185 ipa_ref *iterate_reference (unsigned i, ipa_ref *&ref);
187 /* Iterates I-th referring item in the list, REF is also set. */
188 ipa_ref *iterate_referring (unsigned i, ipa_ref *&ref);
190 /* Iterates I-th referring alias item in the list, REF is also set. */
191 ipa_ref *iterate_direct_aliases (unsigned i, ipa_ref *&ref);
193 /* Return true if symtab node and TARGET represents
194 semantically equivalent symbols. */
195 bool semantically_equivalent_p (symtab_node *target);
197 /* Classify symbol symtab node for partitioning. */
198 enum symbol_partitioning_class get_partitioning_class (void);
200 /* Return comdat group. */
201 tree get_comdat_group ()
203 return x_comdat_group;
206 /* Return comdat group as identifier_node. */
207 tree get_comdat_group_id ()
209 if (x_comdat_group && TREE_CODE (x_comdat_group) != IDENTIFIER_NODE)
210 x_comdat_group = DECL_ASSEMBLER_NAME (x_comdat_group);
211 return x_comdat_group;
214 /* Set comdat group. */
215 void set_comdat_group (tree group)
217 gcc_checking_assert (!group || TREE_CODE (group) == IDENTIFIER_NODE
218 || DECL_P (group));
219 x_comdat_group = group;
222 /* Return section as string. */
223 const char * get_section ()
225 if (!x_section)
226 return NULL;
227 return x_section->name;
230 /* Remove node from same comdat group. */
231 void remove_from_same_comdat_group (void);
233 /* Add this symtab_node to the same comdat group that OLD is in. */
234 void add_to_same_comdat_group (symtab_node *old_node);
236 /* Dissolve the same_comdat_group list in which NODE resides. */
237 void dissolve_same_comdat_group_list (void);
239 /* Return true when symtab_node is known to be used from other (non-LTO)
240 object file. Known only when doing LTO via linker plugin. */
241 bool used_from_object_file_p (void);
243 /* Walk the alias chain to return the symbol NODE is alias of.
244 If NODE is not an alias, return NODE.
245 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
246 symtab_node *ultimate_alias_target (enum availability *avail = NULL);
248 /* Return next reachable static symbol with initializer after NODE. */
249 inline symtab_node *next_defined_symbol (void);
251 /* Add reference recording that symtab node is alias of TARGET.
252 The function can fail in the case of aliasing cycles; in this case
253 it returns false. */
254 bool resolve_alias (symtab_node *target);
256 /* C++ FE sometimes change linkage flags after producing same
257 body aliases. */
258 void fixup_same_cpp_alias_visibility (symtab_node *target);
260 /* Call callback on symtab node and aliases associated to this node.
261 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
262 skipped. */
263 bool call_for_symbol_and_aliases (bool (*callback) (symtab_node *, void *),
264 void *data,
265 bool include_overwrite);
267 /* If node can not be interposable by static or dynamic linker to point to
268 different definition, return this symbol. Otherwise look for alias with
269 such property and if none exists, introduce new one. */
270 symtab_node *noninterposable_alias (void);
272 /* Return node that alias is aliasing. */
273 inline symtab_node *get_alias_target (void);
275 /* Set section for symbol and its aliases. */
276 void set_section (const char *section);
278 /* Set section, do not recurse into aliases.
279 When one wants to change section of symbol and its aliases,
280 use set_section. */
281 void set_section_for_node (const char *section);
283 /* Set initialization priority to PRIORITY. */
284 void set_init_priority (priority_type priority);
286 /* Return the initialization priority. */
287 priority_type get_init_priority ();
289 /* Return availability of NODE. */
290 enum availability get_availability (void);
292 /* Make DECL local. */
293 void make_decl_local (void);
295 /* Return desired alignment of the definition. This is NOT alignment useful
296 to access THIS, because THIS may be interposable and DECL_ALIGN should
297 be used instead. It however must be guaranteed when output definition
298 of THIS. */
299 unsigned int definition_alignment ();
301 /* Return true if alignment can be increased. */
302 bool can_increase_alignment_p ();
304 /* Increase alignment of symbol to ALIGN. */
305 void increase_alignment (unsigned int align);
307 /* Return true if list contains an alias. */
308 bool has_aliases_p (void);
310 /* Return true when the symbol is real symbol, i.e. it is not inline clone
311 or abstract function kept for debug info purposes only. */
312 bool real_symbol_p (void);
314 /* Determine if symbol declaration is needed. That is, visible to something
315 either outside this translation unit, something magic in the system
316 configury. This function is used just during symbol creation. */
317 bool needed_p (void);
319 /* Return true when there are references to the node. */
320 bool referred_to_p (bool include_self = true);
322 /* Return true if NODE can be discarded by linker from the binary. */
323 inline bool
324 can_be_discarded_p (void)
326 return (DECL_EXTERNAL (decl)
327 || (get_comdat_group ()
328 && resolution != LDPR_PREVAILING_DEF
329 && resolution != LDPR_PREVAILING_DEF_IRONLY
330 && resolution != LDPR_PREVAILING_DEF_IRONLY_EXP));
333 /* Return true if NODE is local to a particular COMDAT group, and must not
334 be named from outside the COMDAT. This is used for C++ decloned
335 constructors. */
336 inline bool comdat_local_p (void)
338 return (same_comdat_group && !TREE_PUBLIC (decl));
341 /* Return true if ONE and TWO are part of the same COMDAT group. */
342 inline bool in_same_comdat_group_p (symtab_node *target);
344 /* Return true if symbol is known to be nonzero. */
345 bool nonzero_address ();
347 /* Return 0 if symbol is known to have different address than S2,
348 Return 1 if symbol is known to have same address as S2,
349 return 2 otherwise. */
350 int equal_address_to (symtab_node *s2);
352 /* Return true if symbol's address may possibly be compared to other
353 symbol's address. */
354 bool address_matters_p ();
356 /* Return true if NODE's address can be compared. This use properties
357 of NODE only and does not look if the address is actually taken in
358 interesting way. For that use ADDRESS_MATTERS_P instead. */
359 bool address_can_be_compared_p (void);
361 /* Return symbol table node associated with DECL, if any,
362 and NULL otherwise. */
363 static inline symtab_node *get (const_tree decl)
365 /* Check that we are called for sane type of object - functions
366 and static or external variables. */
367 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL
368 || (TREE_CODE (decl) == VAR_DECL
369 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl)
370 || in_lto_p)));
371 /* Check that the mapping is sane - perhaps this check can go away,
372 but at the moment frontends tends to corrupt the mapping by calling
373 memcpy/memset on the tree nodes. */
374 gcc_checking_assert (!decl->decl_with_vis.symtab_node
375 || decl->decl_with_vis.symtab_node->decl == decl);
376 return decl->decl_with_vis.symtab_node;
379 /* Try to find a symtab node for declaration DECL and if it does not
380 exist or if it corresponds to an inline clone, create a new one. */
381 static inline symtab_node * get_create (tree node);
383 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
384 Return NULL if there's no such node. */
385 static symtab_node *get_for_asmname (const_tree asmname);
387 /* Dump symbol table to F. */
388 static void dump_table (FILE *);
390 /* Dump symbol table to stderr. */
391 static inline DEBUG_FUNCTION void debug_symtab (void)
393 dump_table (stderr);
396 /* Verify symbol table for internal consistency. */
397 static DEBUG_FUNCTION void verify_symtab_nodes (void);
399 /* Perform internal consistency checks, if they are enabled. */
400 static inline void checking_verify_symtab_nodes (void);
402 /* Type of the symbol. */
403 ENUM_BITFIELD (symtab_type) type : 8;
405 /* The symbols resolution. */
406 ENUM_BITFIELD (ld_plugin_symbol_resolution) resolution : 8;
408 /*** Flags representing the symbol type. ***/
410 /* True when symbol corresponds to a definition in current unit.
411 set via finalize_function or finalize_decl */
412 unsigned definition : 1;
413 /* True when symbol is an alias.
414 Set by ssemble_alias. */
415 unsigned alias : 1;
416 /* True when alias is a weakref. */
417 unsigned weakref : 1;
418 /* C++ frontend produce same body aliases and extra name aliases for
419 virtual functions and vtables that are obviously equivalent.
420 Those aliases are bit special, especially because C++ frontend
421 visibility code is so ugly it can not get them right at first time
422 and their visibility needs to be copied from their "masters" at
423 the end of parsing. */
424 unsigned cpp_implicit_alias : 1;
425 /* Set once the definition was analyzed. The list of references and
426 other properties are built during analysis. */
427 unsigned analyzed : 1;
428 /* Set for write-only variables. */
429 unsigned writeonly : 1;
430 /* Visibility of symbol was used for further optimization; do not
431 permit further changes. */
432 unsigned refuse_visibility_changes : 1;
434 /*** Visibility and linkage flags. ***/
436 /* Set when function is visible by other units. */
437 unsigned externally_visible : 1;
438 /* Don't reorder to other symbols having this set. */
439 unsigned no_reorder : 1;
440 /* The symbol will be assumed to be used in an invisible way (like
441 by an toplevel asm statement). */
442 unsigned force_output : 1;
443 /* Like FORCE_OUTPUT, but in the case it is ABI requiring the symbol to be
444 exported. Unlike FORCE_OUTPUT this flag gets cleared to symbols promoted
445 to static and it does not inhibit optimization. */
446 unsigned forced_by_abi : 1;
447 /* True when the name is known to be unique and thus it does not need mangling. */
448 unsigned unique_name : 1;
449 /* Specify whether the section was set by user or by
450 compiler via -ffunction-sections. */
451 unsigned implicit_section : 1;
452 /* True when body and other characteristics have been removed by
453 symtab_remove_unreachable_nodes. */
454 unsigned body_removed : 1;
456 /*** WHOPR Partitioning flags.
457 These flags are used at ltrans stage when only part of the callgraph is
458 available. ***/
460 /* Set when variable is used from other LTRANS partition. */
461 unsigned used_from_other_partition : 1;
462 /* Set when function is available in the other LTRANS partition.
463 During WPA output it is used to mark nodes that are present in
464 multiple partitions. */
465 unsigned in_other_partition : 1;
469 /*** other flags. ***/
471 /* Set when symbol has address taken. */
472 unsigned address_taken : 1;
473 /* Set when init priority is set. */
474 unsigned in_init_priority_hash : 1;
476 /* Set when symbol needs to be streamed into LTO bytecode for LTO, or in case
477 of offloading, for separate compilation for a different target. */
478 unsigned need_lto_streaming : 1;
480 /* Set when symbol can be streamed into bytecode for offloading. */
481 unsigned offloadable : 1;
484 /* Ordering of all symtab entries. */
485 int order;
487 /* Declaration representing the symbol. */
488 tree decl;
490 /* Linked list of symbol table entries starting with symtab_nodes. */
491 symtab_node *next;
492 symtab_node *previous;
494 /* Linked list of symbols with the same asm name. There may be multiple
495 entries for single symbol name during LTO, because symbols are renamed
496 only after partitioning.
498 Because inline clones are kept in the assembler name has, they also produce
499 duplicate entries.
501 There are also several long standing bugs where frontends and builtin
502 code produce duplicated decls. */
503 symtab_node *next_sharing_asm_name;
504 symtab_node *previous_sharing_asm_name;
506 /* Circular list of nodes in the same comdat group if non-NULL. */
507 symtab_node *same_comdat_group;
509 /* Vectors of referring and referenced entities. */
510 ipa_ref_list ref_list;
512 /* Alias target. May be either DECL pointer or ASSEMBLER_NAME pointer
513 depending to what was known to frontend on the creation time.
514 Once alias is resolved, this pointer become NULL. */
515 tree alias_target;
517 /* File stream where this node is being written to. */
518 struct lto_file_decl_data * lto_file_data;
520 PTR GTY ((skip)) aux;
522 /* Comdat group the symbol is in. Can be private if GGC allowed that. */
523 tree x_comdat_group;
525 /* Section name. Again can be private, if allowed. */
526 section_hash_entry *x_section;
528 protected:
529 /* Dump base fields of symtab nodes to F. Not to be used directly. */
530 void dump_base (FILE *);
532 /* Verify common part of symtab node. */
533 bool DEBUG_FUNCTION verify_base (void);
535 /* Remove node from symbol table. This function is not used directly, but via
536 cgraph/varpool node removal routines. */
537 void unregister (void);
539 /* Return the initialization and finalization priority information for
540 DECL. If there is no previous priority information, a freshly
541 allocated structure is returned. */
542 struct symbol_priority_map *priority_info (void);
544 /* Worker for call_for_symbol_and_aliases_1. */
545 bool call_for_symbol_and_aliases_1 (bool (*callback) (symtab_node *, void *),
546 void *data,
547 bool include_overwrite);
548 private:
549 /* Worker for set_section. */
550 static bool set_section (symtab_node *n, void *s);
552 /* Worker for symtab_resolve_alias. */
553 static bool set_implicit_section (symtab_node *n, void *);
555 /* Worker searching noninterposable alias. */
556 static bool noninterposable_alias (symtab_node *node, void *data);
558 /* Worker for ultimate_alias_target. */
559 symtab_node *ultimate_alias_target_1 (enum availability *avail = NULL);
562 inline void
563 symtab_node::checking_verify_symtab_nodes (void)
565 if (flag_checking)
566 symtab_node::verify_symtab_nodes ();
569 /* Walk all aliases for NODE. */
570 #define FOR_EACH_ALIAS(node, alias) \
571 for (unsigned x_i = 0; node->iterate_direct_aliases (x_i, alias); x_i++)
573 /* This is the information that is put into the cgraph local structure
574 to recover a function. */
575 struct lto_file_decl_data;
577 extern const char * const cgraph_availability_names[];
578 extern const char * const ld_plugin_symbol_resolution_names[];
579 extern const char * const tls_model_names[];
581 /* Information about thunk, used only for same body aliases. */
583 struct GTY(()) cgraph_thunk_info {
584 /* Information about the thunk. */
585 HOST_WIDE_INT fixed_offset;
586 HOST_WIDE_INT virtual_value;
587 tree alias;
588 bool this_adjusting;
589 bool virtual_offset_p;
590 bool add_pointer_bounds_args;
591 /* Set to true when alias node is thunk. */
592 bool thunk_p;
595 /* Information about the function collected locally.
596 Available after function is analyzed. */
598 struct GTY(()) cgraph_local_info {
599 /* Set when function is visible in current compilation unit only and
600 its address is never taken. */
601 unsigned local : 1;
603 /* False when there is something makes versioning impossible. */
604 unsigned versionable : 1;
606 /* False when function calling convention and signature can not be changed.
607 This is the case when __builtin_apply_args is used. */
608 unsigned can_change_signature : 1;
610 /* True when the function has been originally extern inline, but it is
611 redefined now. */
612 unsigned redefined_extern_inline : 1;
614 /* True if the function may enter serial irrevocable mode. */
615 unsigned tm_may_enter_irr : 1;
618 /* Information about the function that needs to be computed globally
619 once compilation is finished. Available only with -funit-at-a-time. */
621 struct GTY(()) cgraph_global_info {
622 /* For inline clones this points to the function they will be
623 inlined into. */
624 cgraph_node *inlined_to;
627 /* Represent which DECL tree (or reference to such tree)
628 will be replaced by another tree while versioning. */
629 struct GTY(()) ipa_replace_map
631 /* The tree that will be replaced. */
632 tree old_tree;
633 /* The new (replacing) tree. */
634 tree new_tree;
635 /* Parameter number to replace, when old_tree is NULL. */
636 int parm_num;
637 /* True when a substitution should be done, false otherwise. */
638 bool replace_p;
639 /* True when we replace a reference to old_tree. */
640 bool ref_p;
643 struct GTY(()) cgraph_clone_info
645 vec<ipa_replace_map *, va_gc> *tree_map;
646 bitmap args_to_skip;
647 bitmap combined_args_to_skip;
650 enum cgraph_simd_clone_arg_type
652 SIMD_CLONE_ARG_TYPE_VECTOR,
653 SIMD_CLONE_ARG_TYPE_UNIFORM,
654 /* These are only for integer/pointer arguments passed by value. */
655 SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP,
656 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP,
657 /* These 6 are only for reference type arguments or arguments passed
658 by reference. */
659 SIMD_CLONE_ARG_TYPE_LINEAR_REF_CONSTANT_STEP,
660 SIMD_CLONE_ARG_TYPE_LINEAR_REF_VARIABLE_STEP,
661 SIMD_CLONE_ARG_TYPE_LINEAR_UVAL_CONSTANT_STEP,
662 SIMD_CLONE_ARG_TYPE_LINEAR_UVAL_VARIABLE_STEP,
663 SIMD_CLONE_ARG_TYPE_LINEAR_VAL_CONSTANT_STEP,
664 SIMD_CLONE_ARG_TYPE_LINEAR_VAL_VARIABLE_STEP,
665 SIMD_CLONE_ARG_TYPE_MASK
668 /* Function arguments in the original function of a SIMD clone.
669 Supplementary data for `struct simd_clone'. */
671 struct GTY(()) cgraph_simd_clone_arg {
672 /* Original function argument as it originally existed in
673 DECL_ARGUMENTS. */
674 tree orig_arg;
676 /* orig_arg's function (or for extern functions type from
677 TYPE_ARG_TYPES). */
678 tree orig_type;
680 /* If argument is a vector, this holds the vector version of
681 orig_arg that after adjusting the argument types will live in
682 DECL_ARGUMENTS. Otherwise, this is NULL.
684 This basically holds:
685 vector(simdlen) __typeof__(orig_arg) new_arg. */
686 tree vector_arg;
688 /* vector_arg's type (or for extern functions new vector type. */
689 tree vector_type;
691 /* If argument is a vector, this holds the array where the simd
692 argument is held while executing the simd clone function. This
693 is a local variable in the cloned function. Its content is
694 copied from vector_arg upon entry to the clone.
696 This basically holds:
697 __typeof__(orig_arg) simd_array[simdlen]. */
698 tree simd_array;
700 /* A SIMD clone's argument can be either linear (constant or
701 variable), uniform, or vector. */
702 enum cgraph_simd_clone_arg_type arg_type;
704 /* For arg_type SIMD_CLONE_ARG_TYPE_LINEAR_*CONSTANT_STEP this is
705 the constant linear step, if arg_type is
706 SIMD_CLONE_ARG_TYPE_LINEAR_*VARIABLE_STEP, this is index of
707 the uniform argument holding the step, otherwise 0. */
708 HOST_WIDE_INT linear_step;
710 /* Variable alignment if available, otherwise 0. */
711 unsigned int alignment;
714 /* Specific data for a SIMD function clone. */
716 struct GTY(()) cgraph_simd_clone {
717 /* Number of words in the SIMD lane associated with this clone. */
718 unsigned int simdlen;
720 /* Number of annotated function arguments in `args'. This is
721 usually the number of named arguments in FNDECL. */
722 unsigned int nargs;
724 /* Max hardware vector size in bits for integral vectors. */
725 unsigned int vecsize_int;
727 /* Max hardware vector size in bits for floating point vectors. */
728 unsigned int vecsize_float;
730 /* The mangling character for a given vector size. This is used
731 to determine the ISA mangling bit as specified in the Intel
732 Vector ABI. */
733 unsigned char vecsize_mangle;
735 /* True if this is the masked, in-branch version of the clone,
736 otherwise false. */
737 unsigned int inbranch : 1;
739 /* True if this is a Cilk Plus variant. */
740 unsigned int cilk_elemental : 1;
742 /* Doubly linked list of SIMD clones. */
743 cgraph_node *prev_clone, *next_clone;
745 /* Original cgraph node the SIMD clones were created for. */
746 cgraph_node *origin;
748 /* Annotated function arguments for the original function. */
749 cgraph_simd_clone_arg GTY((length ("%h.nargs"))) args[1];
752 /* Function Multiversioning info. */
753 struct GTY((for_user)) cgraph_function_version_info {
754 /* The cgraph_node for which the function version info is stored. */
755 cgraph_node *this_node;
756 /* Chains all the semantically identical function versions. The
757 first function in this chain is the version_info node of the
758 default function. */
759 cgraph_function_version_info *prev;
760 /* If this version node corresponds to a dispatcher for function
761 versions, this points to the version info node of the default
762 function, the first node in the chain. */
763 cgraph_function_version_info *next;
764 /* If this node corresponds to a function version, this points
765 to the dispatcher function decl, which is the function that must
766 be called to execute the right function version at run-time.
768 If this cgraph node is a dispatcher (if dispatcher_function is
769 true, in the cgraph_node struct) for function versions, this
770 points to resolver function, which holds the function body of the
771 dispatcher. The dispatcher decl is an alias to the resolver
772 function decl. */
773 tree dispatcher_resolver;
776 #define DEFCIFCODE(code, type, string) CIF_ ## code,
777 /* Reasons for inlining failures. */
779 enum cgraph_inline_failed_t {
780 #include "cif-code.def"
781 CIF_N_REASONS
784 enum cgraph_inline_failed_type_t
786 CIF_FINAL_NORMAL = 0,
787 CIF_FINAL_ERROR
790 struct cgraph_edge;
792 struct cgraph_edge_hasher : ggc_ptr_hash<cgraph_edge>
794 typedef gimple *compare_type;
796 static hashval_t hash (cgraph_edge *);
797 static hashval_t hash (gimple *);
798 static bool equal (cgraph_edge *, gimple *);
801 /* The cgraph data structure.
802 Each function decl has assigned cgraph_node listing callees and callers. */
804 struct GTY((tag ("SYMTAB_FUNCTION"))) cgraph_node : public symtab_node {
805 public:
806 /* Remove the node from cgraph and all inline clones inlined into it.
807 Skip however removal of FORBIDDEN_NODE and return true if it needs to be
808 removed. This allows to call the function from outer loop walking clone
809 tree. */
810 bool remove_symbol_and_inline_clones (cgraph_node *forbidden_node = NULL);
812 /* Record all references from cgraph_node that are taken
813 in statement STMT. */
814 void record_stmt_references (gimple *stmt);
816 /* Like cgraph_set_call_stmt but walk the clone tree and update all
817 clones sharing the same function body.
818 When WHOLE_SPECULATIVE_EDGES is true, all three components of
819 speculative edge gets updated. Otherwise we update only direct
820 call. */
821 void set_call_stmt_including_clones (gimple *old_stmt, gcall *new_stmt,
822 bool update_speculative = true);
824 /* Walk the alias chain to return the function cgraph_node is alias of.
825 Walk through thunk, too.
826 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
827 cgraph_node *function_symbol (enum availability *avail = NULL);
829 /* Walk the alias chain to return the function cgraph_node is alias of.
830 Walk through non virtual thunks, too. Thus we return either a function
831 or a virtual thunk node.
832 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
833 cgraph_node *function_or_virtual_thunk_symbol
834 (enum availability *avail = NULL);
836 /* Create node representing clone of N executed COUNT times. Decrease
837 the execution counts from original node too.
838 The new clone will have decl set to DECL that may or may not be the same
839 as decl of N.
841 When UPDATE_ORIGINAL is true, the counts are subtracted from the original
842 function's profile to reflect the fact that part of execution is handled
843 by node.
844 When CALL_DUPLICATOIN_HOOK is true, the ipa passes are acknowledged about
845 the new clone. Otherwise the caller is responsible for doing so later.
847 If the new node is being inlined into another one, NEW_INLINED_TO should be
848 the outline function the new one is (even indirectly) inlined to.
849 All hooks will see this in node's global.inlined_to, when invoked.
850 Can be NULL if the node is not inlined. */
851 cgraph_node *create_clone (tree decl, gcov_type count, int freq,
852 bool update_original,
853 vec<cgraph_edge *> redirect_callers,
854 bool call_duplication_hook,
855 cgraph_node *new_inlined_to,
856 bitmap args_to_skip);
858 /* Create callgraph node clone with new declaration. The actual body will
859 be copied later at compilation stage. */
860 cgraph_node *create_virtual_clone (vec<cgraph_edge *> redirect_callers,
861 vec<ipa_replace_map *, va_gc> *tree_map,
862 bitmap args_to_skip, const char * suffix);
864 /* cgraph node being removed from symbol table; see if its entry can be
865 replaced by other inline clone. */
866 cgraph_node *find_replacement (void);
868 /* Create a new cgraph node which is the new version of
869 callgraph node. REDIRECT_CALLERS holds the callers
870 edges which should be redirected to point to
871 NEW_VERSION. ALL the callees edges of the node
872 are cloned to the new version node. Return the new
873 version node.
875 If non-NULL BLOCK_TO_COPY determine what basic blocks
876 was copied to prevent duplications of calls that are dead
877 in the clone. */
879 cgraph_node *create_version_clone (tree new_decl,
880 vec<cgraph_edge *> redirect_callers,
881 bitmap bbs_to_copy);
883 /* Perform function versioning.
884 Function versioning includes copying of the tree and
885 a callgraph update (creating a new cgraph node and updating
886 its callees and callers).
888 REDIRECT_CALLERS varray includes the edges to be redirected
889 to the new version.
891 TREE_MAP is a mapping of tree nodes we want to replace with
892 new ones (according to results of prior analysis).
894 If non-NULL ARGS_TO_SKIP determine function parameters to remove
895 from new version.
896 If SKIP_RETURN is true, the new version will return void.
897 If non-NULL BLOCK_TO_COPY determine what basic blocks to copy.
898 If non_NULL NEW_ENTRY determine new entry BB of the clone.
900 Return the new version's cgraph node. */
901 cgraph_node *create_version_clone_with_body
902 (vec<cgraph_edge *> redirect_callers,
903 vec<ipa_replace_map *, va_gc> *tree_map, bitmap args_to_skip,
904 bool skip_return, bitmap bbs_to_copy, basic_block new_entry_block,
905 const char *clone_name);
907 /* Insert a new cgraph_function_version_info node into cgraph_fnver_htab
908 corresponding to cgraph_node. */
909 cgraph_function_version_info *insert_new_function_version (void);
911 /* Get the cgraph_function_version_info node corresponding to node. */
912 cgraph_function_version_info *function_version (void);
914 /* Discover all functions and variables that are trivially needed, analyze
915 them as well as all functions and variables referred by them */
916 void analyze (void);
918 /* Add thunk alias into callgraph. The alias declaration is ALIAS and it
919 aliases DECL with an adjustments made into the first parameter.
920 See comments in thunk_adjust for detail on the parameters. */
921 cgraph_node * create_thunk (tree alias, tree, bool this_adjusting,
922 HOST_WIDE_INT fixed_offset,
923 HOST_WIDE_INT virtual_value,
924 tree virtual_offset,
925 tree real_alias);
928 /* Return node that alias is aliasing. */
929 inline cgraph_node *get_alias_target (void);
931 /* Given function symbol, walk the alias chain to return the function node
932 is alias of. Do not walk through thunks.
933 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
935 cgraph_node *ultimate_alias_target (availability *availability = NULL);
937 /* Expand thunk NODE to gimple if possible.
938 When FORCE_GIMPLE_THUNK is true, gimple thunk is created and
939 no assembler is produced.
940 When OUTPUT_ASM_THUNK is true, also produce assembler for
941 thunks that are not lowered. */
942 bool expand_thunk (bool output_asm_thunks, bool force_gimple_thunk);
944 /* Call expand_thunk on all callers that are thunks and analyze those
945 nodes that were expanded. */
946 void expand_all_artificial_thunks ();
948 /* Assemble thunks and aliases associated to node. */
949 void assemble_thunks_and_aliases (void);
951 /* Expand function specified by node. */
952 void expand (void);
954 /* As an GCC extension we allow redefinition of the function. The
955 semantics when both copies of bodies differ is not well defined.
956 We replace the old body with new body so in unit at a time mode
957 we always use new body, while in normal mode we may end up with
958 old body inlined into some functions and new body expanded and
959 inlined in others. */
960 void reset (void);
962 /* Creates a wrapper from cgraph_node to TARGET node. Thunk is used for this
963 kind of wrapper method. */
964 void create_wrapper (cgraph_node *target);
966 /* Verify cgraph nodes of the cgraph node. */
967 void DEBUG_FUNCTION verify_node (void);
969 /* Remove function from symbol table. */
970 void remove (void);
972 /* Dump call graph node to file F. */
973 void dump (FILE *f);
975 /* Dump call graph node to stderr. */
976 void DEBUG_FUNCTION debug (void);
978 /* When doing LTO, read cgraph_node's body from disk if it is not already
979 present. */
980 bool get_untransformed_body (void);
982 /* Prepare function body. When doing LTO, read cgraph_node's body from disk
983 if it is not already present. When some IPA transformations are scheduled,
984 apply them. */
985 bool get_body (void);
987 /* Release memory used to represent body of function.
988 Use this only for functions that are released before being translated to
989 target code (i.e. RTL). Functions that are compiled to RTL and beyond
990 are free'd in final.c via free_after_compilation(). */
991 void release_body (bool keep_arguments = false);
993 /* Return the DECL_STRUCT_FUNCTION of the function. */
994 struct function *get_fun (void);
996 /* cgraph_node is no longer nested function; update cgraph accordingly. */
997 void unnest (void);
999 /* Bring cgraph node local. */
1000 void make_local (void);
1002 /* Likewise indicate that a node is having address taken. */
1003 void mark_address_taken (void);
1005 /* Set fialization priority to PRIORITY. */
1006 void set_fini_priority (priority_type priority);
1008 /* Return the finalization priority. */
1009 priority_type get_fini_priority (void);
1011 /* Create edge from a given function to CALLEE in the cgraph. */
1012 cgraph_edge *create_edge (cgraph_node *callee,
1013 gcall *call_stmt, gcov_type count,
1014 int freq);
1016 /* Create an indirect edge with a yet-undetermined callee where the call
1017 statement destination is a formal parameter of the caller with index
1018 PARAM_INDEX. */
1019 cgraph_edge *create_indirect_edge (gcall *call_stmt, int ecf_flags,
1020 gcov_type count, int freq,
1021 bool compute_indirect_info = true);
1023 /* Like cgraph_create_edge walk the clone tree and update all clones sharing
1024 same function body. If clones already have edge for OLD_STMT; only
1025 update the edge same way as cgraph_set_call_stmt_including_clones does. */
1026 void create_edge_including_clones (cgraph_node *callee,
1027 gimple *old_stmt, gcall *stmt,
1028 gcov_type count,
1029 int freq,
1030 cgraph_inline_failed_t reason);
1032 /* Return the callgraph edge representing the GIMPLE_CALL statement
1033 CALL_STMT. */
1034 cgraph_edge *get_edge (gimple *call_stmt);
1036 /* Collect all callers of cgraph_node and its aliases that are known to lead
1037 to NODE (i.e. are not overwritable). */
1038 vec<cgraph_edge *> collect_callers (void);
1040 /* Remove all callers from the node. */
1041 void remove_callers (void);
1043 /* Remove all callees from the node. */
1044 void remove_callees (void);
1046 /* Return function availability. See cgraph.h for description of individual
1047 return values. */
1048 enum availability get_availability (void);
1050 /* Set TREE_NOTHROW on cgraph_node's decl and on aliases of the node
1051 if any to NOTHROW. */
1052 void set_nothrow_flag (bool nothrow);
1054 /* Set TREE_READONLY on cgraph_node's decl and on aliases of the node
1055 if any to READONLY. */
1056 void set_const_flag (bool readonly, bool looping);
1058 /* Set DECL_PURE_P on cgraph_node's decl and on aliases of the node
1059 if any to PURE. */
1060 void set_pure_flag (bool pure, bool looping);
1062 /* Call callback on function and aliases associated to the function.
1063 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1064 skipped. */
1066 bool call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
1067 void *),
1068 void *data, bool include_overwritable);
1070 /* Call callback on cgraph_node, thunks and aliases associated to NODE.
1071 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1072 skipped. When EXCLUDE_VIRTUAL_THUNKS is true, virtual thunks are
1073 skipped. */
1074 bool call_for_symbol_thunks_and_aliases (bool (*callback) (cgraph_node *node,
1075 void *data),
1076 void *data,
1077 bool include_overwritable,
1078 bool exclude_virtual_thunks = false);
1080 /* Likewise indicate that a node is needed, i.e. reachable via some
1081 external means. */
1082 inline void mark_force_output (void);
1084 /* Return true when function can be marked local. */
1085 bool local_p (void);
1087 /* Return true if cgraph_node can be made local for API change.
1088 Extern inline functions and C++ COMDAT functions can be made local
1089 at the expense of possible code size growth if function is used in multiple
1090 compilation units. */
1091 bool can_be_local_p (void);
1093 /* Return true when cgraph_node can not return or throw and thus
1094 it is safe to ignore its side effects for IPA analysis. */
1095 bool cannot_return_p (void);
1097 /* Return true when function cgraph_node and all its aliases are only called
1098 directly.
1099 i.e. it is not externally visible, address was not taken and
1100 it is not used in any other non-standard way. */
1101 bool only_called_directly_p (void);
1103 /* Return true when function is only called directly or it has alias.
1104 i.e. it is not externally visible, address was not taken and
1105 it is not used in any other non-standard way. */
1106 inline bool only_called_directly_or_aliased_p (void);
1108 /* Return true when function cgraph_node can be expected to be removed
1109 from program when direct calls in this compilation unit are removed.
1111 As a special case COMDAT functions are
1112 cgraph_can_remove_if_no_direct_calls_p while the are not
1113 cgraph_only_called_directly_p (it is possible they are called from other
1114 unit)
1116 This function behaves as cgraph_only_called_directly_p because eliminating
1117 all uses of COMDAT function does not make it necessarily disappear from
1118 the program unless we are compiling whole program or we do LTO. In this
1119 case we know we win since dynamic linking will not really discard the
1120 linkonce section.
1122 If WILL_INLINE is true, assume that function will be inlined into all the
1123 direct calls. */
1124 bool will_be_removed_from_program_if_no_direct_calls_p
1125 (bool will_inline = false);
1127 /* Return true when function can be removed from callgraph
1128 if all direct calls and references are eliminated. The function does
1129 not take into account comdat groups. */
1130 bool can_remove_if_no_direct_calls_and_refs_p (void);
1132 /* Return true when function cgraph_node and its aliases can be removed from
1133 callgraph if all direct calls are eliminated.
1134 If WILL_INLINE is true, assume that function will be inlined into all the
1135 direct calls. */
1136 bool can_remove_if_no_direct_calls_p (bool will_inline = false);
1138 /* Return true when callgraph node is a function with Gimple body defined
1139 in current unit. Functions can also be define externally or they
1140 can be thunks with no Gimple representation.
1142 Note that at WPA stage, the function body may not be present in memory. */
1143 inline bool has_gimple_body_p (void);
1145 /* Return true if function should be optimized for size. */
1146 bool optimize_for_size_p (void);
1148 /* Dump the callgraph to file F. */
1149 static void dump_cgraph (FILE *f);
1151 /* Dump the call graph to stderr. */
1152 static inline
1153 void debug_cgraph (void)
1155 dump_cgraph (stderr);
1158 /* Record that DECL1 and DECL2 are semantically identical function
1159 versions. */
1160 static void record_function_versions (tree decl1, tree decl2);
1162 /* Remove the cgraph_function_version_info and cgraph_node for DECL. This
1163 DECL is a duplicate declaration. */
1164 static void delete_function_version (tree decl);
1166 /* Add the function FNDECL to the call graph.
1167 Unlike finalize_function, this function is intended to be used
1168 by middle end and allows insertion of new function at arbitrary point
1169 of compilation. The function can be either in high, low or SSA form
1170 GIMPLE.
1172 The function is assumed to be reachable and have address taken (so no
1173 API breaking optimizations are performed on it).
1175 Main work done by this function is to enqueue the function for later
1176 processing to avoid need the passes to be re-entrant. */
1177 static void add_new_function (tree fndecl, bool lowered);
1179 /* Return callgraph node for given symbol and check it is a function. */
1180 static inline cgraph_node *get (const_tree decl)
1182 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL);
1183 return dyn_cast <cgraph_node *> (symtab_node::get (decl));
1186 /* DECL has been parsed. Take it, queue it, compile it at the whim of the
1187 logic in effect. If NO_COLLECT is true, then our caller cannot stand to
1188 have the garbage collector run at the moment. We would need to either
1189 create a new GC context, or just not compile right now. */
1190 static void finalize_function (tree, bool);
1192 /* Return cgraph node assigned to DECL. Create new one when needed. */
1193 static cgraph_node * create (tree decl);
1195 /* Try to find a call graph node for declaration DECL and if it does not
1196 exist or if it corresponds to an inline clone, create a new one. */
1197 static cgraph_node * get_create (tree);
1199 /* Return local info for the compiled function. */
1200 static cgraph_local_info *local_info (tree decl);
1202 /* Return local info for the compiled function. */
1203 static struct cgraph_rtl_info *rtl_info (tree);
1205 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
1206 Return NULL if there's no such node. */
1207 static cgraph_node *get_for_asmname (tree asmname);
1209 /* Attempt to mark ALIAS as an alias to DECL. Return alias node if
1210 successful and NULL otherwise.
1211 Same body aliases are output whenever the body of DECL is output,
1212 and cgraph_node::get (ALIAS) transparently
1213 returns cgraph_node::get (DECL). */
1214 static cgraph_node * create_same_body_alias (tree alias, tree decl);
1216 /* Verify whole cgraph structure. */
1217 static void DEBUG_FUNCTION verify_cgraph_nodes (void);
1219 /* Verify cgraph, if consistency checking is enabled. */
1220 static inline void checking_verify_cgraph_nodes (void);
1222 /* Worker to bring NODE local. */
1223 static bool make_local (cgraph_node *node, void *);
1225 /* Mark ALIAS as an alias to DECL. DECL_NODE is cgraph node representing
1226 the function body is associated
1227 with (not necessarily cgraph_node (DECL). */
1228 static cgraph_node *create_alias (tree alias, tree target);
1230 /* Return true if NODE has thunk. */
1231 static bool has_thunk_p (cgraph_node *node, void *);
1233 cgraph_edge *callees;
1234 cgraph_edge *callers;
1235 /* List of edges representing indirect calls with a yet undetermined
1236 callee. */
1237 cgraph_edge *indirect_calls;
1238 /* For nested functions points to function the node is nested in. */
1239 cgraph_node *origin;
1240 /* Points to first nested function, if any. */
1241 cgraph_node *nested;
1242 /* Pointer to the next function with same origin, if any. */
1243 cgraph_node *next_nested;
1244 /* Pointer to the next clone. */
1245 cgraph_node *next_sibling_clone;
1246 cgraph_node *prev_sibling_clone;
1247 cgraph_node *clones;
1248 cgraph_node *clone_of;
1249 /* If instrumentation_clone is 1 then instrumented_version points
1250 to the original function used to make instrumented version.
1251 Otherwise points to instrumented version of the function. */
1252 cgraph_node *instrumented_version;
1253 /* If instrumentation_clone is 1 then orig_decl is the original
1254 function declaration. */
1255 tree orig_decl;
1256 /* For functions with many calls sites it holds map from call expression
1257 to the edge to speed up cgraph_edge function. */
1258 hash_table<cgraph_edge_hasher> *GTY(()) call_site_hash;
1259 /* Declaration node used to be clone of. */
1260 tree former_clone_of;
1262 /* If this is a SIMD clone, this points to the SIMD specific
1263 information for it. */
1264 cgraph_simd_clone *simdclone;
1265 /* If this function has SIMD clones, this points to the first clone. */
1266 cgraph_node *simd_clones;
1268 /* Interprocedural passes scheduled to have their transform functions
1269 applied next time we execute local pass on them. We maintain it
1270 per-function in order to allow IPA passes to introduce new functions. */
1271 vec<ipa_opt_pass> GTY((skip)) ipa_transforms_to_apply;
1273 cgraph_local_info local;
1274 cgraph_global_info global;
1275 struct cgraph_rtl_info *rtl;
1276 cgraph_clone_info clone;
1277 cgraph_thunk_info thunk;
1279 /* Expected number of executions: calculated in profile.c. */
1280 gcov_type count;
1281 /* How to scale counts at materialization time; used to merge
1282 LTO units with different number of profile runs. */
1283 int count_materialization_scale;
1284 /* Unique id of the node. */
1285 int uid;
1286 /* Summary unique id of the node. */
1287 int summary_uid;
1288 /* ID assigned by the profiling. */
1289 unsigned int profile_id;
1290 /* Time profiler: first run of function. */
1291 int tp_first_run;
1293 /* Set when decl is an abstract function pointed to by the
1294 ABSTRACT_DECL_ORIGIN of a reachable function. */
1295 unsigned used_as_abstract_origin : 1;
1296 /* Set once the function is lowered (i.e. its CFG is built). */
1297 unsigned lowered : 1;
1298 /* Set once the function has been instantiated and its callee
1299 lists created. */
1300 unsigned process : 1;
1301 /* How commonly executed the node is. Initialized during branch
1302 probabilities pass. */
1303 ENUM_BITFIELD (node_frequency) frequency : 2;
1304 /* True when function can only be called at startup (from static ctor). */
1305 unsigned only_called_at_startup : 1;
1306 /* True when function can only be called at startup (from static dtor). */
1307 unsigned only_called_at_exit : 1;
1308 /* True when function is the transactional clone of a function which
1309 is called only from inside transactions. */
1310 /* ?? We should be able to remove this. We have enough bits in
1311 cgraph to calculate it. */
1312 unsigned tm_clone : 1;
1313 /* True if this decl is a dispatcher for function versions. */
1314 unsigned dispatcher_function : 1;
1315 /* True if this decl calls a COMDAT-local function. This is set up in
1316 compute_inline_parameters and inline_call. */
1317 unsigned calls_comdat_local : 1;
1318 /* True if node has been created by merge operation in IPA-ICF. */
1319 unsigned icf_merged: 1;
1320 /* True when function is clone created for Pointer Bounds Checker
1321 instrumentation. */
1322 unsigned instrumentation_clone : 1;
1323 /* True if call to node can't result in a call to free, munmap or
1324 other operation that could make previously non-trapping memory
1325 accesses trapping. */
1326 unsigned nonfreeing_fn : 1;
1327 /* True if there was multiple COMDAT bodies merged by lto-symtab. */
1328 unsigned merged : 1;
1329 /* True if function was created to be executed in parallel. */
1330 unsigned parallelized_function : 1;
1331 /* True if function is part split out by ipa-split. */
1332 unsigned split_part : 1;
1334 private:
1335 /* Worker for call_for_symbol_and_aliases. */
1336 bool call_for_symbol_and_aliases_1 (bool (*callback) (cgraph_node *,
1337 void *),
1338 void *data, bool include_overwritable);
1341 /* A cgraph node set is a collection of cgraph nodes. A cgraph node
1342 can appear in multiple sets. */
1343 struct cgraph_node_set_def
1345 hash_map<cgraph_node *, size_t> *map;
1346 vec<cgraph_node *> nodes;
1349 typedef cgraph_node_set_def *cgraph_node_set;
1350 typedef struct varpool_node_set_def *varpool_node_set;
1352 class varpool_node;
1354 /* A varpool node set is a collection of varpool nodes. A varpool node
1355 can appear in multiple sets. */
1356 struct varpool_node_set_def
1358 hash_map<varpool_node *, size_t> * map;
1359 vec<varpool_node *> nodes;
1362 /* Iterator structure for cgraph node sets. */
1363 struct cgraph_node_set_iterator
1365 cgraph_node_set set;
1366 unsigned index;
1369 /* Iterator structure for varpool node sets. */
1370 struct varpool_node_set_iterator
1372 varpool_node_set set;
1373 unsigned index;
1376 /* Context of polymorphic call. It represent information about the type of
1377 instance that may reach the call. This is used by ipa-devirt walkers of the
1378 type inheritance graph. */
1380 class GTY(()) ipa_polymorphic_call_context {
1381 public:
1382 /* The called object appears in an object of type OUTER_TYPE
1383 at offset OFFSET. When information is not 100% reliable, we
1384 use SPECULATIVE_OUTER_TYPE and SPECULATIVE_OFFSET. */
1385 HOST_WIDE_INT offset;
1386 HOST_WIDE_INT speculative_offset;
1387 tree outer_type;
1388 tree speculative_outer_type;
1389 /* True if outer object may be in construction or destruction. */
1390 unsigned maybe_in_construction : 1;
1391 /* True if outer object may be of derived type. */
1392 unsigned maybe_derived_type : 1;
1393 /* True if speculative outer object may be of derived type. We always
1394 speculate that construction does not happen. */
1395 unsigned speculative_maybe_derived_type : 1;
1396 /* True if the context is invalid and all calls should be redirected
1397 to BUILTIN_UNREACHABLE. */
1398 unsigned invalid : 1;
1399 /* True if the outer type is dynamic. */
1400 unsigned dynamic : 1;
1402 /* Build empty "I know nothing" context. */
1403 ipa_polymorphic_call_context ();
1404 /* Build polymorphic call context for indirect call E. */
1405 ipa_polymorphic_call_context (cgraph_edge *e);
1406 /* Build polymorphic call context for IP invariant CST.
1407 If specified, OTR_TYPE specify the type of polymorphic call
1408 that takes CST+OFFSET as a prameter. */
1409 ipa_polymorphic_call_context (tree cst, tree otr_type = NULL,
1410 HOST_WIDE_INT offset = 0);
1411 /* Build context for pointer REF contained in FNDECL at statement STMT.
1412 if INSTANCE is non-NULL, return pointer to the object described by
1413 the context. */
1414 ipa_polymorphic_call_context (tree fndecl, tree ref, gimple *stmt,
1415 tree *instance = NULL);
1417 /* Look for vtable stores or constructor calls to work out dynamic type
1418 of memory location. */
1419 bool get_dynamic_type (tree, tree, tree, gimple *);
1421 /* Make context non-speculative. */
1422 void clear_speculation ();
1424 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
1425 NULL, the context is set to dummy "I know nothing" setting. */
1426 void clear_outer_type (tree otr_type = NULL);
1428 /* Walk container types and modify context to point to actual class
1429 containing OTR_TYPE (if non-NULL) as base class.
1430 Return true if resulting context is valid.
1432 When CONSIDER_PLACEMENT_NEW is false, reject contexts that may be made
1433 valid only via alocation of new polymorphic type inside by means
1434 of placement new.
1436 When CONSIDER_BASES is false, only look for actual fields, not base types
1437 of TYPE. */
1438 bool restrict_to_inner_class (tree otr_type,
1439 bool consider_placement_new = true,
1440 bool consider_bases = true);
1442 /* Adjust all offsets in contexts by given number of bits. */
1443 void offset_by (HOST_WIDE_INT);
1444 /* Use when we can not track dynamic type change. This speculatively assume
1445 type change is not happening. */
1446 void possible_dynamic_type_change (bool, tree otr_type = NULL);
1447 /* Assume that both THIS and a given context is valid and strenghten THIS
1448 if possible. Return true if any strenghtening was made.
1449 If actual type the context is being used in is known, OTR_TYPE should be
1450 set accordingly. This improves quality of combined result. */
1451 bool combine_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1452 bool meet_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1454 /* Return TRUE if context is fully useless. */
1455 bool useless_p () const;
1456 /* Return TRUE if this context conveys the same information as X. */
1457 bool equal_to (const ipa_polymorphic_call_context &x) const;
1459 /* Dump human readable context to F. If NEWLINE is true, it will be
1460 terminated by a newline. */
1461 void dump (FILE *f, bool newline = true) const;
1462 void DEBUG_FUNCTION debug () const;
1464 /* LTO streaming. */
1465 void stream_out (struct output_block *) const;
1466 void stream_in (struct lto_input_block *, struct data_in *data_in);
1468 private:
1469 bool combine_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1470 bool meet_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1471 void set_by_decl (tree, HOST_WIDE_INT);
1472 bool set_by_invariant (tree, tree, HOST_WIDE_INT);
1473 bool speculation_consistent_p (tree, HOST_WIDE_INT, bool, tree) const;
1474 void make_speculative (tree otr_type = NULL);
1477 /* Structure containing additional information about an indirect call. */
1479 struct GTY(()) cgraph_indirect_call_info
1481 /* When agg_content is set, an offset where the call pointer is located
1482 within the aggregate. */
1483 HOST_WIDE_INT offset;
1484 /* Context of the polymorphic call; use only when POLYMORPHIC flag is set. */
1485 ipa_polymorphic_call_context context;
1486 /* OBJ_TYPE_REF_TOKEN of a polymorphic call (if polymorphic is set). */
1487 HOST_WIDE_INT otr_token;
1488 /* Type of the object from OBJ_TYPE_REF_OBJECT. */
1489 tree otr_type;
1490 /* Index of the parameter that is called. */
1491 int param_index;
1492 /* ECF flags determined from the caller. */
1493 int ecf_flags;
1494 /* Profile_id of common target obtrained from profile. */
1495 int common_target_id;
1496 /* Probability that call will land in function with COMMON_TARGET_ID. */
1497 int common_target_probability;
1499 /* Set when the call is a virtual call with the parameter being the
1500 associated object pointer rather than a simple direct call. */
1501 unsigned polymorphic : 1;
1502 /* Set when the call is a call of a pointer loaded from contents of an
1503 aggregate at offset. */
1504 unsigned agg_contents : 1;
1505 /* Set when this is a call through a member pointer. */
1506 unsigned member_ptr : 1;
1507 /* When the previous bit is set, this one determines whether the destination
1508 is loaded from a parameter passed by reference. */
1509 unsigned by_ref : 1;
1510 /* For polymorphic calls this specify whether the virtual table pointer
1511 may have changed in between function entry and the call. */
1512 unsigned vptr_changed : 1;
1515 struct GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller"),
1516 for_user)) cgraph_edge {
1517 friend class cgraph_node;
1519 /* Remove the edge in the cgraph. */
1520 void remove (void);
1522 /* Change field call_stmt of edge to NEW_STMT.
1523 If UPDATE_SPECULATIVE and E is any component of speculative
1524 edge, then update all components. */
1525 void set_call_stmt (gcall *new_stmt, bool update_speculative = true);
1527 /* Redirect callee of the edge to N. The function does not update underlying
1528 call expression. */
1529 void redirect_callee (cgraph_node *n);
1531 /* If the edge does not lead to a thunk, simply redirect it to N. Otherwise
1532 create one or more equivalent thunks for N and redirect E to the first in
1533 the chain. Note that it is then necessary to call
1534 n->expand_all_artificial_thunks once all callers are redirected. */
1535 void redirect_callee_duplicating_thunks (cgraph_node *n);
1537 /* Make an indirect edge with an unknown callee an ordinary edge leading to
1538 CALLEE. DELTA is an integer constant that is to be added to the this
1539 pointer (first parameter) to compensate for skipping
1540 a thunk adjustment. */
1541 cgraph_edge *make_direct (cgraph_node *callee);
1543 /* Turn edge into speculative call calling N2. Update
1544 the profile so the direct call is taken COUNT times
1545 with FREQUENCY. */
1546 cgraph_edge *make_speculative (cgraph_node *n2, gcov_type direct_count,
1547 int direct_frequency);
1549 /* Given speculative call edge, return all three components. */
1550 void speculative_call_info (cgraph_edge *&direct, cgraph_edge *&indirect,
1551 ipa_ref *&reference);
1553 /* Speculative call edge turned out to be direct call to CALLE_DECL.
1554 Remove the speculative call sequence and return edge representing the call.
1555 It is up to caller to redirect the call as appropriate. */
1556 cgraph_edge *resolve_speculation (tree callee_decl = NULL);
1558 /* If necessary, change the function declaration in the call statement
1559 associated with the edge so that it corresponds to the edge callee. */
1560 gimple *redirect_call_stmt_to_callee (void);
1562 /* Create clone of edge in the node N represented
1563 by CALL_EXPR the callgraph. */
1564 cgraph_edge * clone (cgraph_node *n, gcall *call_stmt, unsigned stmt_uid,
1565 gcov_type count_scale, int freq_scale, bool update_original);
1567 /* Verify edge count and frequency. */
1568 bool verify_count_and_frequency ();
1570 /* Return true when call of edge can not lead to return from caller
1571 and thus it is safe to ignore its side effects for IPA analysis
1572 when computing side effects of the caller. */
1573 bool cannot_lead_to_return_p (void);
1575 /* Return true when the edge represents a direct recursion. */
1576 bool recursive_p (void);
1578 /* Return true if the call can be hot. */
1579 bool maybe_hot_p (void);
1581 /* Rebuild cgraph edges for current function node. This needs to be run after
1582 passes that don't update the cgraph. */
1583 static unsigned int rebuild_edges (void);
1585 /* Rebuild cgraph references for current function node. This needs to be run
1586 after passes that don't update the cgraph. */
1587 static void rebuild_references (void);
1589 /* Expected number of executions: calculated in profile.c. */
1590 gcov_type count;
1591 cgraph_node *caller;
1592 cgraph_node *callee;
1593 cgraph_edge *prev_caller;
1594 cgraph_edge *next_caller;
1595 cgraph_edge *prev_callee;
1596 cgraph_edge *next_callee;
1597 gcall *call_stmt;
1598 /* Additional information about an indirect call. Not cleared when an edge
1599 becomes direct. */
1600 cgraph_indirect_call_info *indirect_info;
1601 PTR GTY ((skip (""))) aux;
1602 /* When equal to CIF_OK, inline this call. Otherwise, points to the
1603 explanation why function was not inlined. */
1604 enum cgraph_inline_failed_t inline_failed;
1605 /* The stmt_uid of call_stmt. This is used by LTO to recover the call_stmt
1606 when the function is serialized in. */
1607 unsigned int lto_stmt_uid;
1608 /* Expected frequency of executions within the function.
1609 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
1610 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
1611 int frequency;
1612 /* Unique id of the edge. */
1613 int uid;
1614 /* Whether this edge was made direct by indirect inlining. */
1615 unsigned int indirect_inlining_edge : 1;
1616 /* Whether this edge describes an indirect call with an undetermined
1617 callee. */
1618 unsigned int indirect_unknown_callee : 1;
1619 /* Whether this edge is still a dangling */
1620 /* True if the corresponding CALL stmt cannot be inlined. */
1621 unsigned int call_stmt_cannot_inline_p : 1;
1622 /* Can this call throw externally? */
1623 unsigned int can_throw_external : 1;
1624 /* Edges with SPECULATIVE flag represents indirect calls that was
1625 speculatively turned into direct (i.e. by profile feedback).
1626 The final code sequence will have form:
1628 if (call_target == expected_fn)
1629 expected_fn ();
1630 else
1631 call_target ();
1633 Every speculative call is represented by three components attached
1634 to a same call statement:
1635 1) a direct call (to expected_fn)
1636 2) an indirect call (to call_target)
1637 3) a IPA_REF_ADDR refrence to expected_fn.
1639 Optimizers may later redirect direct call to clone, so 1) and 3)
1640 do not need to necesarily agree with destination. */
1641 unsigned int speculative : 1;
1642 /* Set to true when caller is a constructor or destructor of polymorphic
1643 type. */
1644 unsigned in_polymorphic_cdtor : 1;
1646 private:
1647 /* Remove the edge from the list of the callers of the callee. */
1648 void remove_caller (void);
1650 /* Remove the edge from the list of the callees of the caller. */
1651 void remove_callee (void);
1653 /* Set callee N of call graph edge and add it to the corresponding set of
1654 callers. */
1655 void set_callee (cgraph_node *n);
1657 /* Output flags of edge to a file F. */
1658 void dump_edge_flags (FILE *f);
1660 /* Verify that call graph edge corresponds to DECL from the associated
1661 statement. Return true if the verification should fail. */
1662 bool verify_corresponds_to_fndecl (tree decl);
1665 #define CGRAPH_FREQ_BASE 1000
1666 #define CGRAPH_FREQ_MAX 100000
1668 /* The varpool data structure.
1669 Each static variable decl has assigned varpool_node. */
1671 class GTY((tag ("SYMTAB_VARIABLE"))) varpool_node : public symtab_node {
1672 public:
1673 /* Dump given varpool node to F. */
1674 void dump (FILE *f);
1676 /* Dump given varpool node to stderr. */
1677 void DEBUG_FUNCTION debug (void);
1679 /* Remove variable from symbol table. */
1680 void remove (void);
1682 /* Remove node initializer when it is no longer needed. */
1683 void remove_initializer (void);
1685 void analyze (void);
1687 /* Return variable availability. */
1688 availability get_availability (void);
1690 /* When doing LTO, read variable's constructor from disk if
1691 it is not already present. */
1692 tree get_constructor (void);
1694 /* Return true if variable has constructor that can be used for folding. */
1695 bool ctor_useable_for_folding_p (void);
1697 /* For given variable pool node, walk the alias chain to return the function
1698 the variable is alias of. Do not walk through thunks.
1699 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
1700 inline varpool_node *ultimate_alias_target
1701 (availability *availability = NULL);
1703 /* Return node that alias is aliasing. */
1704 inline varpool_node *get_alias_target (void);
1706 /* Output one variable, if necessary. Return whether we output it. */
1707 bool assemble_decl (void);
1709 /* For variables in named sections make sure get_variable_section
1710 is called before we switch to those sections. Then section
1711 conflicts between read-only and read-only requiring relocations
1712 sections can be resolved. */
1713 void finalize_named_section_flags (void);
1715 /* Call calback on varpool symbol and aliases associated to varpool symbol.
1716 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1717 skipped. */
1718 bool call_for_symbol_and_aliases (bool (*callback) (varpool_node *, void *),
1719 void *data,
1720 bool include_overwritable);
1722 /* Return true when variable should be considered externally visible. */
1723 bool externally_visible_p (void);
1725 /* Return true when all references to variable must be visible
1726 in ipa_ref_list.
1727 i.e. if the variable is not externally visible or not used in some magic
1728 way (asm statement or such).
1729 The magic uses are all summarized in force_output flag. */
1730 inline bool all_refs_explicit_p ();
1732 /* Return true when variable can be removed from variable pool
1733 if all direct calls are eliminated. */
1734 inline bool can_remove_if_no_refs_p (void);
1736 /* Add the variable DECL to the varpool.
1737 Unlike finalize_decl function is intended to be used
1738 by middle end and allows insertion of new variable at arbitrary point
1739 of compilation. */
1740 static void add (tree decl);
1742 /* Return varpool node for given symbol and check it is a function. */
1743 static inline varpool_node *get (const_tree decl);
1745 /* Mark DECL as finalized. By finalizing the declaration, frontend instruct
1746 the middle end to output the variable to asm file, if needed or externally
1747 visible. */
1748 static void finalize_decl (tree decl);
1750 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1751 Extra name aliases are output whenever DECL is output. */
1752 static varpool_node * create_extra_name_alias (tree alias, tree decl);
1754 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1755 Extra name aliases are output whenever DECL is output. */
1756 static varpool_node * create_alias (tree, tree);
1758 /* Dump the variable pool to F. */
1759 static void dump_varpool (FILE *f);
1761 /* Dump the variable pool to stderr. */
1762 static void DEBUG_FUNCTION debug_varpool (void);
1764 /* Allocate new callgraph node and insert it into basic data structures. */
1765 static varpool_node *create_empty (void);
1767 /* Return varpool node assigned to DECL. Create new one when needed. */
1768 static varpool_node *get_create (tree decl);
1770 /* Given an assembler name, lookup node. */
1771 static varpool_node *get_for_asmname (tree asmname);
1773 /* Set when variable is scheduled to be assembled. */
1774 unsigned output : 1;
1776 /* Set when variable has statically initialized pointer
1777 or is a static bounds variable and needs initalization. */
1778 unsigned need_bounds_init : 1;
1780 /* Set if the variable is dynamically initialized, except for
1781 function local statics. */
1782 unsigned dynamically_initialized : 1;
1784 ENUM_BITFIELD(tls_model) tls_model : 3;
1786 /* Set if the variable is known to be used by single function only.
1787 This is computed by ipa_signle_use pass and used by late optimizations
1788 in places where optimization would be valid for local static variable
1789 if we did not do any inter-procedural code movement. */
1790 unsigned used_by_single_function : 1;
1792 private:
1793 /* Assemble thunks and aliases associated to varpool node. */
1794 void assemble_aliases (void);
1796 /* Worker for call_for_node_and_aliases. */
1797 bool call_for_symbol_and_aliases_1 (bool (*callback) (varpool_node *, void *),
1798 void *data,
1799 bool include_overwritable);
1802 /* Every top level asm statement is put into a asm_node. */
1804 struct GTY(()) asm_node {
1807 /* Next asm node. */
1808 asm_node *next;
1809 /* String for this asm node. */
1810 tree asm_str;
1811 /* Ordering of all cgraph nodes. */
1812 int order;
1815 /* Report whether or not THIS symtab node is a function, aka cgraph_node. */
1817 template <>
1818 template <>
1819 inline bool
1820 is_a_helper <cgraph_node *>::test (symtab_node *p)
1822 return p && p->type == SYMTAB_FUNCTION;
1825 /* Report whether or not THIS symtab node is a vriable, aka varpool_node. */
1827 template <>
1828 template <>
1829 inline bool
1830 is_a_helper <varpool_node *>::test (symtab_node *p)
1832 return p && p->type == SYMTAB_VARIABLE;
1835 /* Macros to access the next item in the list of free cgraph nodes and
1836 edges. */
1837 #define NEXT_FREE_NODE(NODE) dyn_cast<cgraph_node *> ((NODE)->next)
1838 #define SET_NEXT_FREE_NODE(NODE,NODE2) ((NODE))->next = NODE2
1839 #define NEXT_FREE_EDGE(EDGE) (EDGE)->prev_caller
1841 typedef void (*cgraph_edge_hook)(cgraph_edge *, void *);
1842 typedef void (*cgraph_node_hook)(cgraph_node *, void *);
1843 typedef void (*varpool_node_hook)(varpool_node *, void *);
1844 typedef void (*cgraph_2edge_hook)(cgraph_edge *, cgraph_edge *, void *);
1845 typedef void (*cgraph_2node_hook)(cgraph_node *, cgraph_node *, void *);
1847 struct cgraph_edge_hook_list;
1848 struct cgraph_node_hook_list;
1849 struct varpool_node_hook_list;
1850 struct cgraph_2edge_hook_list;
1851 struct cgraph_2node_hook_list;
1853 /* Map from a symbol to initialization/finalization priorities. */
1854 struct GTY(()) symbol_priority_map {
1855 priority_type init;
1856 priority_type fini;
1859 enum symtab_state
1861 /* Frontend is parsing and finalizing functions. */
1862 PARSING,
1863 /* Callgraph is being constructed. It is safe to add new functions. */
1864 CONSTRUCTION,
1865 /* Callgraph is being streamed-in at LTO time. */
1866 LTO_STREAMING,
1867 /* Callgraph is built and early IPA passes are being run. */
1868 IPA,
1869 /* Callgraph is built and all functions are transformed to SSA form. */
1870 IPA_SSA,
1871 /* All inline decisions are done; it is now possible to remove extern inline
1872 functions and virtual call targets. */
1873 IPA_SSA_AFTER_INLINING,
1874 /* Functions are now ordered and being passed to RTL expanders. */
1875 EXPANSION,
1876 /* All cgraph expansion is done. */
1877 FINISHED
1880 struct asmname_hasher : ggc_ptr_hash <symtab_node>
1882 typedef const_tree compare_type;
1884 static hashval_t hash (symtab_node *n);
1885 static bool equal (symtab_node *n, const_tree t);
1888 class GTY((tag ("SYMTAB"))) symbol_table
1890 public:
1891 friend class symtab_node;
1892 friend class cgraph_node;
1893 friend class cgraph_edge;
1895 symbol_table (): cgraph_max_summary_uid (1)
1899 /* Initialize callgraph dump file. */
1900 void initialize (void);
1902 /* Register a top-level asm statement ASM_STR. */
1903 inline asm_node *finalize_toplevel_asm (tree asm_str);
1905 /* Analyze the whole compilation unit once it is parsed completely. */
1906 void finalize_compilation_unit (void);
1908 /* C++ frontend produce same body aliases all over the place, even before PCH
1909 gets streamed out. It relies on us linking the aliases with their function
1910 in order to do the fixups, but ipa-ref is not PCH safe. Consequentely we
1911 first produce aliases without links, but once C++ FE is sure he won't sream
1912 PCH we build the links via this function. */
1913 void process_same_body_aliases (void);
1915 /* Perform simple optimizations based on callgraph. */
1916 void compile (void);
1918 /* Process CGRAPH_NEW_FUNCTIONS and perform actions necessary to add these
1919 functions into callgraph in a way so they look like ordinary reachable
1920 functions inserted into callgraph already at construction time. */
1921 void process_new_functions (void);
1923 /* Once all functions from compilation unit are in memory, produce all clones
1924 and update all calls. We might also do this on demand if we don't want to
1925 bring all functions to memory prior compilation, but current WHOPR
1926 implementation does that and it is bit easier to keep everything right
1927 in this order. */
1928 void materialize_all_clones (void);
1930 /* Register a symbol NODE. */
1931 inline void register_symbol (symtab_node *node);
1933 inline void
1934 clear_asm_symbols (void)
1936 asmnodes = NULL;
1937 asm_last_node = NULL;
1940 /* Perform reachability analysis and reclaim all unreachable nodes. */
1941 bool remove_unreachable_nodes (FILE *file);
1943 /* Optimization of function bodies might've rendered some variables as
1944 unnecessary so we want to avoid these from being compiled. Re-do
1945 reachability starting from variables that are either externally visible
1946 or was referred from the asm output routines. */
1947 void remove_unreferenced_decls (void);
1949 /* Unregister a symbol NODE. */
1950 inline void unregister (symtab_node *node);
1952 /* Allocate new callgraph node and insert it into basic data structures. */
1953 cgraph_node *create_empty (void);
1955 /* Release a callgraph NODE with UID and put in to the list
1956 of free nodes. */
1957 void release_symbol (cgraph_node *node, int uid);
1959 /* Output all variables enqueued to be assembled. */
1960 bool output_variables (void);
1962 /* Weakrefs may be associated to external decls and thus not output
1963 at expansion time. Emit all necessary aliases. */
1964 void output_weakrefs (void);
1966 /* Return first static symbol with definition. */
1967 inline symtab_node *first_symbol (void);
1969 /* Return first assembler symbol. */
1970 inline asm_node *
1971 first_asm_symbol (void)
1973 return asmnodes;
1976 /* Return first static symbol with definition. */
1977 inline symtab_node *first_defined_symbol (void);
1979 /* Return first variable. */
1980 inline varpool_node *first_variable (void);
1982 /* Return next variable after NODE. */
1983 inline varpool_node *next_variable (varpool_node *node);
1985 /* Return first static variable with initializer. */
1986 inline varpool_node *first_static_initializer (void);
1988 /* Return next static variable with initializer after NODE. */
1989 inline varpool_node *next_static_initializer (varpool_node *node);
1991 /* Return first static variable with definition. */
1992 inline varpool_node *first_defined_variable (void);
1994 /* Return next static variable with definition after NODE. */
1995 inline varpool_node *next_defined_variable (varpool_node *node);
1997 /* Return first function with body defined. */
1998 inline cgraph_node *first_defined_function (void);
2000 /* Return next function with body defined after NODE. */
2001 inline cgraph_node *next_defined_function (cgraph_node *node);
2003 /* Return first function. */
2004 inline cgraph_node *first_function (void);
2006 /* Return next function. */
2007 inline cgraph_node *next_function (cgraph_node *node);
2009 /* Return first function with body defined. */
2010 cgraph_node *first_function_with_gimple_body (void);
2012 /* Return next reachable static variable with initializer after NODE. */
2013 inline cgraph_node *next_function_with_gimple_body (cgraph_node *node);
2015 /* Register HOOK to be called with DATA on each removed edge. */
2016 cgraph_edge_hook_list *add_edge_removal_hook (cgraph_edge_hook hook,
2017 void *data);
2019 /* Remove ENTRY from the list of hooks called on removing edges. */
2020 void remove_edge_removal_hook (cgraph_edge_hook_list *entry);
2022 /* Register HOOK to be called with DATA on each removed node. */
2023 cgraph_node_hook_list *add_cgraph_removal_hook (cgraph_node_hook hook,
2024 void *data);
2026 /* Remove ENTRY from the list of hooks called on removing nodes. */
2027 void remove_cgraph_removal_hook (cgraph_node_hook_list *entry);
2029 /* Register HOOK to be called with DATA on each removed node. */
2030 varpool_node_hook_list *add_varpool_removal_hook (varpool_node_hook hook,
2031 void *data);
2033 /* Remove ENTRY from the list of hooks called on removing nodes. */
2034 void remove_varpool_removal_hook (varpool_node_hook_list *entry);
2036 /* Register HOOK to be called with DATA on each inserted node. */
2037 cgraph_node_hook_list *add_cgraph_insertion_hook (cgraph_node_hook hook,
2038 void *data);
2040 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2041 void remove_cgraph_insertion_hook (cgraph_node_hook_list *entry);
2043 /* Register HOOK to be called with DATA on each inserted node. */
2044 varpool_node_hook_list *add_varpool_insertion_hook (varpool_node_hook hook,
2045 void *data);
2047 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2048 void remove_varpool_insertion_hook (varpool_node_hook_list *entry);
2050 /* Register HOOK to be called with DATA on each duplicated edge. */
2051 cgraph_2edge_hook_list *add_edge_duplication_hook (cgraph_2edge_hook hook,
2052 void *data);
2053 /* Remove ENTRY from the list of hooks called on duplicating edges. */
2054 void remove_edge_duplication_hook (cgraph_2edge_hook_list *entry);
2056 /* Register HOOK to be called with DATA on each duplicated node. */
2057 cgraph_2node_hook_list *add_cgraph_duplication_hook (cgraph_2node_hook hook,
2058 void *data);
2060 /* Remove ENTRY from the list of hooks called on duplicating nodes. */
2061 void remove_cgraph_duplication_hook (cgraph_2node_hook_list *entry);
2063 /* Call all edge removal hooks. */
2064 void call_edge_removal_hooks (cgraph_edge *e);
2066 /* Call all node insertion hooks. */
2067 void call_cgraph_insertion_hooks (cgraph_node *node);
2069 /* Call all node removal hooks. */
2070 void call_cgraph_removal_hooks (cgraph_node *node);
2072 /* Call all node duplication hooks. */
2073 void call_cgraph_duplication_hooks (cgraph_node *node, cgraph_node *node2);
2075 /* Call all edge duplication hooks. */
2076 void call_edge_duplication_hooks (cgraph_edge *cs1, cgraph_edge *cs2);
2078 /* Call all node removal hooks. */
2079 void call_varpool_removal_hooks (varpool_node *node);
2081 /* Call all node insertion hooks. */
2082 void call_varpool_insertion_hooks (varpool_node *node);
2084 /* Arrange node to be first in its entry of assembler_name_hash. */
2085 void symtab_prevail_in_asm_name_hash (symtab_node *node);
2087 /* Initalize asm name hash unless. */
2088 void symtab_initialize_asm_name_hash (void);
2090 /* Set the DECL_ASSEMBLER_NAME and update symtab hashtables. */
2091 void change_decl_assembler_name (tree decl, tree name);
2093 int cgraph_count;
2094 int cgraph_max_uid;
2095 int cgraph_max_summary_uid;
2097 int edges_count;
2098 int edges_max_uid;
2100 symtab_node* GTY(()) nodes;
2101 asm_node* GTY(()) asmnodes;
2102 asm_node* GTY(()) asm_last_node;
2103 cgraph_node* GTY(()) free_nodes;
2105 /* Head of a linked list of unused (freed) call graph edges.
2106 Do not GTY((delete)) this list so UIDs gets reliably recycled. */
2107 cgraph_edge * GTY(()) free_edges;
2109 /* The order index of the next symtab node to be created. This is
2110 used so that we can sort the cgraph nodes in order by when we saw
2111 them, to support -fno-toplevel-reorder. */
2112 int order;
2114 /* Set when whole unit has been analyzed so we can access global info. */
2115 bool global_info_ready;
2116 /* What state callgraph is in right now. */
2117 enum symtab_state state;
2118 /* Set when the cgraph is fully build and the basic flags are computed. */
2119 bool function_flags_ready;
2121 bool cpp_implicit_aliases_done;
2123 /* Hash table used to hold sectoons. */
2124 hash_table<section_name_hasher> *GTY(()) section_hash;
2126 /* Hash table used to convert assembler names into nodes. */
2127 hash_table<asmname_hasher> *assembler_name_hash;
2129 /* Hash table used to hold init priorities. */
2130 hash_map<symtab_node *, symbol_priority_map> *init_priority_hash;
2132 FILE* GTY ((skip)) dump_file;
2134 private:
2135 /* Allocate new callgraph node. */
2136 inline cgraph_node * allocate_cgraph_symbol (void);
2138 /* Allocate a cgraph_edge structure and fill it with data according to the
2139 parameters of which only CALLEE can be NULL (when creating an indirect call
2140 edge). */
2141 cgraph_edge *create_edge (cgraph_node *caller, cgraph_node *callee,
2142 gcall *call_stmt, gcov_type count, int freq,
2143 bool indir_unknown_callee);
2145 /* Put the edge onto the free list. */
2146 void free_edge (cgraph_edge *e);
2148 /* Insert NODE to assembler name hash. */
2149 void insert_to_assembler_name_hash (symtab_node *node, bool with_clones);
2151 /* Remove NODE from assembler name hash. */
2152 void unlink_from_assembler_name_hash (symtab_node *node, bool with_clones);
2154 /* Hash asmnames ignoring the user specified marks. */
2155 static hashval_t decl_assembler_name_hash (const_tree asmname);
2157 /* Compare ASMNAME with the DECL_ASSEMBLER_NAME of DECL. */
2158 static bool decl_assembler_name_equal (tree decl, const_tree asmname);
2160 friend struct asmname_hasher;
2162 /* List of hooks triggered when an edge is removed. */
2163 cgraph_edge_hook_list * GTY((skip)) m_first_edge_removal_hook;
2164 /* List of hooks triggem_red when a cgraph node is removed. */
2165 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_removal_hook;
2166 /* List of hooks triggered when an edge is duplicated. */
2167 cgraph_2edge_hook_list * GTY((skip)) m_first_edge_duplicated_hook;
2168 /* List of hooks triggered when a node is duplicated. */
2169 cgraph_2node_hook_list * GTY((skip)) m_first_cgraph_duplicated_hook;
2170 /* List of hooks triggered when an function is inserted. */
2171 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_insertion_hook;
2172 /* List of hooks triggered when an variable is inserted. */
2173 varpool_node_hook_list * GTY((skip)) m_first_varpool_insertion_hook;
2174 /* List of hooks triggered when a node is removed. */
2175 varpool_node_hook_list * GTY((skip)) m_first_varpool_removal_hook;
2178 extern GTY(()) symbol_table *symtab;
2180 extern vec<cgraph_node *> cgraph_new_nodes;
2182 inline hashval_t
2183 asmname_hasher::hash (symtab_node *n)
2185 return symbol_table::decl_assembler_name_hash
2186 (DECL_ASSEMBLER_NAME (n->decl));
2189 inline bool
2190 asmname_hasher::equal (symtab_node *n, const_tree t)
2192 return symbol_table::decl_assembler_name_equal (n->decl, t);
2195 /* In cgraph.c */
2196 void cgraph_c_finalize (void);
2197 void release_function_body (tree);
2198 cgraph_indirect_call_info *cgraph_allocate_init_indirect_info (void);
2200 void cgraph_update_edges_for_call_stmt (gimple *, tree, gimple *);
2201 bool cgraph_function_possibly_inlined_p (tree);
2203 const char* cgraph_inline_failed_string (cgraph_inline_failed_t);
2204 cgraph_inline_failed_type_t cgraph_inline_failed_type (cgraph_inline_failed_t);
2206 extern bool gimple_check_call_matching_types (gimple *, tree, bool);
2208 /* In cgraphunit.c */
2209 void cgraphunit_c_finalize (void);
2211 /* Initialize datastructures so DECL is a function in lowered gimple form.
2212 IN_SSA is true if the gimple is in SSA. */
2213 basic_block init_lowered_empty_function (tree, bool, gcov_type);
2215 /* In cgraphclones.c */
2217 tree clone_function_name_1 (const char *, const char *);
2218 tree clone_function_name (tree decl, const char *);
2220 void tree_function_versioning (tree, tree, vec<ipa_replace_map *, va_gc> *,
2221 bool, bitmap, bool, bitmap, basic_block);
2223 /* In cgraphbuild.c */
2224 int compute_call_stmt_bb_frequency (tree, basic_block bb);
2225 void record_references_in_initializer (tree, bool);
2227 /* In ipa.c */
2228 void cgraph_build_static_cdtor (char which, tree body, int priority);
2229 bool ipa_discover_readonly_nonaddressable_vars (void);
2231 /* In varpool.c */
2232 tree ctor_for_folding (tree);
2234 /* In tree-chkp.c */
2235 extern bool chkp_function_instrumented_p (tree fndecl);
2237 /* Return true when the symbol is real symbol, i.e. it is not inline clone
2238 or abstract function kept for debug info purposes only. */
2239 inline bool
2240 symtab_node::real_symbol_p (void)
2242 cgraph_node *cnode;
2244 if (DECL_ABSTRACT_P (decl))
2245 return false;
2246 if (!is_a <cgraph_node *> (this))
2247 return true;
2248 cnode = dyn_cast <cgraph_node *> (this);
2249 if (cnode->global.inlined_to)
2250 return false;
2251 return true;
2254 /* Return true if DECL should have entry in symbol table if used.
2255 Those are functions and static & external veriables*/
2257 static inline bool
2258 decl_in_symtab_p (const_tree decl)
2260 return (TREE_CODE (decl) == FUNCTION_DECL
2261 || (TREE_CODE (decl) == VAR_DECL
2262 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl))));
2265 inline bool
2266 symtab_node::in_same_comdat_group_p (symtab_node *target)
2268 symtab_node *source = this;
2270 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2272 if (cn->global.inlined_to)
2273 source = cn->global.inlined_to;
2275 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2277 if (cn->global.inlined_to)
2278 target = cn->global.inlined_to;
2281 return source->get_comdat_group () == target->get_comdat_group ();
2284 /* Return node that alias is aliasing. */
2286 inline symtab_node *
2287 symtab_node::get_alias_target (void)
2289 ipa_ref *ref = NULL;
2290 iterate_reference (0, ref);
2291 if (ref->use == IPA_REF_CHKP)
2292 iterate_reference (1, ref);
2293 gcc_checking_assert (ref->use == IPA_REF_ALIAS);
2294 return ref->referred;
2297 /* Return next reachable static symbol with initializer after the node. */
2299 inline symtab_node *
2300 symtab_node::next_defined_symbol (void)
2302 symtab_node *node1 = next;
2304 for (; node1; node1 = node1->next)
2305 if (node1->definition)
2306 return node1;
2308 return NULL;
2311 /* Iterates I-th reference in the list, REF is also set. */
2313 inline ipa_ref *
2314 symtab_node::iterate_reference (unsigned i, ipa_ref *&ref)
2316 vec_safe_iterate (ref_list.references, i, &ref);
2318 return ref;
2321 /* Iterates I-th referring item in the list, REF is also set. */
2323 inline ipa_ref *
2324 symtab_node::iterate_referring (unsigned i, ipa_ref *&ref)
2326 ref_list.referring.iterate (i, &ref);
2328 return ref;
2331 /* Iterates I-th referring alias item in the list, REF is also set. */
2333 inline ipa_ref *
2334 symtab_node::iterate_direct_aliases (unsigned i, ipa_ref *&ref)
2336 ref_list.referring.iterate (i, &ref);
2338 if (ref && ref->use != IPA_REF_ALIAS)
2339 return NULL;
2341 return ref;
2344 /* Return true if list contains an alias. */
2346 inline bool
2347 symtab_node::has_aliases_p (void)
2349 ipa_ref *ref = NULL;
2351 return (iterate_direct_aliases (0, ref) != NULL);
2354 /* Return true when RESOLUTION indicate that linker will use
2355 the symbol from non-LTO object files. */
2357 inline bool
2358 resolution_used_from_other_file_p (enum ld_plugin_symbol_resolution resolution)
2360 return (resolution == LDPR_PREVAILING_DEF
2361 || resolution == LDPR_PREEMPTED_REG
2362 || resolution == LDPR_RESOLVED_EXEC
2363 || resolution == LDPR_RESOLVED_DYN);
2366 /* Return true when symtab_node is known to be used from other (non-LTO)
2367 object file. Known only when doing LTO via linker plugin. */
2369 inline bool
2370 symtab_node::used_from_object_file_p (void)
2372 if (!TREE_PUBLIC (decl) || DECL_EXTERNAL (decl))
2373 return false;
2374 if (resolution_used_from_other_file_p (resolution))
2375 return true;
2376 return false;
2379 /* Return varpool node for given symbol and check it is a function. */
2381 inline varpool_node *
2382 varpool_node::get (const_tree decl)
2384 gcc_checking_assert (TREE_CODE (decl) == VAR_DECL);
2385 return dyn_cast<varpool_node *> (symtab_node::get (decl));
2388 /* Register a symbol NODE. */
2390 inline void
2391 symbol_table::register_symbol (symtab_node *node)
2393 node->next = nodes;
2394 node->previous = NULL;
2396 if (nodes)
2397 nodes->previous = node;
2398 nodes = node;
2400 node->order = order++;
2403 /* Register a top-level asm statement ASM_STR. */
2405 asm_node *
2406 symbol_table::finalize_toplevel_asm (tree asm_str)
2408 asm_node *node;
2410 node = ggc_cleared_alloc<asm_node> ();
2411 node->asm_str = asm_str;
2412 node->order = order++;
2413 node->next = NULL;
2415 if (asmnodes == NULL)
2416 asmnodes = node;
2417 else
2418 asm_last_node->next = node;
2420 asm_last_node = node;
2421 return node;
2424 /* Unregister a symbol NODE. */
2425 inline void
2426 symbol_table::unregister (symtab_node *node)
2428 if (node->previous)
2429 node->previous->next = node->next;
2430 else
2431 nodes = node->next;
2433 if (node->next)
2434 node->next->previous = node->previous;
2436 node->next = NULL;
2437 node->previous = NULL;
2440 /* Release a callgraph NODE with UID and put in to the list of free nodes. */
2442 inline void
2443 symbol_table::release_symbol (cgraph_node *node, int uid)
2445 cgraph_count--;
2447 /* Clear out the node to NULL all pointers and add the node to the free
2448 list. */
2449 memset (node, 0, sizeof (*node));
2450 node->type = SYMTAB_FUNCTION;
2451 node->uid = uid;
2452 SET_NEXT_FREE_NODE (node, free_nodes);
2453 free_nodes = node;
2456 /* Allocate new callgraph node. */
2458 inline cgraph_node *
2459 symbol_table::allocate_cgraph_symbol (void)
2461 cgraph_node *node;
2463 if (free_nodes)
2465 node = free_nodes;
2466 free_nodes = NEXT_FREE_NODE (node);
2468 else
2470 node = ggc_cleared_alloc<cgraph_node> ();
2471 node->uid = cgraph_max_uid++;
2474 node->summary_uid = cgraph_max_summary_uid++;
2475 return node;
2479 /* Return first static symbol with definition. */
2480 inline symtab_node *
2481 symbol_table::first_symbol (void)
2483 return nodes;
2486 /* Walk all symbols. */
2487 #define FOR_EACH_SYMBOL(node) \
2488 for ((node) = symtab->first_symbol (); (node); (node) = (node)->next)
2490 /* Return first static symbol with definition. */
2491 inline symtab_node *
2492 symbol_table::first_defined_symbol (void)
2494 symtab_node *node;
2496 for (node = nodes; node; node = node->next)
2497 if (node->definition)
2498 return node;
2500 return NULL;
2503 /* Walk all symbols with definitions in current unit. */
2504 #define FOR_EACH_DEFINED_SYMBOL(node) \
2505 for ((node) = symtab->first_defined_symbol (); (node); \
2506 (node) = node->next_defined_symbol ())
2508 /* Return first variable. */
2509 inline varpool_node *
2510 symbol_table::first_variable (void)
2512 symtab_node *node;
2513 for (node = nodes; node; node = node->next)
2514 if (varpool_node *vnode = dyn_cast <varpool_node *> (node))
2515 return vnode;
2516 return NULL;
2519 /* Return next variable after NODE. */
2520 inline varpool_node *
2521 symbol_table::next_variable (varpool_node *node)
2523 symtab_node *node1 = node->next;
2524 for (; node1; node1 = node1->next)
2525 if (varpool_node *vnode1 = dyn_cast <varpool_node *> (node1))
2526 return vnode1;
2527 return NULL;
2529 /* Walk all variables. */
2530 #define FOR_EACH_VARIABLE(node) \
2531 for ((node) = symtab->first_variable (); \
2532 (node); \
2533 (node) = symtab->next_variable ((node)))
2535 /* Return first static variable with initializer. */
2536 inline varpool_node *
2537 symbol_table::first_static_initializer (void)
2539 symtab_node *node;
2540 for (node = nodes; node; node = node->next)
2542 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2543 if (vnode && DECL_INITIAL (node->decl))
2544 return vnode;
2546 return NULL;
2549 /* Return next static variable with initializer after NODE. */
2550 inline varpool_node *
2551 symbol_table::next_static_initializer (varpool_node *node)
2553 symtab_node *node1 = node->next;
2554 for (; node1; node1 = node1->next)
2556 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2557 if (vnode1 && DECL_INITIAL (node1->decl))
2558 return vnode1;
2560 return NULL;
2563 /* Walk all static variables with initializer set. */
2564 #define FOR_EACH_STATIC_INITIALIZER(node) \
2565 for ((node) = symtab->first_static_initializer (); (node); \
2566 (node) = symtab->next_static_initializer (node))
2568 /* Return first static variable with definition. */
2569 inline varpool_node *
2570 symbol_table::first_defined_variable (void)
2572 symtab_node *node;
2573 for (node = nodes; node; node = node->next)
2575 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2576 if (vnode && vnode->definition)
2577 return vnode;
2579 return NULL;
2582 /* Return next static variable with definition after NODE. */
2583 inline varpool_node *
2584 symbol_table::next_defined_variable (varpool_node *node)
2586 symtab_node *node1 = node->next;
2587 for (; node1; node1 = node1->next)
2589 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2590 if (vnode1 && vnode1->definition)
2591 return vnode1;
2593 return NULL;
2595 /* Walk all variables with definitions in current unit. */
2596 #define FOR_EACH_DEFINED_VARIABLE(node) \
2597 for ((node) = symtab->first_defined_variable (); (node); \
2598 (node) = symtab->next_defined_variable (node))
2600 /* Return first function with body defined. */
2601 inline cgraph_node *
2602 symbol_table::first_defined_function (void)
2604 symtab_node *node;
2605 for (node = nodes; node; node = node->next)
2607 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2608 if (cn && cn->definition)
2609 return cn;
2611 return NULL;
2614 /* Return next function with body defined after NODE. */
2615 inline cgraph_node *
2616 symbol_table::next_defined_function (cgraph_node *node)
2618 symtab_node *node1 = node->next;
2619 for (; node1; node1 = node1->next)
2621 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2622 if (cn1 && cn1->definition)
2623 return cn1;
2625 return NULL;
2628 /* Walk all functions with body defined. */
2629 #define FOR_EACH_DEFINED_FUNCTION(node) \
2630 for ((node) = symtab->first_defined_function (); (node); \
2631 (node) = symtab->next_defined_function ((node)))
2633 /* Return first function. */
2634 inline cgraph_node *
2635 symbol_table::first_function (void)
2637 symtab_node *node;
2638 for (node = nodes; node; node = node->next)
2639 if (cgraph_node *cn = dyn_cast <cgraph_node *> (node))
2640 return cn;
2641 return NULL;
2644 /* Return next function. */
2645 inline cgraph_node *
2646 symbol_table::next_function (cgraph_node *node)
2648 symtab_node *node1 = node->next;
2649 for (; node1; node1 = node1->next)
2650 if (cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1))
2651 return cn1;
2652 return NULL;
2655 /* Return first function with body defined. */
2656 inline cgraph_node *
2657 symbol_table::first_function_with_gimple_body (void)
2659 symtab_node *node;
2660 for (node = nodes; node; node = node->next)
2662 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2663 if (cn && cn->has_gimple_body_p ())
2664 return cn;
2666 return NULL;
2669 /* Return next reachable static variable with initializer after NODE. */
2670 inline cgraph_node *
2671 symbol_table::next_function_with_gimple_body (cgraph_node *node)
2673 symtab_node *node1 = node->next;
2674 for (; node1; node1 = node1->next)
2676 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2677 if (cn1 && cn1->has_gimple_body_p ())
2678 return cn1;
2680 return NULL;
2683 /* Walk all functions. */
2684 #define FOR_EACH_FUNCTION(node) \
2685 for ((node) = symtab->first_function (); (node); \
2686 (node) = symtab->next_function ((node)))
2688 /* Return true when callgraph node is a function with Gimple body defined
2689 in current unit. Functions can also be define externally or they
2690 can be thunks with no Gimple representation.
2692 Note that at WPA stage, the function body may not be present in memory. */
2694 inline bool
2695 cgraph_node::has_gimple_body_p (void)
2697 return definition && !thunk.thunk_p && !alias;
2700 /* Walk all functions with body defined. */
2701 #define FOR_EACH_FUNCTION_WITH_GIMPLE_BODY(node) \
2702 for ((node) = symtab->first_function_with_gimple_body (); (node); \
2703 (node) = symtab->next_function_with_gimple_body (node))
2705 /* Uniquize all constants that appear in memory.
2706 Each constant in memory thus far output is recorded
2707 in `const_desc_table'. */
2709 struct GTY((for_user)) constant_descriptor_tree {
2710 /* A MEM for the constant. */
2711 rtx rtl;
2713 /* The value of the constant. */
2714 tree value;
2716 /* Hash of value. Computing the hash from value each time
2717 hashfn is called can't work properly, as that means recursive
2718 use of the hash table during hash table expansion. */
2719 hashval_t hash;
2722 /* Return true when function is only called directly or it has alias.
2723 i.e. it is not externally visible, address was not taken and
2724 it is not used in any other non-standard way. */
2726 inline bool
2727 cgraph_node::only_called_directly_or_aliased_p (void)
2729 gcc_assert (!global.inlined_to);
2730 return (!force_output && !address_taken
2731 && !used_from_other_partition
2732 && !DECL_VIRTUAL_P (decl)
2733 && !DECL_STATIC_CONSTRUCTOR (decl)
2734 && !DECL_STATIC_DESTRUCTOR (decl)
2735 && !used_from_object_file_p ()
2736 && !externally_visible);
2739 /* Return true when function can be removed from callgraph
2740 if all direct calls are eliminated. */
2742 inline bool
2743 cgraph_node::can_remove_if_no_direct_calls_and_refs_p (void)
2745 gcc_checking_assert (!global.inlined_to);
2746 /* Instrumentation clones should not be removed before
2747 instrumentation happens. New callers may appear after
2748 instrumentation. */
2749 if (instrumentation_clone
2750 && !chkp_function_instrumented_p (decl))
2751 return false;
2752 /* Extern inlines can always go, we will use the external definition. */
2753 if (DECL_EXTERNAL (decl))
2754 return true;
2755 /* When function is needed, we can not remove it. */
2756 if (force_output || used_from_other_partition)
2757 return false;
2758 if (DECL_STATIC_CONSTRUCTOR (decl)
2759 || DECL_STATIC_DESTRUCTOR (decl))
2760 return false;
2761 /* Only COMDAT functions can be removed if externally visible. */
2762 if (externally_visible
2763 && (!DECL_COMDAT (decl)
2764 || forced_by_abi
2765 || used_from_object_file_p ()))
2766 return false;
2767 return true;
2770 /* Verify cgraph, if consistency checking is enabled. */
2772 inline void
2773 cgraph_node::checking_verify_cgraph_nodes (void)
2775 if (flag_checking)
2776 cgraph_node::verify_cgraph_nodes ();
2779 /* Return true when variable can be removed from variable pool
2780 if all direct calls are eliminated. */
2782 inline bool
2783 varpool_node::can_remove_if_no_refs_p (void)
2785 if (DECL_EXTERNAL (decl))
2786 return true;
2787 return (!force_output && !used_from_other_partition
2788 && ((DECL_COMDAT (decl)
2789 && !forced_by_abi
2790 && !used_from_object_file_p ())
2791 || !externally_visible
2792 || DECL_HAS_VALUE_EXPR_P (decl)));
2795 /* Return true when all references to variable must be visible in ipa_ref_list.
2796 i.e. if the variable is not externally visible or not used in some magic
2797 way (asm statement or such).
2798 The magic uses are all summarized in force_output flag. */
2800 inline bool
2801 varpool_node::all_refs_explicit_p ()
2803 return (definition
2804 && !externally_visible
2805 && !used_from_other_partition
2806 && !force_output);
2809 struct tree_descriptor_hasher : ggc_ptr_hash<constant_descriptor_tree>
2811 static hashval_t hash (constant_descriptor_tree *);
2812 static bool equal (constant_descriptor_tree *, constant_descriptor_tree *);
2815 /* Constant pool accessor function. */
2816 hash_table<tree_descriptor_hasher> *constant_pool_htab (void);
2818 /* Return node that alias is aliasing. */
2820 inline cgraph_node *
2821 cgraph_node::get_alias_target (void)
2823 return dyn_cast <cgraph_node *> (symtab_node::get_alias_target ());
2826 /* Return node that alias is aliasing. */
2828 inline varpool_node *
2829 varpool_node::get_alias_target (void)
2831 return dyn_cast <varpool_node *> (symtab_node::get_alias_target ());
2834 /* Walk the alias chain to return the symbol NODE is alias of.
2835 If NODE is not an alias, return NODE.
2836 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2838 inline symtab_node *
2839 symtab_node::ultimate_alias_target (enum availability *availability)
2841 if (!alias)
2843 if (availability)
2844 *availability = get_availability ();
2845 return this;
2848 return ultimate_alias_target_1 (availability);
2851 /* Given function symbol, walk the alias chain to return the function node
2852 is alias of. Do not walk through thunks.
2853 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2855 inline cgraph_node *
2856 cgraph_node::ultimate_alias_target (enum availability *availability)
2858 cgraph_node *n = dyn_cast <cgraph_node *>
2859 (symtab_node::ultimate_alias_target (availability));
2860 if (!n && availability)
2861 *availability = AVAIL_NOT_AVAILABLE;
2862 return n;
2865 /* For given variable pool node, walk the alias chain to return the function
2866 the variable is alias of. Do not walk through thunks.
2867 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2869 inline varpool_node *
2870 varpool_node::ultimate_alias_target (availability *availability)
2872 varpool_node *n = dyn_cast <varpool_node *>
2873 (symtab_node::ultimate_alias_target (availability));
2875 if (!n && availability)
2876 *availability = AVAIL_NOT_AVAILABLE;
2877 return n;
2880 /* Set callee N of call graph edge and add it to the corresponding set of
2881 callers. */
2883 inline void
2884 cgraph_edge::set_callee (cgraph_node *n)
2886 prev_caller = NULL;
2887 if (n->callers)
2888 n->callers->prev_caller = this;
2889 next_caller = n->callers;
2890 n->callers = this;
2891 callee = n;
2894 /* Redirect callee of the edge to N. The function does not update underlying
2895 call expression. */
2897 inline void
2898 cgraph_edge::redirect_callee (cgraph_node *n)
2900 /* Remove from callers list of the current callee. */
2901 remove_callee ();
2903 /* Insert to callers list of the new callee. */
2904 set_callee (n);
2907 /* Return true when the edge represents a direct recursion. */
2909 inline bool
2910 cgraph_edge::recursive_p (void)
2912 cgraph_node *c = callee->ultimate_alias_target ();
2913 if (caller->global.inlined_to)
2914 return caller->global.inlined_to->decl == c->decl;
2915 else
2916 return caller->decl == c->decl;
2919 /* Remove the edge from the list of the callers of the callee. */
2921 inline void
2922 cgraph_edge::remove_callee (void)
2924 gcc_assert (!indirect_unknown_callee);
2925 if (prev_caller)
2926 prev_caller->next_caller = next_caller;
2927 if (next_caller)
2928 next_caller->prev_caller = prev_caller;
2929 if (!prev_caller)
2930 callee->callers = next_caller;
2933 /* Return true if the TM_CLONE bit is set for a given FNDECL. */
2934 static inline bool
2935 decl_is_tm_clone (const_tree fndecl)
2937 cgraph_node *n = cgraph_node::get (fndecl);
2938 if (n)
2939 return n->tm_clone;
2940 return false;
2943 /* Likewise indicate that a node is needed, i.e. reachable via some
2944 external means. */
2946 inline void
2947 cgraph_node::mark_force_output (void)
2949 force_output = 1;
2950 gcc_checking_assert (!global.inlined_to);
2953 /* Return true if function should be optimized for size. */
2955 inline bool
2956 cgraph_node::optimize_for_size_p (void)
2958 if (opt_for_fn (decl, optimize_size))
2959 return true;
2960 if (frequency == NODE_FREQUENCY_UNLIKELY_EXECUTED)
2961 return true;
2962 else
2963 return false;
2966 /* Return symtab_node for NODE or create one if it is not present
2967 in symtab. */
2969 inline symtab_node *
2970 symtab_node::get_create (tree node)
2972 if (TREE_CODE (node) == VAR_DECL)
2973 return varpool_node::get_create (node);
2974 else
2975 return cgraph_node::get_create (node);
2978 /* Return availability of NODE. */
2980 inline enum availability
2981 symtab_node::get_availability (void)
2983 if (is_a <cgraph_node *> (this))
2984 return dyn_cast <cgraph_node *> (this)->get_availability ();
2985 else
2986 return dyn_cast <varpool_node *> (this)->get_availability ();
2989 /* Call calback on symtab node and aliases associated to this node.
2990 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
2991 skipped. */
2993 inline bool
2994 symtab_node::call_for_symbol_and_aliases (bool (*callback) (symtab_node *,
2995 void *),
2996 void *data,
2997 bool include_overwritable)
2999 if (callback (this, data))
3000 return true;
3001 if (has_aliases_p ())
3002 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3003 return false;
3006 /* Call callback on function and aliases associated to the function.
3007 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
3008 skipped. */
3010 inline bool
3011 cgraph_node::call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
3012 void *),
3013 void *data,
3014 bool include_overwritable)
3016 if (callback (this, data))
3017 return true;
3018 if (has_aliases_p ())
3019 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3020 return false;
3023 /* Call calback on varpool symbol and aliases associated to varpool symbol.
3024 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
3025 skipped. */
3027 inline bool
3028 varpool_node::call_for_symbol_and_aliases (bool (*callback) (varpool_node *,
3029 void *),
3030 void *data,
3031 bool include_overwritable)
3033 if (callback (this, data))
3034 return true;
3035 if (has_aliases_p ())
3036 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3037 return false;
3040 /* Return true if refernece may be used in address compare. */
3042 inline bool
3043 ipa_ref::address_matters_p ()
3045 if (use != IPA_REF_ADDR)
3046 return false;
3047 /* Addresses taken from virtual tables are never compared. */
3048 if (is_a <varpool_node *> (referring)
3049 && DECL_VIRTUAL_P (referring->decl))
3050 return false;
3051 return referred->address_can_be_compared_p ();
3054 /* Build polymorphic call context for indirect call E. */
3056 inline
3057 ipa_polymorphic_call_context::ipa_polymorphic_call_context (cgraph_edge *e)
3059 gcc_checking_assert (e->indirect_info->polymorphic);
3060 *this = e->indirect_info->context;
3063 /* Build empty "I know nothing" context. */
3065 inline
3066 ipa_polymorphic_call_context::ipa_polymorphic_call_context ()
3068 clear_speculation ();
3069 clear_outer_type ();
3070 invalid = false;
3073 /* Make context non-speculative. */
3075 inline void
3076 ipa_polymorphic_call_context::clear_speculation ()
3078 speculative_outer_type = NULL;
3079 speculative_offset = 0;
3080 speculative_maybe_derived_type = false;
3083 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
3084 NULL, the context is set to dummy "I know nothing" setting. */
3086 inline void
3087 ipa_polymorphic_call_context::clear_outer_type (tree otr_type)
3089 outer_type = otr_type ? TYPE_MAIN_VARIANT (otr_type) : NULL;
3090 offset = 0;
3091 maybe_derived_type = true;
3092 maybe_in_construction = true;
3093 dynamic = true;
3096 /* Adjust all offsets in contexts by OFF bits. */
3098 inline void
3099 ipa_polymorphic_call_context::offset_by (HOST_WIDE_INT off)
3101 if (outer_type)
3102 offset += off;
3103 if (speculative_outer_type)
3104 speculative_offset += off;
3107 /* Return TRUE if context is fully useless. */
3109 inline bool
3110 ipa_polymorphic_call_context::useless_p () const
3112 return (!outer_type && !speculative_outer_type);
3115 /* Return true if NODE is local. Instrumentation clones are counted as local
3116 only when original function is local. */
3118 static inline bool
3119 cgraph_local_p (cgraph_node *node)
3121 if (!node->instrumentation_clone || !node->instrumented_version)
3122 return node->local.local;
3124 return node->local.local && node->instrumented_version->local.local;
3127 /* When using fprintf (or similar), problems can arise with
3128 transient generated strings. Many string-generation APIs
3129 only support one result being alive at once (e.g. by
3130 returning a pointer to a statically-allocated buffer).
3132 If there is more than one generated string within one
3133 fprintf call: the first string gets evicted or overwritten
3134 by the second, before fprintf is fully evaluated.
3135 See e.g. PR/53136.
3137 This function provides a workaround for this, by providing
3138 a simple way to create copies of these transient strings,
3139 without the need to have explicit cleanup:
3141 fprintf (dumpfile, "string 1: %s string 2:%s\n",
3142 xstrdup_for_dump (EXPR_1),
3143 xstrdup_for_dump (EXPR_2));
3145 This is actually a simple wrapper around ggc_strdup, but
3146 the name documents the intent. We require that no GC can occur
3147 within the fprintf call. */
3149 static inline const char *
3150 xstrdup_for_dump (const char *transient_str)
3152 return ggc_strdup (transient_str);
3155 #endif /* GCC_CGRAPH_H */