PR ipa/65130
[official-gcc.git] / gcc / cgraph.h
blobff437cf18b82fe2015980a397acd528e3fff8f0e
1 /* Callgraph handling code.
2 Copyright (C) 2003-2015 Free Software Foundation, Inc.
3 Contributed by Jan Hubicka
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
10 version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
21 #ifndef GCC_CGRAPH_H
22 #define GCC_CGRAPH_H
25 /* Symbol table consists of functions and variables.
26 TODO: add labels and CONST_DECLs. */
27 enum symtab_type
29 SYMTAB_SYMBOL,
30 SYMTAB_FUNCTION,
31 SYMTAB_VARIABLE
34 /* Section names are stored as reference counted strings in GGC safe hashtable
35 (to make them survive through PCH). */
37 struct GTY((for_user)) section_hash_entry_d
39 int ref_count;
40 char *name; /* As long as this datastructure stays in GGC, we can not put
41 string at the tail of structure of GGC dies in horrible
42 way */
45 typedef struct section_hash_entry_d section_hash_entry;
47 struct section_name_hasher : ggc_hasher<section_hash_entry *>
49 typedef const char *compare_type;
51 static hashval_t hash (section_hash_entry *);
52 static bool equal (section_hash_entry *, const char *);
55 enum availability
57 /* Not yet set by cgraph_function_body_availability. */
58 AVAIL_UNSET,
59 /* Function body/variable initializer is unknown. */
60 AVAIL_NOT_AVAILABLE,
61 /* Function body/variable initializer is known but might be replaced
62 by a different one from other compilation unit and thus needs to
63 be dealt with a care. Like AVAIL_NOT_AVAILABLE it can have
64 arbitrary side effects on escaping variables and functions, while
65 like AVAILABLE it might access static variables. */
66 AVAIL_INTERPOSABLE,
67 /* Function body/variable initializer is known and will be used in final
68 program. */
69 AVAIL_AVAILABLE,
70 /* Function body/variable initializer is known and all it's uses are
71 explicitly visible within current unit (ie it's address is never taken and
72 it is not exported to other units). Currently used only for functions. */
73 AVAIL_LOCAL
76 /* Classification of symbols WRT partitioning. */
77 enum symbol_partitioning_class
79 /* External declarations are ignored by partitioning algorithms and they are
80 added into the boundary later via compute_ltrans_boundary. */
81 SYMBOL_EXTERNAL,
82 /* Partitioned symbols are pur into one of partitions. */
83 SYMBOL_PARTITION,
84 /* Duplicated symbols (such as comdat or constant pool references) are
85 copied into every node needing them via add_symbol_to_partition. */
86 SYMBOL_DUPLICATE
89 /* Base of all entries in the symbol table.
90 The symtab_node is inherited by cgraph and varpol nodes. */
91 class GTY((desc ("%h.type"), tag ("SYMTAB_SYMBOL"),
92 chain_next ("%h.next"), chain_prev ("%h.previous")))
93 symtab_node
95 public:
96 /* Return name. */
97 const char *name () const;
99 /* Return asm name. */
100 const char * asm_name () const;
102 /* Add node into symbol table. This function is not used directly, but via
103 cgraph/varpool node creation routines. */
104 void register_symbol (void);
106 /* Remove symbol from symbol table. */
107 void remove (void);
109 /* Dump symtab node to F. */
110 void dump (FILE *f);
112 /* Dump symtab node to stderr. */
113 void DEBUG_FUNCTION debug (void);
115 /* Verify consistency of node. */
116 void DEBUG_FUNCTION verify (void);
118 /* Return ipa reference from this symtab_node to
119 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
120 of the use and STMT the statement (if it exists). */
121 ipa_ref *create_reference (symtab_node *referred_node,
122 enum ipa_ref_use use_type);
124 /* Return ipa reference from this symtab_node to
125 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
126 of the use and STMT the statement (if it exists). */
127 ipa_ref *create_reference (symtab_node *referred_node,
128 enum ipa_ref_use use_type, gimple stmt);
130 /* If VAL is a reference to a function or a variable, add a reference from
131 this symtab_node to the corresponding symbol table node. USE_TYPE specify
132 type of the use and STMT the statement (if it exists). Return the new
133 reference or NULL if none was created. */
134 ipa_ref *maybe_create_reference (tree val, enum ipa_ref_use use_type,
135 gimple stmt);
137 /* Clone all references from symtab NODE to this symtab_node. */
138 void clone_references (symtab_node *node);
140 /* Remove all stmt references in non-speculative references.
141 Those are not maintained during inlining & clonning.
142 The exception are speculative references that are updated along
143 with callgraph edges associated with them. */
144 void clone_referring (symtab_node *node);
146 /* Clone reference REF to this symtab_node and set its stmt to STMT. */
147 ipa_ref *clone_reference (ipa_ref *ref, gimple stmt);
149 /* Find the structure describing a reference to REFERRED_NODE
150 and associated with statement STMT. */
151 ipa_ref *find_reference (symtab_node *referred_node, gimple stmt,
152 unsigned int lto_stmt_uid);
154 /* Remove all references that are associated with statement STMT. */
155 void remove_stmt_references (gimple stmt);
157 /* Remove all stmt references in non-speculative references.
158 Those are not maintained during inlining & clonning.
159 The exception are speculative references that are updated along
160 with callgraph edges associated with them. */
161 void clear_stmts_in_references (void);
163 /* Remove all references in ref list. */
164 void remove_all_references (void);
166 /* Remove all referring items in ref list. */
167 void remove_all_referring (void);
169 /* Dump references in ref list to FILE. */
170 void dump_references (FILE *file);
172 /* Dump referring in list to FILE. */
173 void dump_referring (FILE *);
175 /* Get number of references for this node. */
176 inline unsigned num_references (void)
178 return ref_list.references ? ref_list.references->length () : 0;
181 /* Iterates I-th reference in the list, REF is also set. */
182 ipa_ref *iterate_reference (unsigned i, ipa_ref *&ref);
184 /* Iterates I-th referring item in the list, REF is also set. */
185 ipa_ref *iterate_referring (unsigned i, ipa_ref *&ref);
187 /* Iterates I-th referring alias item in the list, REF is also set. */
188 ipa_ref *iterate_direct_aliases (unsigned i, ipa_ref *&ref);
190 /* Return true if symtab node and TARGET represents
191 semantically equivalent symbols. */
192 bool semantically_equivalent_p (symtab_node *target);
194 /* Classify symbol symtab node for partitioning. */
195 enum symbol_partitioning_class get_partitioning_class (void);
197 /* Return comdat group. */
198 tree get_comdat_group ()
200 return x_comdat_group;
203 /* Return comdat group as identifier_node. */
204 tree get_comdat_group_id ()
206 if (x_comdat_group && TREE_CODE (x_comdat_group) != IDENTIFIER_NODE)
207 x_comdat_group = DECL_ASSEMBLER_NAME (x_comdat_group);
208 return x_comdat_group;
211 /* Set comdat group. */
212 void set_comdat_group (tree group)
214 gcc_checking_assert (!group || TREE_CODE (group) == IDENTIFIER_NODE
215 || DECL_P (group));
216 x_comdat_group = group;
219 /* Return section as string. */
220 const char * get_section ()
222 if (!x_section)
223 return NULL;
224 return x_section->name;
227 /* Remove node from same comdat group. */
228 void remove_from_same_comdat_group (void);
230 /* Add this symtab_node to the same comdat group that OLD is in. */
231 void add_to_same_comdat_group (symtab_node *old_node);
233 /* Dissolve the same_comdat_group list in which NODE resides. */
234 void dissolve_same_comdat_group_list (void);
236 /* Return true when symtab_node is known to be used from other (non-LTO)
237 object file. Known only when doing LTO via linker plugin. */
238 bool used_from_object_file_p (void);
240 /* Walk the alias chain to return the symbol NODE is alias of.
241 If NODE is not an alias, return NODE.
242 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
243 symtab_node *ultimate_alias_target (enum availability *avail = NULL);
245 /* Return next reachable static symbol with initializer after NODE. */
246 inline symtab_node *next_defined_symbol (void);
248 /* Add reference recording that symtab node is alias of TARGET.
249 The function can fail in the case of aliasing cycles; in this case
250 it returns false. */
251 bool resolve_alias (symtab_node *target);
253 /* C++ FE sometimes change linkage flags after producing same
254 body aliases. */
255 void fixup_same_cpp_alias_visibility (symtab_node *target);
257 /* Call callback on symtab node and aliases associated to this node.
258 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
259 skipped. */
260 bool call_for_symbol_and_aliases (bool (*callback) (symtab_node *, void *),
261 void *data,
262 bool include_overwrite);
264 /* If node can not be interposable by static or dynamic linker to point to
265 different definition, return this symbol. Otherwise look for alias with
266 such property and if none exists, introduce new one. */
267 symtab_node *noninterposable_alias (void);
269 /* Return node that alias is aliasing. */
270 inline symtab_node *get_alias_target (void);
272 /* Set section for symbol and its aliases. */
273 void set_section (const char *section);
275 /* Set section, do not recurse into aliases.
276 When one wants to change section of symbol and its aliases,
277 use set_section. */
278 void set_section_for_node (const char *section);
280 /* Set initialization priority to PRIORITY. */
281 void set_init_priority (priority_type priority);
283 /* Return the initialization priority. */
284 priority_type get_init_priority ();
286 /* Return availability of NODE. */
287 enum availability get_availability (void);
289 /* Make DECL local. */
290 void make_decl_local (void);
292 /* Return true if list contains an alias. */
293 bool has_aliases_p (void);
295 /* Return true when the symbol is real symbol, i.e. it is not inline clone
296 or abstract function kept for debug info purposes only. */
297 bool real_symbol_p (void);
299 /* Determine if symbol declaration is needed. That is, visible to something
300 either outside this translation unit, something magic in the system
301 configury. This function is used just during symbol creation. */
302 bool needed_p (void);
304 /* Return true when there are references to the node. */
305 bool referred_to_p (void);
307 /* Return true if NODE can be discarded by linker from the binary. */
308 inline bool
309 can_be_discarded_p (void)
311 return (DECL_EXTERNAL (decl)
312 || (get_comdat_group ()
313 && resolution != LDPR_PREVAILING_DEF
314 && resolution != LDPR_PREVAILING_DEF_IRONLY
315 && resolution != LDPR_PREVAILING_DEF_IRONLY_EXP));
318 /* Return true if NODE is local to a particular COMDAT group, and must not
319 be named from outside the COMDAT. This is used for C++ decloned
320 constructors. */
321 inline bool comdat_local_p (void)
323 return (same_comdat_group && !TREE_PUBLIC (decl));
326 /* Return true if ONE and TWO are part of the same COMDAT group. */
327 inline bool in_same_comdat_group_p (symtab_node *target);
329 /* Return true if symbol is known to be nonzero. */
330 bool nonzero_address ();
332 /* Return 0 if symbol is known to have different address than S2,
333 Return 1 if symbol is known to have same address as S2,
334 return 2 otherwise. */
335 int equal_address_to (symtab_node *s2);
337 /* Return true if symbol's address may possibly be compared to other
338 symbol's address. */
339 bool address_matters_p ();
341 /* Return true if NODE's address can be compared. This use properties
342 of NODE only and does not look if the address is actually taken in
343 interesting way. For that use ADDRESS_MATTERS_P instead. */
344 bool address_can_be_compared_p (void);
346 /* Return symbol table node associated with DECL, if any,
347 and NULL otherwise. */
348 static inline symtab_node *get (const_tree decl)
350 #ifdef ENABLE_CHECKING
351 /* Check that we are called for sane type of object - functions
352 and static or external variables. */
353 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL
354 || (TREE_CODE (decl) == VAR_DECL
355 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl)
356 || in_lto_p)));
357 /* Check that the mapping is sane - perhaps this check can go away,
358 but at the moment frontends tends to corrupt the mapping by calling
359 memcpy/memset on the tree nodes. */
360 gcc_checking_assert (!decl->decl_with_vis.symtab_node
361 || decl->decl_with_vis.symtab_node->decl == decl);
362 #endif
363 return decl->decl_with_vis.symtab_node;
366 /* Try to find a symtab node for declaration DECL and if it does not
367 exist or if it corresponds to an inline clone, create a new one. */
368 static inline symtab_node * get_create (tree node);
370 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
371 Return NULL if there's no such node. */
372 static symtab_node *get_for_asmname (const_tree asmname);
374 /* Dump symbol table to F. */
375 static void dump_table (FILE *);
377 /* Dump symbol table to stderr. */
378 static inline DEBUG_FUNCTION void debug_symtab (void)
380 dump_table (stderr);
383 /* Verify symbol table for internal consistency. */
384 static DEBUG_FUNCTION void verify_symtab_nodes (void);
386 /* Type of the symbol. */
387 ENUM_BITFIELD (symtab_type) type : 8;
389 /* The symbols resolution. */
390 ENUM_BITFIELD (ld_plugin_symbol_resolution) resolution : 8;
392 /*** Flags representing the symbol type. ***/
394 /* True when symbol corresponds to a definition in current unit.
395 set via finalize_function or finalize_decl */
396 unsigned definition : 1;
397 /* True when symbol is an alias.
398 Set by ssemble_alias. */
399 unsigned alias : 1;
400 /* True when alias is a weakref. */
401 unsigned weakref : 1;
402 /* C++ frontend produce same body aliases and extra name aliases for
403 virtual functions and vtables that are obviously equivalent.
404 Those aliases are bit special, especially because C++ frontend
405 visibility code is so ugly it can not get them right at first time
406 and their visibility needs to be copied from their "masters" at
407 the end of parsing. */
408 unsigned cpp_implicit_alias : 1;
409 /* Set once the definition was analyzed. The list of references and
410 other properties are built during analysis. */
411 unsigned analyzed : 1;
412 /* Set for write-only variables. */
413 unsigned writeonly : 1;
414 /* Visibility of symbol was used for further optimization; do not
415 permit further changes. */
416 unsigned refuse_visibility_changes : 1;
418 /*** Visibility and linkage flags. ***/
420 /* Set when function is visible by other units. */
421 unsigned externally_visible : 1;
422 /* Don't reorder to other symbols having this set. */
423 unsigned no_reorder : 1;
424 /* The symbol will be assumed to be used in an invisible way (like
425 by an toplevel asm statement). */
426 unsigned force_output : 1;
427 /* Like FORCE_OUTPUT, but in the case it is ABI requiring the symbol to be
428 exported. Unlike FORCE_OUTPUT this flag gets cleared to symbols promoted
429 to static and it does not inhibit optimization. */
430 unsigned forced_by_abi : 1;
431 /* True when the name is known to be unique and thus it does not need mangling. */
432 unsigned unique_name : 1;
433 /* Specify whether the section was set by user or by
434 compiler via -ffunction-sections. */
435 unsigned implicit_section : 1;
436 /* True when body and other characteristics have been removed by
437 symtab_remove_unreachable_nodes. */
438 unsigned body_removed : 1;
440 /*** WHOPR Partitioning flags.
441 These flags are used at ltrans stage when only part of the callgraph is
442 available. ***/
444 /* Set when variable is used from other LTRANS partition. */
445 unsigned used_from_other_partition : 1;
446 /* Set when function is available in the other LTRANS partition.
447 During WPA output it is used to mark nodes that are present in
448 multiple partitions. */
449 unsigned in_other_partition : 1;
453 /*** other flags. ***/
455 /* Set when symbol has address taken. */
456 unsigned address_taken : 1;
457 /* Set when init priority is set. */
458 unsigned in_init_priority_hash : 1;
460 /* Set when symbol needs to be streamed into LTO bytecode for LTO, or in case
461 of offloading, for separate compilation for a different target. */
462 unsigned need_lto_streaming : 1;
464 /* Set when symbol can be streamed into bytecode for offloading. */
465 unsigned offloadable : 1;
468 /* Ordering of all symtab entries. */
469 int order;
471 /* Declaration representing the symbol. */
472 tree decl;
474 /* Linked list of symbol table entries starting with symtab_nodes. */
475 symtab_node *next;
476 symtab_node *previous;
478 /* Linked list of symbols with the same asm name. There may be multiple
479 entries for single symbol name during LTO, because symbols are renamed
480 only after partitioning.
482 Because inline clones are kept in the assembler name has, they also produce
483 duplicate entries.
485 There are also several long standing bugs where frontends and builtin
486 code produce duplicated decls. */
487 symtab_node *next_sharing_asm_name;
488 symtab_node *previous_sharing_asm_name;
490 /* Circular list of nodes in the same comdat group if non-NULL. */
491 symtab_node *same_comdat_group;
493 /* Vectors of referring and referenced entities. */
494 ipa_ref_list ref_list;
496 /* Alias target. May be either DECL pointer or ASSEMBLER_NAME pointer
497 depending to what was known to frontend on the creation time.
498 Once alias is resolved, this pointer become NULL. */
499 tree alias_target;
501 /* File stream where this node is being written to. */
502 struct lto_file_decl_data * lto_file_data;
504 PTR GTY ((skip)) aux;
506 /* Comdat group the symbol is in. Can be private if GGC allowed that. */
507 tree x_comdat_group;
509 /* Section name. Again can be private, if allowed. */
510 section_hash_entry *x_section;
512 protected:
513 /* Dump base fields of symtab nodes to F. Not to be used directly. */
514 void dump_base (FILE *);
516 /* Verify common part of symtab node. */
517 bool DEBUG_FUNCTION verify_base (void);
519 /* Remove node from symbol table. This function is not used directly, but via
520 cgraph/varpool node removal routines. */
521 void unregister (void);
523 /* Return the initialization and finalization priority information for
524 DECL. If there is no previous priority information, a freshly
525 allocated structure is returned. */
526 struct symbol_priority_map *priority_info (void);
528 /* Worker for call_for_symbol_and_aliases_1. */
529 bool call_for_symbol_and_aliases_1 (bool (*callback) (symtab_node *, void *),
530 void *data,
531 bool include_overwrite);
532 private:
533 /* Worker for set_section. */
534 static bool set_section (symtab_node *n, void *s);
536 /* Worker for symtab_resolve_alias. */
537 static bool set_implicit_section (symtab_node *n, void *);
539 /* Worker searching noninterposable alias. */
540 static bool noninterposable_alias (symtab_node *node, void *data);
542 /* Worker for ultimate_alias_target. */
543 symtab_node *ultimate_alias_target_1 (enum availability *avail = NULL);
546 /* Walk all aliases for NODE. */
547 #define FOR_EACH_ALIAS(node, alias) \
548 for (unsigned x_i = 0; node->iterate_direct_aliases (x_i, alias); x_i++)
550 /* This is the information that is put into the cgraph local structure
551 to recover a function. */
552 struct lto_file_decl_data;
554 extern const char * const cgraph_availability_names[];
555 extern const char * const ld_plugin_symbol_resolution_names[];
556 extern const char * const tls_model_names[];
558 /* Information about thunk, used only for same body aliases. */
560 struct GTY(()) cgraph_thunk_info {
561 /* Information about the thunk. */
562 HOST_WIDE_INT fixed_offset;
563 HOST_WIDE_INT virtual_value;
564 tree alias;
565 bool this_adjusting;
566 bool virtual_offset_p;
567 bool add_pointer_bounds_args;
568 /* Set to true when alias node is thunk. */
569 bool thunk_p;
572 /* Information about the function collected locally.
573 Available after function is analyzed. */
575 struct GTY(()) cgraph_local_info {
576 /* Set when function function is visible in current compilation unit only
577 and its address is never taken. */
578 unsigned local : 1;
580 /* False when there is something makes versioning impossible. */
581 unsigned versionable : 1;
583 /* False when function calling convention and signature can not be changed.
584 This is the case when __builtin_apply_args is used. */
585 unsigned can_change_signature : 1;
587 /* True when the function has been originally extern inline, but it is
588 redefined now. */
589 unsigned redefined_extern_inline : 1;
591 /* True if the function may enter serial irrevocable mode. */
592 unsigned tm_may_enter_irr : 1;
595 /* Information about the function that needs to be computed globally
596 once compilation is finished. Available only with -funit-at-a-time. */
598 struct GTY(()) cgraph_global_info {
599 /* For inline clones this points to the function they will be
600 inlined into. */
601 cgraph_node *inlined_to;
604 /* Information about the function that is propagated by the RTL backend.
605 Available only for functions that has been already assembled. */
607 struct GTY(()) cgraph_rtl_info {
608 unsigned int preferred_incoming_stack_boundary;
610 /* Call unsaved hard registers really used by the corresponding
611 function (including ones used by functions called by the
612 function). */
613 HARD_REG_SET function_used_regs;
614 /* Set if function_used_regs is valid. */
615 unsigned function_used_regs_valid: 1;
618 /* Represent which DECL tree (or reference to such tree)
619 will be replaced by another tree while versioning. */
620 struct GTY(()) ipa_replace_map
622 /* The tree that will be replaced. */
623 tree old_tree;
624 /* The new (replacing) tree. */
625 tree new_tree;
626 /* Parameter number to replace, when old_tree is NULL. */
627 int parm_num;
628 /* True when a substitution should be done, false otherwise. */
629 bool replace_p;
630 /* True when we replace a reference to old_tree. */
631 bool ref_p;
634 struct GTY(()) cgraph_clone_info
636 vec<ipa_replace_map *, va_gc> *tree_map;
637 bitmap args_to_skip;
638 bitmap combined_args_to_skip;
641 enum cgraph_simd_clone_arg_type
643 SIMD_CLONE_ARG_TYPE_VECTOR,
644 SIMD_CLONE_ARG_TYPE_UNIFORM,
645 SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP,
646 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP,
647 SIMD_CLONE_ARG_TYPE_MASK
650 /* Function arguments in the original function of a SIMD clone.
651 Supplementary data for `struct simd_clone'. */
653 struct GTY(()) cgraph_simd_clone_arg {
654 /* Original function argument as it originally existed in
655 DECL_ARGUMENTS. */
656 tree orig_arg;
658 /* orig_arg's function (or for extern functions type from
659 TYPE_ARG_TYPES). */
660 tree orig_type;
662 /* If argument is a vector, this holds the vector version of
663 orig_arg that after adjusting the argument types will live in
664 DECL_ARGUMENTS. Otherwise, this is NULL.
666 This basically holds:
667 vector(simdlen) __typeof__(orig_arg) new_arg. */
668 tree vector_arg;
670 /* vector_arg's type (or for extern functions new vector type. */
671 tree vector_type;
673 /* If argument is a vector, this holds the array where the simd
674 argument is held while executing the simd clone function. This
675 is a local variable in the cloned function. Its content is
676 copied from vector_arg upon entry to the clone.
678 This basically holds:
679 __typeof__(orig_arg) simd_array[simdlen]. */
680 tree simd_array;
682 /* A SIMD clone's argument can be either linear (constant or
683 variable), uniform, or vector. */
684 enum cgraph_simd_clone_arg_type arg_type;
686 /* For arg_type SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP this is
687 the constant linear step, if arg_type is
688 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP, this is index of
689 the uniform argument holding the step, otherwise 0. */
690 HOST_WIDE_INT linear_step;
692 /* Variable alignment if available, otherwise 0. */
693 unsigned int alignment;
696 /* Specific data for a SIMD function clone. */
698 struct GTY(()) cgraph_simd_clone {
699 /* Number of words in the SIMD lane associated with this clone. */
700 unsigned int simdlen;
702 /* Number of annotated function arguments in `args'. This is
703 usually the number of named arguments in FNDECL. */
704 unsigned int nargs;
706 /* Max hardware vector size in bits for integral vectors. */
707 unsigned int vecsize_int;
709 /* Max hardware vector size in bits for floating point vectors. */
710 unsigned int vecsize_float;
712 /* The mangling character for a given vector size. This is is used
713 to determine the ISA mangling bit as specified in the Intel
714 Vector ABI. */
715 unsigned char vecsize_mangle;
717 /* True if this is the masked, in-branch version of the clone,
718 otherwise false. */
719 unsigned int inbranch : 1;
721 /* True if this is a Cilk Plus variant. */
722 unsigned int cilk_elemental : 1;
724 /* Doubly linked list of SIMD clones. */
725 cgraph_node *prev_clone, *next_clone;
727 /* Original cgraph node the SIMD clones were created for. */
728 cgraph_node *origin;
730 /* Annotated function arguments for the original function. */
731 cgraph_simd_clone_arg GTY((length ("%h.nargs"))) args[1];
734 /* Function Multiversioning info. */
735 struct GTY((for_user)) cgraph_function_version_info {
736 /* The cgraph_node for which the function version info is stored. */
737 cgraph_node *this_node;
738 /* Chains all the semantically identical function versions. The
739 first function in this chain is the version_info node of the
740 default function. */
741 cgraph_function_version_info *prev;
742 /* If this version node corresponds to a dispatcher for function
743 versions, this points to the version info node of the default
744 function, the first node in the chain. */
745 cgraph_function_version_info *next;
746 /* If this node corresponds to a function version, this points
747 to the dispatcher function decl, which is the function that must
748 be called to execute the right function version at run-time.
750 If this cgraph node is a dispatcher (if dispatcher_function is
751 true, in the cgraph_node struct) for function versions, this
752 points to resolver function, which holds the function body of the
753 dispatcher. The dispatcher decl is an alias to the resolver
754 function decl. */
755 tree dispatcher_resolver;
758 #define DEFCIFCODE(code, type, string) CIF_ ## code,
759 /* Reasons for inlining failures. */
761 enum cgraph_inline_failed_t {
762 #include "cif-code.def"
763 CIF_N_REASONS
766 enum cgraph_inline_failed_type_t
768 CIF_FINAL_NORMAL = 0,
769 CIF_FINAL_ERROR
772 struct cgraph_edge;
774 struct cgraph_edge_hasher : ggc_hasher<cgraph_edge *>
776 typedef gimple compare_type;
778 static hashval_t hash (cgraph_edge *);
779 static bool equal (cgraph_edge *, gimple);
782 /* The cgraph data structure.
783 Each function decl has assigned cgraph_node listing callees and callers. */
785 struct GTY((tag ("SYMTAB_FUNCTION"))) cgraph_node : public symtab_node {
786 public:
787 /* Remove the node from cgraph and all inline clones inlined into it.
788 Skip however removal of FORBIDDEN_NODE and return true if it needs to be
789 removed. This allows to call the function from outer loop walking clone
790 tree. */
791 bool remove_symbol_and_inline_clones (cgraph_node *forbidden_node = NULL);
793 /* Record all references from cgraph_node that are taken
794 in statement STMT. */
795 void record_stmt_references (gimple stmt);
797 /* Like cgraph_set_call_stmt but walk the clone tree and update all
798 clones sharing the same function body.
799 When WHOLE_SPECULATIVE_EDGES is true, all three components of
800 speculative edge gets updated. Otherwise we update only direct
801 call. */
802 void set_call_stmt_including_clones (gimple old_stmt, gcall *new_stmt,
803 bool update_speculative = true);
805 /* Walk the alias chain to return the function cgraph_node is alias of.
806 Walk through thunk, too.
807 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
808 cgraph_node *function_symbol (enum availability *avail = NULL);
810 /* Walk the alias chain to return the function cgraph_node is alias of.
811 Walk through non virtual thunks, too. Thus we return either a function
812 or a virtual thunk node.
813 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
814 cgraph_node *function_or_virtual_thunk_symbol
815 (enum availability *avail = NULL);
817 /* Create node representing clone of N executed COUNT times. Decrease
818 the execution counts from original node too.
819 The new clone will have decl set to DECL that may or may not be the same
820 as decl of N.
822 When UPDATE_ORIGINAL is true, the counts are subtracted from the original
823 function's profile to reflect the fact that part of execution is handled
824 by node.
825 When CALL_DUPLICATOIN_HOOK is true, the ipa passes are acknowledged about
826 the new clone. Otherwise the caller is responsible for doing so later.
828 If the new node is being inlined into another one, NEW_INLINED_TO should be
829 the outline function the new one is (even indirectly) inlined to.
830 All hooks will see this in node's global.inlined_to, when invoked.
831 Can be NULL if the node is not inlined. */
832 cgraph_node *create_clone (tree decl, gcov_type count, int freq,
833 bool update_original,
834 vec<cgraph_edge *> redirect_callers,
835 bool call_duplication_hook,
836 cgraph_node *new_inlined_to,
837 bitmap args_to_skip);
839 /* Create callgraph node clone with new declaration. The actual body will
840 be copied later at compilation stage. */
841 cgraph_node *create_virtual_clone (vec<cgraph_edge *> redirect_callers,
842 vec<ipa_replace_map *, va_gc> *tree_map,
843 bitmap args_to_skip, const char * suffix);
845 /* cgraph node being removed from symbol table; see if its entry can be
846 replaced by other inline clone. */
847 cgraph_node *find_replacement (void);
849 /* Create a new cgraph node which is the new version of
850 callgraph node. REDIRECT_CALLERS holds the callers
851 edges which should be redirected to point to
852 NEW_VERSION. ALL the callees edges of the node
853 are cloned to the new version node. Return the new
854 version node.
856 If non-NULL BLOCK_TO_COPY determine what basic blocks
857 was copied to prevent duplications of calls that are dead
858 in the clone. */
860 cgraph_node *create_version_clone (tree new_decl,
861 vec<cgraph_edge *> redirect_callers,
862 bitmap bbs_to_copy);
864 /* Perform function versioning.
865 Function versioning includes copying of the tree and
866 a callgraph update (creating a new cgraph node and updating
867 its callees and callers).
869 REDIRECT_CALLERS varray includes the edges to be redirected
870 to the new version.
872 TREE_MAP is a mapping of tree nodes we want to replace with
873 new ones (according to results of prior analysis).
875 If non-NULL ARGS_TO_SKIP determine function parameters to remove
876 from new version.
877 If SKIP_RETURN is true, the new version will return void.
878 If non-NULL BLOCK_TO_COPY determine what basic blocks to copy.
879 If non_NULL NEW_ENTRY determine new entry BB of the clone.
881 Return the new version's cgraph node. */
882 cgraph_node *create_version_clone_with_body
883 (vec<cgraph_edge *> redirect_callers,
884 vec<ipa_replace_map *, va_gc> *tree_map, bitmap args_to_skip,
885 bool skip_return, bitmap bbs_to_copy, basic_block new_entry_block,
886 const char *clone_name);
888 /* Insert a new cgraph_function_version_info node into cgraph_fnver_htab
889 corresponding to cgraph_node. */
890 cgraph_function_version_info *insert_new_function_version (void);
892 /* Get the cgraph_function_version_info node corresponding to node. */
893 cgraph_function_version_info *function_version (void);
895 /* Discover all functions and variables that are trivially needed, analyze
896 them as well as all functions and variables referred by them */
897 void analyze (void);
899 /* Add thunk alias into callgraph. The alias declaration is ALIAS and it
900 aliases DECL with an adjustments made into the first parameter.
901 See comments in thunk_adjust for detail on the parameters. */
902 cgraph_node * create_thunk (tree alias, tree, bool this_adjusting,
903 HOST_WIDE_INT fixed_offset,
904 HOST_WIDE_INT virtual_value,
905 tree virtual_offset,
906 tree real_alias);
909 /* Return node that alias is aliasing. */
910 inline cgraph_node *get_alias_target (void);
912 /* Given function symbol, walk the alias chain to return the function node
913 is alias of. Do not walk through thunks.
914 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
916 cgraph_node *ultimate_alias_target (availability *availability = NULL);
918 /* Expand thunk NODE to gimple if possible.
919 When FORCE_GIMPLE_THUNK is true, gimple thunk is created and
920 no assembler is produced.
921 When OUTPUT_ASM_THUNK is true, also produce assembler for
922 thunks that are not lowered. */
923 bool expand_thunk (bool output_asm_thunks, bool force_gimple_thunk);
925 /* Call expand_thunk on all callers that are thunks and analyze those
926 nodes that were expanded. */
927 void expand_all_artificial_thunks ();
929 /* Assemble thunks and aliases associated to node. */
930 void assemble_thunks_and_aliases (void);
932 /* Expand function specified by node. */
933 void expand (void);
935 /* As an GCC extension we allow redefinition of the function. The
936 semantics when both copies of bodies differ is not well defined.
937 We replace the old body with new body so in unit at a time mode
938 we always use new body, while in normal mode we may end up with
939 old body inlined into some functions and new body expanded and
940 inlined in others. */
941 void reset (void);
943 /* Creates a wrapper from cgraph_node to TARGET node. Thunk is used for this
944 kind of wrapper method. */
945 void create_wrapper (cgraph_node *target);
947 /* Verify cgraph nodes of the cgraph node. */
948 void DEBUG_FUNCTION verify_node (void);
950 /* Remove function from symbol table. */
951 void remove (void);
953 /* Dump call graph node to file F. */
954 void dump (FILE *f);
956 /* Dump call graph node to stderr. */
957 void DEBUG_FUNCTION debug (void);
959 /* When doing LTO, read cgraph_node's body from disk if it is not already
960 present. */
961 bool get_untransformed_body (void);
963 /* Prepare function body. When doing LTO, read cgraph_node's body from disk
964 if it is not already present. When some IPA transformations are scheduled,
965 apply them. */
966 bool get_body (void);
968 /* Release memory used to represent body of function.
969 Use this only for functions that are released before being translated to
970 target code (i.e. RTL). Functions that are compiled to RTL and beyond
971 are free'd in final.c via free_after_compilation(). */
972 void release_body (bool keep_arguments = false);
974 /* Return the DECL_STRUCT_FUNCTION of the function. */
975 struct function *get_fun (void);
977 /* cgraph_node is no longer nested function; update cgraph accordingly. */
978 void unnest (void);
980 /* Bring cgraph node local. */
981 void make_local (void);
983 /* Likewise indicate that a node is having address taken. */
984 void mark_address_taken (void);
986 /* Set fialization priority to PRIORITY. */
987 void set_fini_priority (priority_type priority);
989 /* Return the finalization priority. */
990 priority_type get_fini_priority (void);
992 /* Create edge from a given function to CALLEE in the cgraph. */
993 cgraph_edge *create_edge (cgraph_node *callee,
994 gcall *call_stmt, gcov_type count,
995 int freq);
997 /* Create an indirect edge with a yet-undetermined callee where the call
998 statement destination is a formal parameter of the caller with index
999 PARAM_INDEX. */
1000 cgraph_edge *create_indirect_edge (gcall *call_stmt, int ecf_flags,
1001 gcov_type count, int freq,
1002 bool compute_indirect_info = true);
1004 /* Like cgraph_create_edge walk the clone tree and update all clones sharing
1005 same function body. If clones already have edge for OLD_STMT; only
1006 update the edge same way as cgraph_set_call_stmt_including_clones does. */
1007 void create_edge_including_clones (cgraph_node *callee,
1008 gimple old_stmt, gcall *stmt,
1009 gcov_type count,
1010 int freq,
1011 cgraph_inline_failed_t reason);
1013 /* Return the callgraph edge representing the GIMPLE_CALL statement
1014 CALL_STMT. */
1015 cgraph_edge *get_edge (gimple call_stmt);
1017 /* Collect all callers of cgraph_node and its aliases that are known to lead
1018 to NODE (i.e. are not overwritable). */
1019 vec<cgraph_edge *> collect_callers (void);
1021 /* Remove all callers from the node. */
1022 void remove_callers (void);
1024 /* Remove all callees from the node. */
1025 void remove_callees (void);
1027 /* Return function availability. See cgraph.h for description of individual
1028 return values. */
1029 enum availability get_availability (void);
1031 /* Set TREE_NOTHROW on cgraph_node's decl and on aliases of the node
1032 if any to NOTHROW. */
1033 void set_nothrow_flag (bool nothrow);
1035 /* Set TREE_READONLY on cgraph_node's decl and on aliases of the node
1036 if any to READONLY. */
1037 void set_const_flag (bool readonly, bool looping);
1039 /* Set DECL_PURE_P on cgraph_node's decl and on aliases of the node
1040 if any to PURE. */
1041 void set_pure_flag (bool pure, bool looping);
1043 /* Call callback on function and aliases associated to the function.
1044 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1045 skipped. */
1047 bool call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
1048 void *),
1049 void *data, bool include_overwritable);
1051 /* Call callback on cgraph_node, thunks and aliases associated to NODE.
1052 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1053 skipped. When EXCLUDE_VIRTUAL_THUNKS is true, virtual thunks are
1054 skipped. */
1055 bool call_for_symbol_thunks_and_aliases (bool (*callback) (cgraph_node *node,
1056 void *data),
1057 void *data,
1058 bool include_overwritable,
1059 bool exclude_virtual_thunks = false);
1061 /* Likewise indicate that a node is needed, i.e. reachable via some
1062 external means. */
1063 inline void mark_force_output (void);
1065 /* Return true when function can be marked local. */
1066 bool local_p (void);
1068 /* Return true if cgraph_node can be made local for API change.
1069 Extern inline functions and C++ COMDAT functions can be made local
1070 at the expense of possible code size growth if function is used in multiple
1071 compilation units. */
1072 bool can_be_local_p (void);
1074 /* Return true when cgraph_node can not return or throw and thus
1075 it is safe to ignore its side effects for IPA analysis. */
1076 bool cannot_return_p (void);
1078 /* Return true when function cgraph_node and all its aliases are only called
1079 directly.
1080 i.e. it is not externally visible, address was not taken and
1081 it is not used in any other non-standard way. */
1082 bool only_called_directly_p (void);
1084 /* Return true when function is only called directly or it has alias.
1085 i.e. it is not externally visible, address was not taken and
1086 it is not used in any other non-standard way. */
1087 inline bool only_called_directly_or_aliased_p (void);
1089 /* Return true when function cgraph_node can be expected to be removed
1090 from program when direct calls in this compilation unit are removed.
1092 As a special case COMDAT functions are
1093 cgraph_can_remove_if_no_direct_calls_p while the are not
1094 cgraph_only_called_directly_p (it is possible they are called from other
1095 unit)
1097 This function behaves as cgraph_only_called_directly_p because eliminating
1098 all uses of COMDAT function does not make it necessarily disappear from
1099 the program unless we are compiling whole program or we do LTO. In this
1100 case we know we win since dynamic linking will not really discard the
1101 linkonce section. */
1102 bool will_be_removed_from_program_if_no_direct_calls_p (void);
1104 /* Return true when function can be removed from callgraph
1105 if all direct calls are eliminated. */
1106 bool can_remove_if_no_direct_calls_and_refs_p (void);
1108 /* Return true when function cgraph_node and its aliases can be removed from
1109 callgraph if all direct calls are eliminated. */
1110 bool can_remove_if_no_direct_calls_p (void);
1112 /* Return true when callgraph node is a function with Gimple body defined
1113 in current unit. Functions can also be define externally or they
1114 can be thunks with no Gimple representation.
1116 Note that at WPA stage, the function body may not be present in memory. */
1117 inline bool has_gimple_body_p (void);
1119 /* Return true if function should be optimized for size. */
1120 bool optimize_for_size_p (void);
1122 /* Dump the callgraph to file F. */
1123 static void dump_cgraph (FILE *f);
1125 /* Dump the call graph to stderr. */
1126 static inline
1127 void debug_cgraph (void)
1129 dump_cgraph (stderr);
1132 /* Record that DECL1 and DECL2 are semantically identical function
1133 versions. */
1134 static void record_function_versions (tree decl1, tree decl2);
1136 /* Remove the cgraph_function_version_info and cgraph_node for DECL. This
1137 DECL is a duplicate declaration. */
1138 static void delete_function_version (tree decl);
1140 /* Add the function FNDECL to the call graph.
1141 Unlike finalize_function, this function is intended to be used
1142 by middle end and allows insertion of new function at arbitrary point
1143 of compilation. The function can be either in high, low or SSA form
1144 GIMPLE.
1146 The function is assumed to be reachable and have address taken (so no
1147 API breaking optimizations are performed on it).
1149 Main work done by this function is to enqueue the function for later
1150 processing to avoid need the passes to be re-entrant. */
1151 static void add_new_function (tree fndecl, bool lowered);
1153 /* Return callgraph node for given symbol and check it is a function. */
1154 static inline cgraph_node *get (const_tree decl)
1156 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL);
1157 return dyn_cast <cgraph_node *> (symtab_node::get (decl));
1160 /* DECL has been parsed. Take it, queue it, compile it at the whim of the
1161 logic in effect. If NO_COLLECT is true, then our caller cannot stand to
1162 have the garbage collector run at the moment. We would need to either
1163 create a new GC context, or just not compile right now. */
1164 static void finalize_function (tree, bool);
1166 /* Return cgraph node assigned to DECL. Create new one when needed. */
1167 static cgraph_node * create (tree decl);
1169 /* Try to find a call graph node for declaration DECL and if it does not
1170 exist or if it corresponds to an inline clone, create a new one. */
1171 static cgraph_node * get_create (tree);
1173 /* Return local info for the compiled function. */
1174 static cgraph_local_info *local_info (tree decl);
1176 /* Return local info for the compiled function. */
1177 static cgraph_rtl_info *rtl_info (tree);
1179 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
1180 Return NULL if there's no such node. */
1181 static cgraph_node *get_for_asmname (tree asmname);
1183 /* Attempt to mark ALIAS as an alias to DECL. Return alias node if
1184 successful and NULL otherwise.
1185 Same body aliases are output whenever the body of DECL is output,
1186 and cgraph_node::get (ALIAS) transparently
1187 returns cgraph_node::get (DECL). */
1188 static cgraph_node * create_same_body_alias (tree alias, tree decl);
1190 /* Worker for cgraph_can_remove_if_no_direct_calls_p. */
1191 static bool used_from_object_file_p_worker (cgraph_node *node, void *)
1193 return node->used_from_object_file_p ();
1196 /* Verify whole cgraph structure. */
1197 static void DEBUG_FUNCTION verify_cgraph_nodes (void);
1199 /* Worker to bring NODE local. */
1200 static bool make_local (cgraph_node *node, void *);
1202 /* Mark ALIAS as an alias to DECL. DECL_NODE is cgraph node representing
1203 the function body is associated
1204 with (not necessarily cgraph_node (DECL). */
1205 static cgraph_node *create_alias (tree alias, tree target);
1207 cgraph_edge *callees;
1208 cgraph_edge *callers;
1209 /* List of edges representing indirect calls with a yet undetermined
1210 callee. */
1211 cgraph_edge *indirect_calls;
1212 /* For nested functions points to function the node is nested in. */
1213 cgraph_node *origin;
1214 /* Points to first nested function, if any. */
1215 cgraph_node *nested;
1216 /* Pointer to the next function with same origin, if any. */
1217 cgraph_node *next_nested;
1218 /* Pointer to the next clone. */
1219 cgraph_node *next_sibling_clone;
1220 cgraph_node *prev_sibling_clone;
1221 cgraph_node *clones;
1222 cgraph_node *clone_of;
1223 /* If instrumentation_clone is 1 then instrumented_version points
1224 to the original function used to make instrumented version.
1225 Otherwise points to instrumented version of the function. */
1226 cgraph_node *instrumented_version;
1227 /* If instrumentation_clone is 1 then orig_decl is the original
1228 function declaration. */
1229 tree orig_decl;
1230 /* For functions with many calls sites it holds map from call expression
1231 to the edge to speed up cgraph_edge function. */
1232 hash_table<cgraph_edge_hasher> *GTY(()) call_site_hash;
1233 /* Declaration node used to be clone of. */
1234 tree former_clone_of;
1236 /* If this is a SIMD clone, this points to the SIMD specific
1237 information for it. */
1238 cgraph_simd_clone *simdclone;
1239 /* If this function has SIMD clones, this points to the first clone. */
1240 cgraph_node *simd_clones;
1242 /* Interprocedural passes scheduled to have their transform functions
1243 applied next time we execute local pass on them. We maintain it
1244 per-function in order to allow IPA passes to introduce new functions. */
1245 vec<ipa_opt_pass> GTY((skip)) ipa_transforms_to_apply;
1247 cgraph_local_info local;
1248 cgraph_global_info global;
1249 cgraph_rtl_info rtl;
1250 cgraph_clone_info clone;
1251 cgraph_thunk_info thunk;
1253 /* Expected number of executions: calculated in profile.c. */
1254 gcov_type count;
1255 /* How to scale counts at materialization time; used to merge
1256 LTO units with different number of profile runs. */
1257 int count_materialization_scale;
1258 /* Unique id of the node. */
1259 int uid;
1260 /* Summary unique id of the node. */
1261 int summary_uid;
1262 /* ID assigned by the profiling. */
1263 unsigned int profile_id;
1264 /* Time profiler: first run of function. */
1265 int tp_first_run;
1267 /* Set when decl is an abstract function pointed to by the
1268 ABSTRACT_DECL_ORIGIN of a reachable function. */
1269 unsigned used_as_abstract_origin : 1;
1270 /* Set once the function is lowered (i.e. its CFG is built). */
1271 unsigned lowered : 1;
1272 /* Set once the function has been instantiated and its callee
1273 lists created. */
1274 unsigned process : 1;
1275 /* How commonly executed the node is. Initialized during branch
1276 probabilities pass. */
1277 ENUM_BITFIELD (node_frequency) frequency : 2;
1278 /* True when function can only be called at startup (from static ctor). */
1279 unsigned only_called_at_startup : 1;
1280 /* True when function can only be called at startup (from static dtor). */
1281 unsigned only_called_at_exit : 1;
1282 /* True when function is the transactional clone of a function which
1283 is called only from inside transactions. */
1284 /* ?? We should be able to remove this. We have enough bits in
1285 cgraph to calculate it. */
1286 unsigned tm_clone : 1;
1287 /* True if this decl is a dispatcher for function versions. */
1288 unsigned dispatcher_function : 1;
1289 /* True if this decl calls a COMDAT-local function. This is set up in
1290 compute_inline_parameters and inline_call. */
1291 unsigned calls_comdat_local : 1;
1292 /* True if node has been created by merge operation in IPA-ICF. */
1293 unsigned icf_merged: 1;
1294 /* True when function is clone created for Pointer Bounds Checker
1295 instrumentation. */
1296 unsigned instrumentation_clone : 1;
1297 /* True if call to node can't result in a call to free, munmap or
1298 other operation that could make previously non-trapping memory
1299 accesses trapping. */
1300 unsigned nonfreeing_fn : 1;
1301 /* True if there was multiple COMDAT bodies merged by lto-symtab. */
1302 unsigned merged : 1;
1304 private:
1305 /* Worker for call_for_symbol_and_aliases. */
1306 bool call_for_symbol_and_aliases_1 (bool (*callback) (cgraph_node *,
1307 void *),
1308 void *data, bool include_overwritable);
1311 /* A cgraph node set is a collection of cgraph nodes. A cgraph node
1312 can appear in multiple sets. */
1313 struct cgraph_node_set_def
1315 hash_map<cgraph_node *, size_t> *map;
1316 vec<cgraph_node *> nodes;
1319 typedef cgraph_node_set_def *cgraph_node_set;
1320 typedef struct varpool_node_set_def *varpool_node_set;
1322 class varpool_node;
1324 /* A varpool node set is a collection of varpool nodes. A varpool node
1325 can appear in multiple sets. */
1326 struct varpool_node_set_def
1328 hash_map<varpool_node *, size_t> * map;
1329 vec<varpool_node *> nodes;
1332 /* Iterator structure for cgraph node sets. */
1333 struct cgraph_node_set_iterator
1335 cgraph_node_set set;
1336 unsigned index;
1339 /* Iterator structure for varpool node sets. */
1340 struct varpool_node_set_iterator
1342 varpool_node_set set;
1343 unsigned index;
1346 /* Context of polymorphic call. It represent information about the type of
1347 instance that may reach the call. This is used by ipa-devirt walkers of the
1348 type inheritance graph. */
1350 class GTY(()) ipa_polymorphic_call_context {
1351 public:
1352 /* The called object appears in an object of type OUTER_TYPE
1353 at offset OFFSET. When information is not 100% reliable, we
1354 use SPECULATIVE_OUTER_TYPE and SPECULATIVE_OFFSET. */
1355 HOST_WIDE_INT offset;
1356 HOST_WIDE_INT speculative_offset;
1357 tree outer_type;
1358 tree speculative_outer_type;
1359 /* True if outer object may be in construction or destruction. */
1360 unsigned maybe_in_construction : 1;
1361 /* True if outer object may be of derived type. */
1362 unsigned maybe_derived_type : 1;
1363 /* True if speculative outer object may be of derived type. We always
1364 speculate that construction does not happen. */
1365 unsigned speculative_maybe_derived_type : 1;
1366 /* True if the context is invalid and all calls should be redirected
1367 to BUILTIN_UNREACHABLE. */
1368 unsigned invalid : 1;
1369 /* True if the outer type is dynamic. */
1370 unsigned dynamic : 1;
1372 /* Build empty "I know nothing" context. */
1373 ipa_polymorphic_call_context ();
1374 /* Build polymorphic call context for indirect call E. */
1375 ipa_polymorphic_call_context (cgraph_edge *e);
1376 /* Build polymorphic call context for IP invariant CST.
1377 If specified, OTR_TYPE specify the type of polymorphic call
1378 that takes CST+OFFSET as a prameter. */
1379 ipa_polymorphic_call_context (tree cst, tree otr_type = NULL,
1380 HOST_WIDE_INT offset = 0);
1381 /* Build context for pointer REF contained in FNDECL at statement STMT.
1382 if INSTANCE is non-NULL, return pointer to the object described by
1383 the context. */
1384 ipa_polymorphic_call_context (tree fndecl, tree ref, gimple stmt,
1385 tree *instance = NULL);
1387 /* Look for vtable stores or constructor calls to work out dynamic type
1388 of memory location. */
1389 bool get_dynamic_type (tree, tree, tree, gimple);
1391 /* Make context non-speculative. */
1392 void clear_speculation ();
1394 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
1395 NULL, the context is set to dummy "I know nothing" setting. */
1396 void clear_outer_type (tree otr_type = NULL);
1398 /* Walk container types and modify context to point to actual class
1399 containing OTR_TYPE (if non-NULL) as base class.
1400 Return true if resulting context is valid.
1402 When CONSIDER_PLACEMENT_NEW is false, reject contexts that may be made
1403 valid only via alocation of new polymorphic type inside by means
1404 of placement new.
1406 When CONSIDER_BASES is false, only look for actual fields, not base types
1407 of TYPE. */
1408 bool restrict_to_inner_class (tree otr_type,
1409 bool consider_placement_new = true,
1410 bool consider_bases = true);
1412 /* Adjust all offsets in contexts by given number of bits. */
1413 void offset_by (HOST_WIDE_INT);
1414 /* Use when we can not track dynamic type change. This speculatively assume
1415 type change is not happening. */
1416 void possible_dynamic_type_change (bool, tree otr_type = NULL);
1417 /* Assume that both THIS and a given context is valid and strenghten THIS
1418 if possible. Return true if any strenghtening was made.
1419 If actual type the context is being used in is known, OTR_TYPE should be
1420 set accordingly. This improves quality of combined result. */
1421 bool combine_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1422 bool meet_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1424 /* Return TRUE if context is fully useless. */
1425 bool useless_p () const;
1426 /* Return TRUE if this context conveys the same information as X. */
1427 bool equal_to (const ipa_polymorphic_call_context &x) const;
1429 /* Dump human readable context to F. If NEWLINE is true, it will be
1430 terminated by a newline. */
1431 void dump (FILE *f, bool newline = true) const;
1432 void DEBUG_FUNCTION debug () const;
1434 /* LTO streaming. */
1435 void stream_out (struct output_block *) const;
1436 void stream_in (struct lto_input_block *, struct data_in *data_in);
1438 private:
1439 bool combine_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1440 bool meet_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1441 void set_by_decl (tree, HOST_WIDE_INT);
1442 bool set_by_invariant (tree, tree, HOST_WIDE_INT);
1443 bool speculation_consistent_p (tree, HOST_WIDE_INT, bool, tree) const;
1444 void make_speculative (tree otr_type = NULL);
1447 /* Structure containing additional information about an indirect call. */
1449 struct GTY(()) cgraph_indirect_call_info
1451 /* When agg_content is set, an offset where the call pointer is located
1452 within the aggregate. */
1453 HOST_WIDE_INT offset;
1454 /* Context of the polymorphic call; use only when POLYMORPHIC flag is set. */
1455 ipa_polymorphic_call_context context;
1456 /* OBJ_TYPE_REF_TOKEN of a polymorphic call (if polymorphic is set). */
1457 HOST_WIDE_INT otr_token;
1458 /* Type of the object from OBJ_TYPE_REF_OBJECT. */
1459 tree otr_type;
1460 /* Index of the parameter that is called. */
1461 int param_index;
1462 /* ECF flags determined from the caller. */
1463 int ecf_flags;
1464 /* Profile_id of common target obtrained from profile. */
1465 int common_target_id;
1466 /* Probability that call will land in function with COMMON_TARGET_ID. */
1467 int common_target_probability;
1469 /* Set when the call is a virtual call with the parameter being the
1470 associated object pointer rather than a simple direct call. */
1471 unsigned polymorphic : 1;
1472 /* Set when the call is a call of a pointer loaded from contents of an
1473 aggregate at offset. */
1474 unsigned agg_contents : 1;
1475 /* Set when this is a call through a member pointer. */
1476 unsigned member_ptr : 1;
1477 /* When the previous bit is set, this one determines whether the destination
1478 is loaded from a parameter passed by reference. */
1479 unsigned by_ref : 1;
1480 /* For polymorphic calls this specify whether the virtual table pointer
1481 may have changed in between function entry and the call. */
1482 unsigned vptr_changed : 1;
1485 struct GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller"),
1486 for_user)) cgraph_edge {
1487 friend class cgraph_node;
1489 /* Remove the edge in the cgraph. */
1490 void remove (void);
1492 /* Change field call_stmt of edge to NEW_STMT.
1493 If UPDATE_SPECULATIVE and E is any component of speculative
1494 edge, then update all components. */
1495 void set_call_stmt (gcall *new_stmt, bool update_speculative = true);
1497 /* Redirect callee of the edge to N. The function does not update underlying
1498 call expression. */
1499 void redirect_callee (cgraph_node *n);
1501 /* If the edge does not lead to a thunk, simply redirect it to N. Otherwise
1502 create one or more equivalent thunks for N and redirect E to the first in
1503 the chain. Note that it is then necessary to call
1504 n->expand_all_artificial_thunks once all callers are redirected. */
1505 void redirect_callee_duplicating_thunks (cgraph_node *n);
1507 /* Make an indirect edge with an unknown callee an ordinary edge leading to
1508 CALLEE. DELTA is an integer constant that is to be added to the this
1509 pointer (first parameter) to compensate for skipping
1510 a thunk adjustment. */
1511 cgraph_edge *make_direct (cgraph_node *callee);
1513 /* Turn edge into speculative call calling N2. Update
1514 the profile so the direct call is taken COUNT times
1515 with FREQUENCY. */
1516 cgraph_edge *make_speculative (cgraph_node *n2, gcov_type direct_count,
1517 int direct_frequency);
1519 /* Given speculative call edge, return all three components. */
1520 void speculative_call_info (cgraph_edge *&direct, cgraph_edge *&indirect,
1521 ipa_ref *&reference);
1523 /* Speculative call edge turned out to be direct call to CALLE_DECL.
1524 Remove the speculative call sequence and return edge representing the call.
1525 It is up to caller to redirect the call as appropriate. */
1526 cgraph_edge *resolve_speculation (tree callee_decl = NULL);
1528 /* If necessary, change the function declaration in the call statement
1529 associated with the edge so that it corresponds to the edge callee. */
1530 gimple redirect_call_stmt_to_callee (void);
1532 /* Create clone of edge in the node N represented
1533 by CALL_EXPR the callgraph. */
1534 cgraph_edge * clone (cgraph_node *n, gcall *call_stmt, unsigned stmt_uid,
1535 gcov_type count_scale, int freq_scale, bool update_original);
1537 /* Verify edge count and frequency. */
1538 bool verify_count_and_frequency ();
1540 /* Return true when call of edge can not lead to return from caller
1541 and thus it is safe to ignore its side effects for IPA analysis
1542 when computing side effects of the caller. */
1543 bool cannot_lead_to_return_p (void);
1545 /* Return true when the edge represents a direct recursion. */
1546 bool recursive_p (void);
1548 /* Return true if the call can be hot. */
1549 bool maybe_hot_p (void);
1551 /* Rebuild cgraph edges for current function node. This needs to be run after
1552 passes that don't update the cgraph. */
1553 static unsigned int rebuild_edges (void);
1555 /* Rebuild cgraph references for current function node. This needs to be run
1556 after passes that don't update the cgraph. */
1557 static void rebuild_references (void);
1559 /* Expected number of executions: calculated in profile.c. */
1560 gcov_type count;
1561 cgraph_node *caller;
1562 cgraph_node *callee;
1563 cgraph_edge *prev_caller;
1564 cgraph_edge *next_caller;
1565 cgraph_edge *prev_callee;
1566 cgraph_edge *next_callee;
1567 gcall *call_stmt;
1568 /* Additional information about an indirect call. Not cleared when an edge
1569 becomes direct. */
1570 cgraph_indirect_call_info *indirect_info;
1571 PTR GTY ((skip (""))) aux;
1572 /* When equal to CIF_OK, inline this call. Otherwise, points to the
1573 explanation why function was not inlined. */
1574 enum cgraph_inline_failed_t inline_failed;
1575 /* The stmt_uid of call_stmt. This is used by LTO to recover the call_stmt
1576 when the function is serialized in. */
1577 unsigned int lto_stmt_uid;
1578 /* Expected frequency of executions within the function.
1579 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
1580 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
1581 int frequency;
1582 /* Unique id of the edge. */
1583 int uid;
1584 /* Whether this edge was made direct by indirect inlining. */
1585 unsigned int indirect_inlining_edge : 1;
1586 /* Whether this edge describes an indirect call with an undetermined
1587 callee. */
1588 unsigned int indirect_unknown_callee : 1;
1589 /* Whether this edge is still a dangling */
1590 /* True if the corresponding CALL stmt cannot be inlined. */
1591 unsigned int call_stmt_cannot_inline_p : 1;
1592 /* Can this call throw externally? */
1593 unsigned int can_throw_external : 1;
1594 /* Edges with SPECULATIVE flag represents indirect calls that was
1595 speculatively turned into direct (i.e. by profile feedback).
1596 The final code sequence will have form:
1598 if (call_target == expected_fn)
1599 expected_fn ();
1600 else
1601 call_target ();
1603 Every speculative call is represented by three components attached
1604 to a same call statement:
1605 1) a direct call (to expected_fn)
1606 2) an indirect call (to call_target)
1607 3) a IPA_REF_ADDR refrence to expected_fn.
1609 Optimizers may later redirect direct call to clone, so 1) and 3)
1610 do not need to necesarily agree with destination. */
1611 unsigned int speculative : 1;
1612 /* Set to true when caller is a constructor or destructor of polymorphic
1613 type. */
1614 unsigned in_polymorphic_cdtor : 1;
1616 private:
1617 /* Remove the edge from the list of the callers of the callee. */
1618 void remove_caller (void);
1620 /* Remove the edge from the list of the callees of the caller. */
1621 void remove_callee (void);
1623 /* Set callee N of call graph edge and add it to the corresponding set of
1624 callers. */
1625 void set_callee (cgraph_node *n);
1627 /* Output flags of edge to a file F. */
1628 void dump_edge_flags (FILE *f);
1630 /* Verify that call graph edge corresponds to DECL from the associated
1631 statement. Return true if the verification should fail. */
1632 bool verify_corresponds_to_fndecl (tree decl);
1635 #define CGRAPH_FREQ_BASE 1000
1636 #define CGRAPH_FREQ_MAX 100000
1638 /* The varpool data structure.
1639 Each static variable decl has assigned varpool_node. */
1641 class GTY((tag ("SYMTAB_VARIABLE"))) varpool_node : public symtab_node {
1642 public:
1643 /* Dump given varpool node to F. */
1644 void dump (FILE *f);
1646 /* Dump given varpool node to stderr. */
1647 void DEBUG_FUNCTION debug (void);
1649 /* Remove variable from symbol table. */
1650 void remove (void);
1652 /* Remove node initializer when it is no longer needed. */
1653 void remove_initializer (void);
1655 void analyze (void);
1657 /* Return variable availability. */
1658 availability get_availability (void);
1660 /* When doing LTO, read variable's constructor from disk if
1661 it is not already present. */
1662 tree get_constructor (void);
1664 /* Return true if variable has constructor that can be used for folding. */
1665 bool ctor_useable_for_folding_p (void);
1667 /* For given variable pool node, walk the alias chain to return the function
1668 the variable is alias of. Do not walk through thunks.
1669 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
1670 inline varpool_node *ultimate_alias_target
1671 (availability *availability = NULL);
1673 /* Return node that alias is aliasing. */
1674 inline varpool_node *get_alias_target (void);
1676 /* Output one variable, if necessary. Return whether we output it. */
1677 bool assemble_decl (void);
1679 /* For variables in named sections make sure get_variable_section
1680 is called before we switch to those sections. Then section
1681 conflicts between read-only and read-only requiring relocations
1682 sections can be resolved. */
1683 void finalize_named_section_flags (void);
1685 /* Call calback on varpool symbol and aliases associated to varpool symbol.
1686 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1687 skipped. */
1688 bool call_for_symbol_and_aliases (bool (*callback) (varpool_node *, void *),
1689 void *data,
1690 bool include_overwritable);
1692 /* Return true when variable should be considered externally visible. */
1693 bool externally_visible_p (void);
1695 /* Return true when all references to variable must be visible
1696 in ipa_ref_list.
1697 i.e. if the variable is not externally visible or not used in some magic
1698 way (asm statement or such).
1699 The magic uses are all summarized in force_output flag. */
1700 inline bool all_refs_explicit_p ();
1702 /* Return true when variable can be removed from variable pool
1703 if all direct calls are eliminated. */
1704 inline bool can_remove_if_no_refs_p (void);
1706 /* Add the variable DECL to the varpool.
1707 Unlike finalize_decl function is intended to be used
1708 by middle end and allows insertion of new variable at arbitrary point
1709 of compilation. */
1710 static void add (tree decl);
1712 /* Return varpool node for given symbol and check it is a function. */
1713 static inline varpool_node *get (const_tree decl);
1715 /* Mark DECL as finalized. By finalizing the declaration, frontend instruct
1716 the middle end to output the variable to asm file, if needed or externally
1717 visible. */
1718 static void finalize_decl (tree decl);
1720 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1721 Extra name aliases are output whenever DECL is output. */
1722 static varpool_node * create_extra_name_alias (tree alias, tree decl);
1724 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1725 Extra name aliases are output whenever DECL is output. */
1726 static varpool_node * create_alias (tree, tree);
1728 /* Dump the variable pool to F. */
1729 static void dump_varpool (FILE *f);
1731 /* Dump the variable pool to stderr. */
1732 static void DEBUG_FUNCTION debug_varpool (void);
1734 /* Allocate new callgraph node and insert it into basic data structures. */
1735 static varpool_node *create_empty (void);
1737 /* Return varpool node assigned to DECL. Create new one when needed. */
1738 static varpool_node *get_create (tree decl);
1740 /* Given an assembler name, lookup node. */
1741 static varpool_node *get_for_asmname (tree asmname);
1743 /* Set when variable is scheduled to be assembled. */
1744 unsigned output : 1;
1746 /* Set when variable has statically initialized pointer
1747 or is a static bounds variable and needs initalization. */
1748 unsigned need_bounds_init : 1;
1750 /* Set if the variable is dynamically initialized, except for
1751 function local statics. */
1752 unsigned dynamically_initialized : 1;
1754 ENUM_BITFIELD(tls_model) tls_model : 3;
1756 /* Set if the variable is known to be used by single function only.
1757 This is computed by ipa_signle_use pass and used by late optimizations
1758 in places where optimization would be valid for local static variable
1759 if we did not do any inter-procedural code movement. */
1760 unsigned used_by_single_function : 1;
1762 private:
1763 /* Assemble thunks and aliases associated to varpool node. */
1764 void assemble_aliases (void);
1766 /* Worker for call_for_node_and_aliases. */
1767 bool call_for_symbol_and_aliases_1 (bool (*callback) (varpool_node *, void *),
1768 void *data,
1769 bool include_overwritable);
1772 /* Every top level asm statement is put into a asm_node. */
1774 struct GTY(()) asm_node {
1777 /* Next asm node. */
1778 asm_node *next;
1779 /* String for this asm node. */
1780 tree asm_str;
1781 /* Ordering of all cgraph nodes. */
1782 int order;
1785 /* Report whether or not THIS symtab node is a function, aka cgraph_node. */
1787 template <>
1788 template <>
1789 inline bool
1790 is_a_helper <cgraph_node *>::test (symtab_node *p)
1792 return p && p->type == SYMTAB_FUNCTION;
1795 /* Report whether or not THIS symtab node is a vriable, aka varpool_node. */
1797 template <>
1798 template <>
1799 inline bool
1800 is_a_helper <varpool_node *>::test (symtab_node *p)
1802 return p && p->type == SYMTAB_VARIABLE;
1805 /* Macros to access the next item in the list of free cgraph nodes and
1806 edges. */
1807 #define NEXT_FREE_NODE(NODE) dyn_cast<cgraph_node *> ((NODE)->next)
1808 #define SET_NEXT_FREE_NODE(NODE,NODE2) ((NODE))->next = NODE2
1809 #define NEXT_FREE_EDGE(EDGE) (EDGE)->prev_caller
1811 typedef void (*cgraph_edge_hook)(cgraph_edge *, void *);
1812 typedef void (*cgraph_node_hook)(cgraph_node *, void *);
1813 typedef void (*varpool_node_hook)(varpool_node *, void *);
1814 typedef void (*cgraph_2edge_hook)(cgraph_edge *, cgraph_edge *, void *);
1815 typedef void (*cgraph_2node_hook)(cgraph_node *, cgraph_node *, void *);
1817 struct cgraph_edge_hook_list;
1818 struct cgraph_node_hook_list;
1819 struct varpool_node_hook_list;
1820 struct cgraph_2edge_hook_list;
1821 struct cgraph_2node_hook_list;
1823 /* Map from a symbol to initialization/finalization priorities. */
1824 struct GTY(()) symbol_priority_map {
1825 priority_type init;
1826 priority_type fini;
1829 enum symtab_state
1831 /* Frontend is parsing and finalizing functions. */
1832 PARSING,
1833 /* Callgraph is being constructed. It is safe to add new functions. */
1834 CONSTRUCTION,
1835 /* Callgraph is being streamed-in at LTO time. */
1836 LTO_STREAMING,
1837 /* Callgraph is built and early IPA passes are being run. */
1838 IPA,
1839 /* Callgraph is built and all functions are transformed to SSA form. */
1840 IPA_SSA,
1841 /* All inline decisions are done; it is now possible to remove extern inline
1842 functions and virtual call targets. */
1843 IPA_SSA_AFTER_INLINING,
1844 /* Functions are now ordered and being passed to RTL expanders. */
1845 EXPANSION,
1846 /* All cgraph expansion is done. */
1847 FINISHED
1850 struct asmname_hasher
1852 typedef symtab_node *value_type;
1853 typedef const_tree compare_type;
1854 typedef int store_values_directly;
1856 static hashval_t hash (symtab_node *n);
1857 static bool equal (symtab_node *n, const_tree t);
1858 static void ggc_mx (symtab_node *n);
1859 static void pch_nx (symtab_node *&);
1860 static void pch_nx (symtab_node *&, gt_pointer_operator, void *);
1861 static void remove (symtab_node *) {}
1864 class GTY((tag ("SYMTAB"))) symbol_table
1866 public:
1867 friend class symtab_node;
1868 friend class cgraph_node;
1869 friend class cgraph_edge;
1871 symbol_table (): cgraph_max_summary_uid (1)
1875 /* Initialize callgraph dump file. */
1876 void initialize (void);
1878 /* Register a top-level asm statement ASM_STR. */
1879 inline asm_node *finalize_toplevel_asm (tree asm_str);
1881 /* Analyze the whole compilation unit once it is parsed completely. */
1882 void finalize_compilation_unit (void);
1884 /* C++ frontend produce same body aliases all over the place, even before PCH
1885 gets streamed out. It relies on us linking the aliases with their function
1886 in order to do the fixups, but ipa-ref is not PCH safe. Consequentely we
1887 first produce aliases without links, but once C++ FE is sure he won't sream
1888 PCH we build the links via this function. */
1889 void process_same_body_aliases (void);
1891 /* Perform simple optimizations based on callgraph. */
1892 void compile (void);
1894 /* Process CGRAPH_NEW_FUNCTIONS and perform actions necessary to add these
1895 functions into callgraph in a way so they look like ordinary reachable
1896 functions inserted into callgraph already at construction time. */
1897 void process_new_functions (void);
1899 /* Once all functions from compilation unit are in memory, produce all clones
1900 and update all calls. We might also do this on demand if we don't want to
1901 bring all functions to memory prior compilation, but current WHOPR
1902 implementation does that and it is is bit easier to keep everything right
1903 in this order. */
1904 void materialize_all_clones (void);
1906 /* Register a symbol NODE. */
1907 inline void register_symbol (symtab_node *node);
1909 inline void
1910 clear_asm_symbols (void)
1912 asmnodes = NULL;
1913 asm_last_node = NULL;
1916 /* Perform reachability analysis and reclaim all unreachable nodes. */
1917 bool remove_unreachable_nodes (FILE *file);
1919 /* Optimization of function bodies might've rendered some variables as
1920 unnecessary so we want to avoid these from being compiled. Re-do
1921 reachability starting from variables that are either externally visible
1922 or was referred from the asm output routines. */
1923 void remove_unreferenced_decls (void);
1925 /* Unregister a symbol NODE. */
1926 inline void unregister (symtab_node *node);
1928 /* Allocate new callgraph node and insert it into basic data structures. */
1929 cgraph_node *create_empty (void);
1931 /* Release a callgraph NODE with UID and put in to the list
1932 of free nodes. */
1933 void release_symbol (cgraph_node *node, int uid);
1935 /* Output all variables enqueued to be assembled. */
1936 bool output_variables (void);
1938 /* Weakrefs may be associated to external decls and thus not output
1939 at expansion time. Emit all necessary aliases. */
1940 void output_weakrefs (void);
1942 /* Return first static symbol with definition. */
1943 inline symtab_node *first_symbol (void);
1945 /* Return first assembler symbol. */
1946 inline asm_node *
1947 first_asm_symbol (void)
1949 return asmnodes;
1952 /* Return first static symbol with definition. */
1953 inline symtab_node *first_defined_symbol (void);
1955 /* Return first variable. */
1956 inline varpool_node *first_variable (void);
1958 /* Return next variable after NODE. */
1959 inline varpool_node *next_variable (varpool_node *node);
1961 /* Return first static variable with initializer. */
1962 inline varpool_node *first_static_initializer (void);
1964 /* Return next static variable with initializer after NODE. */
1965 inline varpool_node *next_static_initializer (varpool_node *node);
1967 /* Return first static variable with definition. */
1968 inline varpool_node *first_defined_variable (void);
1970 /* Return next static variable with definition after NODE. */
1971 inline varpool_node *next_defined_variable (varpool_node *node);
1973 /* Return first function with body defined. */
1974 inline cgraph_node *first_defined_function (void);
1976 /* Return next function with body defined after NODE. */
1977 inline cgraph_node *next_defined_function (cgraph_node *node);
1979 /* Return first function. */
1980 inline cgraph_node *first_function (void);
1982 /* Return next function. */
1983 inline cgraph_node *next_function (cgraph_node *node);
1985 /* Return first function with body defined. */
1986 cgraph_node *first_function_with_gimple_body (void);
1988 /* Return next reachable static variable with initializer after NODE. */
1989 inline cgraph_node *next_function_with_gimple_body (cgraph_node *node);
1991 /* Register HOOK to be called with DATA on each removed edge. */
1992 cgraph_edge_hook_list *add_edge_removal_hook (cgraph_edge_hook hook,
1993 void *data);
1995 /* Remove ENTRY from the list of hooks called on removing edges. */
1996 void remove_edge_removal_hook (cgraph_edge_hook_list *entry);
1998 /* Register HOOK to be called with DATA on each removed node. */
1999 cgraph_node_hook_list *add_cgraph_removal_hook (cgraph_node_hook hook,
2000 void *data);
2002 /* Remove ENTRY from the list of hooks called on removing nodes. */
2003 void remove_cgraph_removal_hook (cgraph_node_hook_list *entry);
2005 /* Register HOOK to be called with DATA on each removed node. */
2006 varpool_node_hook_list *add_varpool_removal_hook (varpool_node_hook hook,
2007 void *data);
2009 /* Remove ENTRY from the list of hooks called on removing nodes. */
2010 void remove_varpool_removal_hook (varpool_node_hook_list *entry);
2012 /* Register HOOK to be called with DATA on each inserted node. */
2013 cgraph_node_hook_list *add_cgraph_insertion_hook (cgraph_node_hook hook,
2014 void *data);
2016 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2017 void remove_cgraph_insertion_hook (cgraph_node_hook_list *entry);
2019 /* Register HOOK to be called with DATA on each inserted node. */
2020 varpool_node_hook_list *add_varpool_insertion_hook (varpool_node_hook hook,
2021 void *data);
2023 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2024 void remove_varpool_insertion_hook (varpool_node_hook_list *entry);
2026 /* Register HOOK to be called with DATA on each duplicated edge. */
2027 cgraph_2edge_hook_list *add_edge_duplication_hook (cgraph_2edge_hook hook,
2028 void *data);
2029 /* Remove ENTRY from the list of hooks called on duplicating edges. */
2030 void remove_edge_duplication_hook (cgraph_2edge_hook_list *entry);
2032 /* Register HOOK to be called with DATA on each duplicated node. */
2033 cgraph_2node_hook_list *add_cgraph_duplication_hook (cgraph_2node_hook hook,
2034 void *data);
2036 /* Remove ENTRY from the list of hooks called on duplicating nodes. */
2037 void remove_cgraph_duplication_hook (cgraph_2node_hook_list *entry);
2039 /* Call all edge removal hooks. */
2040 void call_edge_removal_hooks (cgraph_edge *e);
2042 /* Call all node insertion hooks. */
2043 void call_cgraph_insertion_hooks (cgraph_node *node);
2045 /* Call all node removal hooks. */
2046 void call_cgraph_removal_hooks (cgraph_node *node);
2048 /* Call all node duplication hooks. */
2049 void call_cgraph_duplication_hooks (cgraph_node *node, cgraph_node *node2);
2051 /* Call all edge duplication hooks. */
2052 void call_edge_duplication_hooks (cgraph_edge *cs1, cgraph_edge *cs2);
2054 /* Call all node removal hooks. */
2055 void call_varpool_removal_hooks (varpool_node *node);
2057 /* Call all node insertion hooks. */
2058 void call_varpool_insertion_hooks (varpool_node *node);
2060 /* Arrange node to be first in its entry of assembler_name_hash. */
2061 void symtab_prevail_in_asm_name_hash (symtab_node *node);
2063 /* Initalize asm name hash unless. */
2064 void symtab_initialize_asm_name_hash (void);
2066 /* Set the DECL_ASSEMBLER_NAME and update symtab hashtables. */
2067 void change_decl_assembler_name (tree decl, tree name);
2069 int cgraph_count;
2070 int cgraph_max_uid;
2071 int cgraph_max_summary_uid;
2073 int edges_count;
2074 int edges_max_uid;
2076 symtab_node* GTY(()) nodes;
2077 asm_node* GTY(()) asmnodes;
2078 asm_node* GTY(()) asm_last_node;
2079 cgraph_node* GTY(()) free_nodes;
2081 /* Head of a linked list of unused (freed) call graph edges.
2082 Do not GTY((delete)) this list so UIDs gets reliably recycled. */
2083 cgraph_edge * GTY(()) free_edges;
2085 /* The order index of the next symtab node to be created. This is
2086 used so that we can sort the cgraph nodes in order by when we saw
2087 them, to support -fno-toplevel-reorder. */
2088 int order;
2090 /* Set when whole unit has been analyzed so we can access global info. */
2091 bool global_info_ready;
2092 /* What state callgraph is in right now. */
2093 enum symtab_state state;
2094 /* Set when the cgraph is fully build and the basic flags are computed. */
2095 bool function_flags_ready;
2097 bool cpp_implicit_aliases_done;
2099 /* Hash table used to hold sectoons. */
2100 hash_table<section_name_hasher> *GTY(()) section_hash;
2102 /* Hash table used to convert assembler names into nodes. */
2103 hash_table<asmname_hasher> *assembler_name_hash;
2105 /* Hash table used to hold init priorities. */
2106 hash_map<symtab_node *, symbol_priority_map> *init_priority_hash;
2108 FILE* GTY ((skip)) dump_file;
2110 private:
2111 /* Allocate new callgraph node. */
2112 inline cgraph_node * allocate_cgraph_symbol (void);
2114 /* Allocate a cgraph_edge structure and fill it with data according to the
2115 parameters of which only CALLEE can be NULL (when creating an indirect call
2116 edge). */
2117 cgraph_edge *create_edge (cgraph_node *caller, cgraph_node *callee,
2118 gcall *call_stmt, gcov_type count, int freq,
2119 bool indir_unknown_callee);
2121 /* Put the edge onto the free list. */
2122 void free_edge (cgraph_edge *e);
2124 /* Insert NODE to assembler name hash. */
2125 void insert_to_assembler_name_hash (symtab_node *node, bool with_clones);
2127 /* Remove NODE from assembler name hash. */
2128 void unlink_from_assembler_name_hash (symtab_node *node, bool with_clones);
2130 /* Hash asmnames ignoring the user specified marks. */
2131 static hashval_t decl_assembler_name_hash (const_tree asmname);
2133 /* Compare ASMNAME with the DECL_ASSEMBLER_NAME of DECL. */
2134 static bool decl_assembler_name_equal (tree decl, const_tree asmname);
2136 friend struct asmname_hasher;
2138 /* List of hooks triggered when an edge is removed. */
2139 cgraph_edge_hook_list * GTY((skip)) m_first_edge_removal_hook;
2140 /* List of hooks triggem_red when a cgraph node is removed. */
2141 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_removal_hook;
2142 /* List of hooks triggered when an edge is duplicated. */
2143 cgraph_2edge_hook_list * GTY((skip)) m_first_edge_duplicated_hook;
2144 /* List of hooks triggered when a node is duplicated. */
2145 cgraph_2node_hook_list * GTY((skip)) m_first_cgraph_duplicated_hook;
2146 /* List of hooks triggered when an function is inserted. */
2147 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_insertion_hook;
2148 /* List of hooks triggered when an variable is inserted. */
2149 varpool_node_hook_list * GTY((skip)) m_first_varpool_insertion_hook;
2150 /* List of hooks triggered when a node is removed. */
2151 varpool_node_hook_list * GTY((skip)) m_first_varpool_removal_hook;
2154 extern GTY(()) symbol_table *symtab;
2156 extern vec<cgraph_node *> cgraph_new_nodes;
2158 inline hashval_t
2159 asmname_hasher::hash (symtab_node *n)
2161 return symbol_table::decl_assembler_name_hash
2162 (DECL_ASSEMBLER_NAME (n->decl));
2165 inline bool
2166 asmname_hasher::equal (symtab_node *n, const_tree t)
2168 return symbol_table::decl_assembler_name_equal (n->decl, t);
2171 extern void gt_ggc_mx (symtab_node *&);
2173 inline void
2174 asmname_hasher::ggc_mx (symtab_node *n)
2176 gt_ggc_mx (n);
2179 extern void gt_pch_nx (symtab_node *&);
2181 inline void
2182 asmname_hasher::pch_nx (symtab_node *&n)
2184 gt_pch_nx (n);
2187 inline void
2188 asmname_hasher::pch_nx (symtab_node *&n, gt_pointer_operator op, void *cookie)
2190 op (&n, cookie);
2193 /* In cgraph.c */
2194 void cgraph_c_finalize (void);
2195 void release_function_body (tree);
2196 cgraph_indirect_call_info *cgraph_allocate_init_indirect_info (void);
2198 void cgraph_update_edges_for_call_stmt (gimple, tree, gimple);
2199 bool cgraph_function_possibly_inlined_p (tree);
2201 const char* cgraph_inline_failed_string (cgraph_inline_failed_t);
2202 cgraph_inline_failed_type_t cgraph_inline_failed_type (cgraph_inline_failed_t);
2204 extern bool gimple_check_call_matching_types (gimple, tree, bool);
2206 /* In cgraphunit.c */
2207 void cgraphunit_c_finalize (void);
2209 /* Initialize datastructures so DECL is a function in lowered gimple form.
2210 IN_SSA is true if the gimple is in SSA. */
2211 basic_block init_lowered_empty_function (tree, bool, gcov_type);
2213 /* In cgraphclones.c */
2215 tree clone_function_name_1 (const char *, const char *);
2216 tree clone_function_name (tree decl, const char *);
2218 void tree_function_versioning (tree, tree, vec<ipa_replace_map *, va_gc> *,
2219 bool, bitmap, bool, bitmap, basic_block);
2221 /* In cgraphbuild.c */
2222 int compute_call_stmt_bb_frequency (tree, basic_block bb);
2223 void record_references_in_initializer (tree, bool);
2225 /* In ipa.c */
2226 void cgraph_build_static_cdtor (char which, tree body, int priority);
2227 bool ipa_discover_readonly_nonaddressable_vars (void);
2229 /* In varpool.c */
2230 tree ctor_for_folding (tree);
2232 /* In tree-chkp.c */
2233 extern bool chkp_function_instrumented_p (tree fndecl);
2235 /* Return true when the symbol is real symbol, i.e. it is not inline clone
2236 or abstract function kept for debug info purposes only. */
2237 inline bool
2238 symtab_node::real_symbol_p (void)
2240 cgraph_node *cnode;
2242 if (DECL_ABSTRACT_P (decl))
2243 return false;
2244 if (!is_a <cgraph_node *> (this))
2245 return true;
2246 cnode = dyn_cast <cgraph_node *> (this);
2247 if (cnode->global.inlined_to)
2248 return false;
2249 return true;
2252 /* Return true if DECL should have entry in symbol table if used.
2253 Those are functions and static & external veriables*/
2255 static inline bool
2256 decl_in_symtab_p (const_tree decl)
2258 return (TREE_CODE (decl) == FUNCTION_DECL
2259 || (TREE_CODE (decl) == VAR_DECL
2260 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl))));
2263 inline bool
2264 symtab_node::in_same_comdat_group_p (symtab_node *target)
2266 symtab_node *source = this;
2268 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2270 if (cn->global.inlined_to)
2271 source = cn->global.inlined_to;
2273 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2275 if (cn->global.inlined_to)
2276 target = cn->global.inlined_to;
2279 return source->get_comdat_group () == target->get_comdat_group ();
2282 /* Return node that alias is aliasing. */
2284 inline symtab_node *
2285 symtab_node::get_alias_target (void)
2287 ipa_ref *ref = NULL;
2288 iterate_reference (0, ref);
2289 if (ref->use == IPA_REF_CHKP)
2290 iterate_reference (1, ref);
2291 gcc_checking_assert (ref->use == IPA_REF_ALIAS);
2292 return ref->referred;
2295 /* Return next reachable static symbol with initializer after the node. */
2297 inline symtab_node *
2298 symtab_node::next_defined_symbol (void)
2300 symtab_node *node1 = next;
2302 for (; node1; node1 = node1->next)
2303 if (node1->definition)
2304 return node1;
2306 return NULL;
2309 /* Iterates I-th reference in the list, REF is also set. */
2311 inline ipa_ref *
2312 symtab_node::iterate_reference (unsigned i, ipa_ref *&ref)
2314 vec_safe_iterate (ref_list.references, i, &ref);
2316 return ref;
2319 /* Iterates I-th referring item in the list, REF is also set. */
2321 inline ipa_ref *
2322 symtab_node::iterate_referring (unsigned i, ipa_ref *&ref)
2324 ref_list.referring.iterate (i, &ref);
2326 return ref;
2329 /* Iterates I-th referring alias item in the list, REF is also set. */
2331 inline ipa_ref *
2332 symtab_node::iterate_direct_aliases (unsigned i, ipa_ref *&ref)
2334 ref_list.referring.iterate (i, &ref);
2336 if (ref && ref->use != IPA_REF_ALIAS)
2337 return NULL;
2339 return ref;
2342 /* Return true if list contains an alias. */
2344 inline bool
2345 symtab_node::has_aliases_p (void)
2347 ipa_ref *ref = NULL;
2349 return (iterate_direct_aliases (0, ref) != NULL);
2352 /* Return true when RESOLUTION indicate that linker will use
2353 the symbol from non-LTO object files. */
2355 inline bool
2356 resolution_used_from_other_file_p (enum ld_plugin_symbol_resolution resolution)
2358 return (resolution == LDPR_PREVAILING_DEF
2359 || resolution == LDPR_PREEMPTED_REG
2360 || resolution == LDPR_RESOLVED_EXEC
2361 || resolution == LDPR_RESOLVED_DYN);
2364 /* Return true when symtab_node is known to be used from other (non-LTO)
2365 object file. Known only when doing LTO via linker plugin. */
2367 inline bool
2368 symtab_node::used_from_object_file_p (void)
2370 if (!TREE_PUBLIC (decl) || DECL_EXTERNAL (decl))
2371 return false;
2372 if (resolution_used_from_other_file_p (resolution))
2373 return true;
2374 return false;
2377 /* Return varpool node for given symbol and check it is a function. */
2379 inline varpool_node *
2380 varpool_node::get (const_tree decl)
2382 gcc_checking_assert (TREE_CODE (decl) == VAR_DECL);
2383 return dyn_cast<varpool_node *> (symtab_node::get (decl));
2386 /* Register a symbol NODE. */
2388 inline void
2389 symbol_table::register_symbol (symtab_node *node)
2391 node->next = nodes;
2392 node->previous = NULL;
2394 if (nodes)
2395 nodes->previous = node;
2396 nodes = node;
2398 node->order = order++;
2401 /* Register a top-level asm statement ASM_STR. */
2403 asm_node *
2404 symbol_table::finalize_toplevel_asm (tree asm_str)
2406 asm_node *node;
2408 node = ggc_cleared_alloc<asm_node> ();
2409 node->asm_str = asm_str;
2410 node->order = order++;
2411 node->next = NULL;
2413 if (asmnodes == NULL)
2414 asmnodes = node;
2415 else
2416 asm_last_node->next = node;
2418 asm_last_node = node;
2419 return node;
2422 /* Unregister a symbol NODE. */
2423 inline void
2424 symbol_table::unregister (symtab_node *node)
2426 if (node->previous)
2427 node->previous->next = node->next;
2428 else
2429 nodes = node->next;
2431 if (node->next)
2432 node->next->previous = node->previous;
2434 node->next = NULL;
2435 node->previous = NULL;
2438 /* Release a callgraph NODE with UID and put in to the list of free nodes. */
2440 inline void
2441 symbol_table::release_symbol (cgraph_node *node, int uid)
2443 cgraph_count--;
2445 /* Clear out the node to NULL all pointers and add the node to the free
2446 list. */
2447 memset (node, 0, sizeof (*node));
2448 node->type = SYMTAB_FUNCTION;
2449 node->uid = uid;
2450 SET_NEXT_FREE_NODE (node, free_nodes);
2451 free_nodes = node;
2454 /* Allocate new callgraph node. */
2456 inline cgraph_node *
2457 symbol_table::allocate_cgraph_symbol (void)
2459 cgraph_node *node;
2461 if (free_nodes)
2463 node = free_nodes;
2464 free_nodes = NEXT_FREE_NODE (node);
2466 else
2468 node = ggc_cleared_alloc<cgraph_node> ();
2469 node->uid = cgraph_max_uid++;
2472 node->summary_uid = cgraph_max_summary_uid++;
2473 return node;
2477 /* Return first static symbol with definition. */
2478 inline symtab_node *
2479 symbol_table::first_symbol (void)
2481 return nodes;
2484 /* Walk all symbols. */
2485 #define FOR_EACH_SYMBOL(node) \
2486 for ((node) = symtab->first_symbol (); (node); (node) = (node)->next)
2488 /* Return first static symbol with definition. */
2489 inline symtab_node *
2490 symbol_table::first_defined_symbol (void)
2492 symtab_node *node;
2494 for (node = nodes; node; node = node->next)
2495 if (node->definition)
2496 return node;
2498 return NULL;
2501 /* Walk all symbols with definitions in current unit. */
2502 #define FOR_EACH_DEFINED_SYMBOL(node) \
2503 for ((node) = symtab->first_defined_symbol (); (node); \
2504 (node) = node->next_defined_symbol ())
2506 /* Return first variable. */
2507 inline varpool_node *
2508 symbol_table::first_variable (void)
2510 symtab_node *node;
2511 for (node = nodes; node; node = node->next)
2512 if (varpool_node *vnode = dyn_cast <varpool_node *> (node))
2513 return vnode;
2514 return NULL;
2517 /* Return next variable after NODE. */
2518 inline varpool_node *
2519 symbol_table::next_variable (varpool_node *node)
2521 symtab_node *node1 = node->next;
2522 for (; node1; node1 = node1->next)
2523 if (varpool_node *vnode1 = dyn_cast <varpool_node *> (node1))
2524 return vnode1;
2525 return NULL;
2527 /* Walk all variables. */
2528 #define FOR_EACH_VARIABLE(node) \
2529 for ((node) = symtab->first_variable (); \
2530 (node); \
2531 (node) = symtab->next_variable ((node)))
2533 /* Return first static variable with initializer. */
2534 inline varpool_node *
2535 symbol_table::first_static_initializer (void)
2537 symtab_node *node;
2538 for (node = nodes; node; node = node->next)
2540 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2541 if (vnode && DECL_INITIAL (node->decl))
2542 return vnode;
2544 return NULL;
2547 /* Return next static variable with initializer after NODE. */
2548 inline varpool_node *
2549 symbol_table::next_static_initializer (varpool_node *node)
2551 symtab_node *node1 = node->next;
2552 for (; node1; node1 = node1->next)
2554 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2555 if (vnode1 && DECL_INITIAL (node1->decl))
2556 return vnode1;
2558 return NULL;
2561 /* Walk all static variables with initializer set. */
2562 #define FOR_EACH_STATIC_INITIALIZER(node) \
2563 for ((node) = symtab->first_static_initializer (); (node); \
2564 (node) = symtab->next_static_initializer (node))
2566 /* Return first static variable with definition. */
2567 inline varpool_node *
2568 symbol_table::first_defined_variable (void)
2570 symtab_node *node;
2571 for (node = nodes; node; node = node->next)
2573 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2574 if (vnode && vnode->definition)
2575 return vnode;
2577 return NULL;
2580 /* Return next static variable with definition after NODE. */
2581 inline varpool_node *
2582 symbol_table::next_defined_variable (varpool_node *node)
2584 symtab_node *node1 = node->next;
2585 for (; node1; node1 = node1->next)
2587 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2588 if (vnode1 && vnode1->definition)
2589 return vnode1;
2591 return NULL;
2593 /* Walk all variables with definitions in current unit. */
2594 #define FOR_EACH_DEFINED_VARIABLE(node) \
2595 for ((node) = symtab->first_defined_variable (); (node); \
2596 (node) = symtab->next_defined_variable (node))
2598 /* Return first function with body defined. */
2599 inline cgraph_node *
2600 symbol_table::first_defined_function (void)
2602 symtab_node *node;
2603 for (node = nodes; node; node = node->next)
2605 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2606 if (cn && cn->definition)
2607 return cn;
2609 return NULL;
2612 /* Return next function with body defined after NODE. */
2613 inline cgraph_node *
2614 symbol_table::next_defined_function (cgraph_node *node)
2616 symtab_node *node1 = node->next;
2617 for (; node1; node1 = node1->next)
2619 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2620 if (cn1 && cn1->definition)
2621 return cn1;
2623 return NULL;
2626 /* Walk all functions with body defined. */
2627 #define FOR_EACH_DEFINED_FUNCTION(node) \
2628 for ((node) = symtab->first_defined_function (); (node); \
2629 (node) = symtab->next_defined_function ((node)))
2631 /* Return first function. */
2632 inline cgraph_node *
2633 symbol_table::first_function (void)
2635 symtab_node *node;
2636 for (node = nodes; node; node = node->next)
2637 if (cgraph_node *cn = dyn_cast <cgraph_node *> (node))
2638 return cn;
2639 return NULL;
2642 /* Return next function. */
2643 inline cgraph_node *
2644 symbol_table::next_function (cgraph_node *node)
2646 symtab_node *node1 = node->next;
2647 for (; node1; node1 = node1->next)
2648 if (cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1))
2649 return cn1;
2650 return NULL;
2653 /* Return first function with body defined. */
2654 inline cgraph_node *
2655 symbol_table::first_function_with_gimple_body (void)
2657 symtab_node *node;
2658 for (node = nodes; node; node = node->next)
2660 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2661 if (cn && cn->has_gimple_body_p ())
2662 return cn;
2664 return NULL;
2667 /* Return next reachable static variable with initializer after NODE. */
2668 inline cgraph_node *
2669 symbol_table::next_function_with_gimple_body (cgraph_node *node)
2671 symtab_node *node1 = node->next;
2672 for (; node1; node1 = node1->next)
2674 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2675 if (cn1 && cn1->has_gimple_body_p ())
2676 return cn1;
2678 return NULL;
2681 /* Walk all functions. */
2682 #define FOR_EACH_FUNCTION(node) \
2683 for ((node) = symtab->first_function (); (node); \
2684 (node) = symtab->next_function ((node)))
2686 /* Return true when callgraph node is a function with Gimple body defined
2687 in current unit. Functions can also be define externally or they
2688 can be thunks with no Gimple representation.
2690 Note that at WPA stage, the function body may not be present in memory. */
2692 inline bool
2693 cgraph_node::has_gimple_body_p (void)
2695 return definition && !thunk.thunk_p && !alias;
2698 /* Walk all functions with body defined. */
2699 #define FOR_EACH_FUNCTION_WITH_GIMPLE_BODY(node) \
2700 for ((node) = symtab->first_function_with_gimple_body (); (node); \
2701 (node) = symtab->next_function_with_gimple_body (node))
2703 /* Create a new static variable of type TYPE. */
2704 tree add_new_static_var (tree type);
2706 /* Uniquize all constants that appear in memory.
2707 Each constant in memory thus far output is recorded
2708 in `const_desc_table'. */
2710 struct GTY((for_user)) constant_descriptor_tree {
2711 /* A MEM for the constant. */
2712 rtx rtl;
2714 /* The value of the constant. */
2715 tree value;
2717 /* Hash of value. Computing the hash from value each time
2718 hashfn is called can't work properly, as that means recursive
2719 use of the hash table during hash table expansion. */
2720 hashval_t hash;
2723 /* Return true when function is only called directly or it has alias.
2724 i.e. it is not externally visible, address was not taken and
2725 it is not used in any other non-standard way. */
2727 inline bool
2728 cgraph_node::only_called_directly_or_aliased_p (void)
2730 gcc_assert (!global.inlined_to);
2731 return (!force_output && !address_taken
2732 && !used_from_other_partition
2733 && !DECL_VIRTUAL_P (decl)
2734 && !DECL_STATIC_CONSTRUCTOR (decl)
2735 && !DECL_STATIC_DESTRUCTOR (decl)
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 /* Return true when variable can be removed from variable pool
2771 if all direct calls are eliminated. */
2773 inline bool
2774 varpool_node::can_remove_if_no_refs_p (void)
2776 if (DECL_EXTERNAL (decl))
2777 return true;
2778 return (!force_output && !used_from_other_partition
2779 && ((DECL_COMDAT (decl)
2780 && !forced_by_abi
2781 && !used_from_object_file_p ())
2782 || !externally_visible
2783 || DECL_HAS_VALUE_EXPR_P (decl)));
2786 /* Return true when all references to variable must be visible in ipa_ref_list.
2787 i.e. if the variable is not externally visible or not used in some magic
2788 way (asm statement or such).
2789 The magic uses are all summarized in force_output flag. */
2791 inline bool
2792 varpool_node::all_refs_explicit_p ()
2794 return (definition
2795 && !externally_visible
2796 && !used_from_other_partition
2797 && !force_output);
2800 struct tree_descriptor_hasher : ggc_hasher<constant_descriptor_tree *>
2802 static hashval_t hash (constant_descriptor_tree *);
2803 static bool equal (constant_descriptor_tree *, constant_descriptor_tree *);
2806 /* Constant pool accessor function. */
2807 hash_table<tree_descriptor_hasher> *constant_pool_htab (void);
2809 /* Return node that alias is aliasing. */
2811 inline cgraph_node *
2812 cgraph_node::get_alias_target (void)
2814 return dyn_cast <cgraph_node *> (symtab_node::get_alias_target ());
2817 /* Return node that alias is aliasing. */
2819 inline varpool_node *
2820 varpool_node::get_alias_target (void)
2822 return dyn_cast <varpool_node *> (symtab_node::get_alias_target ());
2825 /* Walk the alias chain to return the symbol NODE is alias of.
2826 If NODE is not an alias, return NODE.
2827 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2829 inline symtab_node *
2830 symtab_node::ultimate_alias_target (enum availability *availability)
2832 if (!alias)
2834 if (availability)
2835 *availability = get_availability ();
2836 return this;
2839 return ultimate_alias_target_1 (availability);
2842 /* Given function symbol, walk the alias chain to return the function node
2843 is alias of. Do not walk through thunks.
2844 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2846 inline cgraph_node *
2847 cgraph_node::ultimate_alias_target (enum availability *availability)
2849 cgraph_node *n = dyn_cast <cgraph_node *>
2850 (symtab_node::ultimate_alias_target (availability));
2851 if (!n && availability)
2852 *availability = AVAIL_NOT_AVAILABLE;
2853 return n;
2856 /* For given variable pool node, walk the alias chain to return the function
2857 the variable is alias of. Do not walk through thunks.
2858 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2860 inline varpool_node *
2861 varpool_node::ultimate_alias_target (availability *availability)
2863 varpool_node *n = dyn_cast <varpool_node *>
2864 (symtab_node::ultimate_alias_target (availability));
2866 if (!n && availability)
2867 *availability = AVAIL_NOT_AVAILABLE;
2868 return n;
2871 /* Set callee N of call graph edge and add it to the corresponding set of
2872 callers. */
2874 inline void
2875 cgraph_edge::set_callee (cgraph_node *n)
2877 prev_caller = NULL;
2878 if (n->callers)
2879 n->callers->prev_caller = this;
2880 next_caller = n->callers;
2881 n->callers = this;
2882 callee = n;
2885 /* Redirect callee of the edge to N. The function does not update underlying
2886 call expression. */
2888 inline void
2889 cgraph_edge::redirect_callee (cgraph_node *n)
2891 /* Remove from callers list of the current callee. */
2892 remove_callee ();
2894 /* Insert to callers list of the new callee. */
2895 set_callee (n);
2898 /* Return true when the edge represents a direct recursion. */
2900 inline bool
2901 cgraph_edge::recursive_p (void)
2903 cgraph_node *c = callee->ultimate_alias_target ();
2904 if (caller->global.inlined_to)
2905 return caller->global.inlined_to->decl == c->decl;
2906 else
2907 return caller->decl == c->decl;
2910 /* Remove the edge from the list of the callers of the callee. */
2912 inline void
2913 cgraph_edge::remove_callee (void)
2915 gcc_assert (!indirect_unknown_callee);
2916 if (prev_caller)
2917 prev_caller->next_caller = next_caller;
2918 if (next_caller)
2919 next_caller->prev_caller = prev_caller;
2920 if (!prev_caller)
2921 callee->callers = next_caller;
2924 /* Return true if the TM_CLONE bit is set for a given FNDECL. */
2925 static inline bool
2926 decl_is_tm_clone (const_tree fndecl)
2928 cgraph_node *n = cgraph_node::get (fndecl);
2929 if (n)
2930 return n->tm_clone;
2931 return false;
2934 /* Likewise indicate that a node is needed, i.e. reachable via some
2935 external means. */
2937 inline void
2938 cgraph_node::mark_force_output (void)
2940 force_output = 1;
2941 gcc_checking_assert (!global.inlined_to);
2944 /* Return true if function should be optimized for size. */
2946 inline bool
2947 cgraph_node::optimize_for_size_p (void)
2949 if (opt_for_fn (decl, optimize_size))
2950 return true;
2951 if (frequency == NODE_FREQUENCY_UNLIKELY_EXECUTED)
2952 return true;
2953 else
2954 return false;
2957 /* Return symtab_node for NODE or create one if it is not present
2958 in symtab. */
2960 inline symtab_node *
2961 symtab_node::get_create (tree node)
2963 if (TREE_CODE (node) == VAR_DECL)
2964 return varpool_node::get_create (node);
2965 else
2966 return cgraph_node::get_create (node);
2969 /* Return availability of NODE. */
2971 inline enum availability
2972 symtab_node::get_availability (void)
2974 if (is_a <cgraph_node *> (this))
2975 return dyn_cast <cgraph_node *> (this)->get_availability ();
2976 else
2977 return dyn_cast <varpool_node *> (this)->get_availability ();;
2980 /* Call calback on symtab node and aliases associated to this node.
2981 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
2982 skipped. */
2984 inline bool
2985 symtab_node::call_for_symbol_and_aliases (bool (*callback) (symtab_node *,
2986 void *),
2987 void *data,
2988 bool include_overwritable)
2990 if (callback (this, data))
2991 return true;
2992 if (has_aliases_p ())
2993 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
2994 return false;
2997 /* Call callback on function and aliases associated to the function.
2998 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
2999 skipped. */
3001 inline bool
3002 cgraph_node::call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
3003 void *),
3004 void *data,
3005 bool include_overwritable)
3007 if (callback (this, data))
3008 return true;
3009 if (has_aliases_p ())
3010 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3011 return false;
3014 /* Call calback on varpool symbol and aliases associated to varpool symbol.
3015 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
3016 skipped. */
3018 inline bool
3019 varpool_node::call_for_symbol_and_aliases (bool (*callback) (varpool_node *,
3020 void *),
3021 void *data,
3022 bool include_overwritable)
3024 if (callback (this, data))
3025 return true;
3026 if (has_aliases_p ())
3027 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3028 return false;
3031 /* Return true if NODE's address can be compared. */
3033 inline bool
3034 symtab_node::address_can_be_compared_p ()
3036 /* Address of virtual tables and functions is never compared. */
3037 if (DECL_VIRTUAL_P (decl))
3038 return false;
3039 /* Address of C++ cdtors is never compared. */
3040 if (is_a <cgraph_node *> (this)
3041 && (DECL_CXX_CONSTRUCTOR_P (decl)
3042 || DECL_CXX_DESTRUCTOR_P (decl)))
3043 return false;
3044 /* Constant pool symbols addresses are never compared.
3045 flag_merge_constants permits us to assume the same on readonly vars. */
3046 if (is_a <varpool_node *> (this)
3047 && (DECL_IN_CONSTANT_POOL (decl)
3048 || (flag_merge_constants >= 2
3049 && TREE_READONLY (decl) && !TREE_THIS_VOLATILE (decl))))
3050 return false;
3051 return true;
3054 /* Return true if refernece may be used in address compare. */
3056 inline bool
3057 ipa_ref::address_matters_p ()
3059 if (use != IPA_REF_ADDR)
3060 return false;
3061 /* Addresses taken from virtual tables are never compared. */
3062 if (is_a <varpool_node *> (referring)
3063 && DECL_VIRTUAL_P (referring->decl))
3064 return false;
3065 return referred->address_can_be_compared_p ();
3068 /* Build polymorphic call context for indirect call E. */
3070 inline
3071 ipa_polymorphic_call_context::ipa_polymorphic_call_context (cgraph_edge *e)
3073 gcc_checking_assert (e->indirect_info->polymorphic);
3074 *this = e->indirect_info->context;
3077 /* Build empty "I know nothing" context. */
3079 inline
3080 ipa_polymorphic_call_context::ipa_polymorphic_call_context ()
3082 clear_speculation ();
3083 clear_outer_type ();
3084 invalid = false;
3087 /* Make context non-speculative. */
3089 inline void
3090 ipa_polymorphic_call_context::clear_speculation ()
3092 speculative_outer_type = NULL;
3093 speculative_offset = 0;
3094 speculative_maybe_derived_type = false;
3097 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
3098 NULL, the context is set to dummy "I know nothing" setting. */
3100 inline void
3101 ipa_polymorphic_call_context::clear_outer_type (tree otr_type)
3103 outer_type = otr_type ? TYPE_MAIN_VARIANT (otr_type) : NULL;
3104 offset = 0;
3105 maybe_derived_type = true;
3106 maybe_in_construction = true;
3107 dynamic = true;
3110 /* Adjust all offsets in contexts by OFF bits. */
3112 inline void
3113 ipa_polymorphic_call_context::offset_by (HOST_WIDE_INT off)
3115 if (outer_type)
3116 offset += off;
3117 if (speculative_outer_type)
3118 speculative_offset += off;
3121 /* Return TRUE if context is fully useless. */
3123 inline bool
3124 ipa_polymorphic_call_context::useless_p () const
3126 return (!outer_type && !speculative_outer_type);
3129 /* Return true if NODE is local. Instrumentation clones are counted as local
3130 only when original function is local. */
3132 static inline bool
3133 cgraph_local_p (cgraph_node *node)
3135 if (!node->instrumentation_clone || !node->instrumented_version)
3136 return node->local.local;
3138 return node->local.local && node->instrumented_version->local.local;
3141 /* When using fprintf (or similar), problems can arise with
3142 transient generated strings. Many string-generation APIs
3143 only support one result being alive at once (e.g. by
3144 returning a pointer to a statically-allocated buffer).
3146 If there is more than one generated string within one
3147 fprintf call: the first string gets evicted or overwritten
3148 by the second, before fprintf is fully evaluated.
3149 See e.g. PR/53136.
3151 This function provides a workaround for this, by providing
3152 a simple way to create copies of these transient strings,
3153 without the need to have explicit cleanup:
3155 fprintf (dumpfile, "string 1: %s string 2:%s\n",
3156 xstrdup_for_dump (EXPR_1),
3157 xstrdup_for_dump (EXPR_2));
3159 This is actually a simple wrapper around ggc_strdup, but
3160 the name documents the intent. We require that no GC can occur
3161 within the fprintf call. */
3163 static inline const char *
3164 xstrdup_for_dump (const char *transient_str)
3166 return ggc_strdup (transient_str);
3169 #endif /* GCC_CGRAPH_H */