Daily bump.
[official-gcc.git] / gcc / cgraph.h
blob6607b1127c27411cfc793f759e15ba774a91ec87
1 /* Callgraph handling code.
2 Copyright (C) 2003-2015 Free Software Foundation, Inc.
3 Contributed by Jan Hubicka
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
10 version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
21 #ifndef GCC_CGRAPH_H
22 #define GCC_CGRAPH_H
24 #include "ipa-ref.h"
25 #include "plugin-api.h"
27 class ipa_opt_pass_d;
28 typedef ipa_opt_pass_d *ipa_opt_pass;
30 /* Symbol table consists of functions and variables.
31 TODO: add labels and CONST_DECLs. */
32 enum symtab_type
34 SYMTAB_SYMBOL,
35 SYMTAB_FUNCTION,
36 SYMTAB_VARIABLE
39 /* Section names are stored as reference counted strings in GGC safe hashtable
40 (to make them survive through PCH). */
42 struct GTY((for_user)) section_hash_entry
44 int ref_count;
45 char *name; /* As long as this datastructure stays in GGC, we can not put
46 string at the tail of structure of GGC dies in horrible
47 way */
50 struct section_name_hasher : ggc_ptr_hash<section_hash_entry>
52 typedef const char *compare_type;
54 static hashval_t hash (section_hash_entry *);
55 static bool equal (section_hash_entry *, const char *);
58 enum availability
60 /* Not yet set by cgraph_function_body_availability. */
61 AVAIL_UNSET,
62 /* Function body/variable initializer is unknown. */
63 AVAIL_NOT_AVAILABLE,
64 /* Function body/variable initializer is known but might be replaced
65 by a different one from other compilation unit and thus needs to
66 be dealt with a care. Like AVAIL_NOT_AVAILABLE it can have
67 arbitrary side effects on escaping variables and functions, while
68 like AVAILABLE it might access static variables. */
69 AVAIL_INTERPOSABLE,
70 /* Function body/variable initializer is known and will be used in final
71 program. */
72 AVAIL_AVAILABLE,
73 /* Function body/variable initializer is known and all it's uses are
74 explicitly visible within current unit (ie it's address is never taken and
75 it is not exported to other units). Currently used only for functions. */
76 AVAIL_LOCAL
79 /* Classification of symbols WRT partitioning. */
80 enum symbol_partitioning_class
82 /* External declarations are ignored by partitioning algorithms and they are
83 added into the boundary later via compute_ltrans_boundary. */
84 SYMBOL_EXTERNAL,
85 /* Partitioned symbols are pur into one of partitions. */
86 SYMBOL_PARTITION,
87 /* Duplicated symbols (such as comdat or constant pool references) are
88 copied into every node needing them via add_symbol_to_partition. */
89 SYMBOL_DUPLICATE
92 /* Base of all entries in the symbol table.
93 The symtab_node is inherited by cgraph and varpol nodes. */
94 class GTY((desc ("%h.type"), tag ("SYMTAB_SYMBOL"),
95 chain_next ("%h.next"), chain_prev ("%h.previous")))
96 symtab_node
98 public:
99 /* Return name. */
100 const char *name () const;
102 /* Return asm name. */
103 const char * asm_name () const;
105 /* Add node into symbol table. This function is not used directly, but via
106 cgraph/varpool node creation routines. */
107 void register_symbol (void);
109 /* Remove symbol from symbol table. */
110 void remove (void);
112 /* Dump symtab node to F. */
113 void dump (FILE *f);
115 /* Dump symtab node to stderr. */
116 void DEBUG_FUNCTION debug (void);
118 /* Verify consistency of node. */
119 void DEBUG_FUNCTION verify (void);
121 /* Return ipa reference from this symtab_node to
122 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
123 of the use and STMT the statement (if it exists). */
124 ipa_ref *create_reference (symtab_node *referred_node,
125 enum ipa_ref_use use_type);
127 /* Return ipa reference from this symtab_node to
128 REFERED_NODE or REFERED_VARPOOL_NODE. USE_TYPE specify type
129 of the use and STMT the statement (if it exists). */
130 ipa_ref *create_reference (symtab_node *referred_node,
131 enum ipa_ref_use use_type, gimple stmt);
133 /* If VAL is a reference to a function or a variable, add a reference from
134 this symtab_node to the corresponding symbol table node. USE_TYPE specify
135 type of the use and STMT the statement (if it exists). Return the new
136 reference or NULL if none was created. */
137 ipa_ref *maybe_create_reference (tree val, enum ipa_ref_use use_type,
138 gimple stmt);
140 /* Clone all references from symtab NODE to this symtab_node. */
141 void clone_references (symtab_node *node);
143 /* Remove all stmt references in non-speculative references.
144 Those are not maintained during inlining & clonning.
145 The exception are speculative references that are updated along
146 with callgraph edges associated with them. */
147 void clone_referring (symtab_node *node);
149 /* Clone reference REF to this symtab_node and set its stmt to STMT. */
150 ipa_ref *clone_reference (ipa_ref *ref, gimple stmt);
152 /* Find the structure describing a reference to REFERRED_NODE
153 and associated with statement STMT. */
154 ipa_ref *find_reference (symtab_node *referred_node, gimple stmt,
155 unsigned int lto_stmt_uid);
157 /* Remove all references that are associated with statement STMT. */
158 void remove_stmt_references (gimple stmt);
160 /* Remove all stmt references in non-speculative references.
161 Those are not maintained during inlining & clonning.
162 The exception are speculative references that are updated along
163 with callgraph edges associated with them. */
164 void clear_stmts_in_references (void);
166 /* Remove all references in ref list. */
167 void remove_all_references (void);
169 /* Remove all referring items in ref list. */
170 void remove_all_referring (void);
172 /* Dump references in ref list to FILE. */
173 void dump_references (FILE *file);
175 /* Dump referring in list to FILE. */
176 void dump_referring (FILE *);
178 /* Get number of references for this node. */
179 inline unsigned num_references (void)
181 return ref_list.references ? ref_list.references->length () : 0;
184 /* Iterates I-th reference in the list, REF is also set. */
185 ipa_ref *iterate_reference (unsigned i, ipa_ref *&ref);
187 /* Iterates I-th referring item in the list, REF is also set. */
188 ipa_ref *iterate_referring (unsigned i, ipa_ref *&ref);
190 /* Iterates I-th referring alias item in the list, REF is also set. */
191 ipa_ref *iterate_direct_aliases (unsigned i, ipa_ref *&ref);
193 /* Return true if symtab node and TARGET represents
194 semantically equivalent symbols. */
195 bool semantically_equivalent_p (symtab_node *target);
197 /* Classify symbol symtab node for partitioning. */
198 enum symbol_partitioning_class get_partitioning_class (void);
200 /* Return comdat group. */
201 tree get_comdat_group ()
203 return x_comdat_group;
206 /* Return comdat group as identifier_node. */
207 tree get_comdat_group_id ()
209 if (x_comdat_group && TREE_CODE (x_comdat_group) != IDENTIFIER_NODE)
210 x_comdat_group = DECL_ASSEMBLER_NAME (x_comdat_group);
211 return x_comdat_group;
214 /* Set comdat group. */
215 void set_comdat_group (tree group)
217 gcc_checking_assert (!group || TREE_CODE (group) == IDENTIFIER_NODE
218 || DECL_P (group));
219 x_comdat_group = group;
222 /* Return section as string. */
223 const char * get_section ()
225 if (!x_section)
226 return NULL;
227 return x_section->name;
230 /* Remove node from same comdat group. */
231 void remove_from_same_comdat_group (void);
233 /* Add this symtab_node to the same comdat group that OLD is in. */
234 void add_to_same_comdat_group (symtab_node *old_node);
236 /* Dissolve the same_comdat_group list in which NODE resides. */
237 void dissolve_same_comdat_group_list (void);
239 /* Return true when symtab_node is known to be used from other (non-LTO)
240 object file. Known only when doing LTO via linker plugin. */
241 bool used_from_object_file_p (void);
243 /* Walk the alias chain to return the symbol NODE is alias of.
244 If NODE is not an alias, return NODE.
245 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
246 symtab_node *ultimate_alias_target (enum availability *avail = NULL);
248 /* Return next reachable static symbol with initializer after NODE. */
249 inline symtab_node *next_defined_symbol (void);
251 /* Add reference recording that symtab node is alias of TARGET.
252 The function can fail in the case of aliasing cycles; in this case
253 it returns false. */
254 bool resolve_alias (symtab_node *target);
256 /* C++ FE sometimes change linkage flags after producing same
257 body aliases. */
258 void fixup_same_cpp_alias_visibility (symtab_node *target);
260 /* Call callback on symtab node and aliases associated to this node.
261 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
262 skipped. */
263 bool call_for_symbol_and_aliases (bool (*callback) (symtab_node *, void *),
264 void *data,
265 bool include_overwrite);
267 /* If node can not be interposable by static or dynamic linker to point to
268 different definition, return this symbol. Otherwise look for alias with
269 such property and if none exists, introduce new one. */
270 symtab_node *noninterposable_alias (void);
272 /* Return node that alias is aliasing. */
273 inline symtab_node *get_alias_target (void);
275 /* Set section for symbol and its aliases. */
276 void set_section (const char *section);
278 /* Set section, do not recurse into aliases.
279 When one wants to change section of symbol and its aliases,
280 use set_section. */
281 void set_section_for_node (const char *section);
283 /* Set initialization priority to PRIORITY. */
284 void set_init_priority (priority_type priority);
286 /* Return the initialization priority. */
287 priority_type get_init_priority ();
289 /* Return availability of NODE. */
290 enum availability get_availability (void);
292 /* Make DECL local. */
293 void make_decl_local (void);
295 /* Return desired alignment of the definition. This is NOT alignment useful
296 to access THIS, because THIS may be interposable and DECL_ALIGN should
297 be used instead. It however must be guaranteed when output definition
298 of THIS. */
299 unsigned int definition_alignment ();
301 /* Return true if alignment can be increased. */
302 bool can_increase_alignment_p ();
304 /* Increase alignment of symbol to ALIGN. */
305 void increase_alignment (unsigned int align);
307 /* Return true if list contains an alias. */
308 bool has_aliases_p (void);
310 /* Return true when the symbol is real symbol, i.e. it is not inline clone
311 or abstract function kept for debug info purposes only. */
312 bool real_symbol_p (void);
314 /* Determine if symbol declaration is needed. That is, visible to something
315 either outside this translation unit, something magic in the system
316 configury. This function is used just during symbol creation. */
317 bool needed_p (void);
319 /* Return true when there are references to the node. */
320 bool referred_to_p (bool include_self = true);
322 /* Return true if NODE can be discarded by linker from the binary. */
323 inline bool
324 can_be_discarded_p (void)
326 return (DECL_EXTERNAL (decl)
327 || (get_comdat_group ()
328 && resolution != LDPR_PREVAILING_DEF
329 && resolution != LDPR_PREVAILING_DEF_IRONLY
330 && resolution != LDPR_PREVAILING_DEF_IRONLY_EXP));
333 /* Return true if NODE is local to a particular COMDAT group, and must not
334 be named from outside the COMDAT. This is used for C++ decloned
335 constructors. */
336 inline bool comdat_local_p (void)
338 return (same_comdat_group && !TREE_PUBLIC (decl));
341 /* Return true if ONE and TWO are part of the same COMDAT group. */
342 inline bool in_same_comdat_group_p (symtab_node *target);
344 /* Return true if symbol is known to be nonzero. */
345 bool nonzero_address ();
347 /* Return 0 if symbol is known to have different address than S2,
348 Return 1 if symbol is known to have same address as S2,
349 return 2 otherwise. */
350 int equal_address_to (symtab_node *s2);
352 /* Return true if symbol's address may possibly be compared to other
353 symbol's address. */
354 bool address_matters_p ();
356 /* Return true if NODE's address can be compared. This use properties
357 of NODE only and does not look if the address is actually taken in
358 interesting way. For that use ADDRESS_MATTERS_P instead. */
359 bool address_can_be_compared_p (void);
361 /* Return symbol table node associated with DECL, if any,
362 and NULL otherwise. */
363 static inline symtab_node *get (const_tree decl)
365 #ifdef ENABLE_CHECKING
366 /* Check that we are called for sane type of object - functions
367 and static or external variables. */
368 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL
369 || (TREE_CODE (decl) == VAR_DECL
370 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl)
371 || in_lto_p)));
372 /* Check that the mapping is sane - perhaps this check can go away,
373 but at the moment frontends tends to corrupt the mapping by calling
374 memcpy/memset on the tree nodes. */
375 gcc_checking_assert (!decl->decl_with_vis.symtab_node
376 || decl->decl_with_vis.symtab_node->decl == decl);
377 #endif
378 return decl->decl_with_vis.symtab_node;
381 /* Try to find a symtab node for declaration DECL and if it does not
382 exist or if it corresponds to an inline clone, create a new one. */
383 static inline symtab_node * get_create (tree node);
385 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
386 Return NULL if there's no such node. */
387 static symtab_node *get_for_asmname (const_tree asmname);
389 /* Dump symbol table to F. */
390 static void dump_table (FILE *);
392 /* Dump symbol table to stderr. */
393 static inline DEBUG_FUNCTION void debug_symtab (void)
395 dump_table (stderr);
398 /* Verify symbol table for internal consistency. */
399 static DEBUG_FUNCTION void verify_symtab_nodes (void);
401 /* Type of the symbol. */
402 ENUM_BITFIELD (symtab_type) type : 8;
404 /* The symbols resolution. */
405 ENUM_BITFIELD (ld_plugin_symbol_resolution) resolution : 8;
407 /*** Flags representing the symbol type. ***/
409 /* True when symbol corresponds to a definition in current unit.
410 set via finalize_function or finalize_decl */
411 unsigned definition : 1;
412 /* True when symbol is an alias.
413 Set by ssemble_alias. */
414 unsigned alias : 1;
415 /* True when alias is a weakref. */
416 unsigned weakref : 1;
417 /* C++ frontend produce same body aliases and extra name aliases for
418 virtual functions and vtables that are obviously equivalent.
419 Those aliases are bit special, especially because C++ frontend
420 visibility code is so ugly it can not get them right at first time
421 and their visibility needs to be copied from their "masters" at
422 the end of parsing. */
423 unsigned cpp_implicit_alias : 1;
424 /* Set once the definition was analyzed. The list of references and
425 other properties are built during analysis. */
426 unsigned analyzed : 1;
427 /* Set for write-only variables. */
428 unsigned writeonly : 1;
429 /* Visibility of symbol was used for further optimization; do not
430 permit further changes. */
431 unsigned refuse_visibility_changes : 1;
433 /*** Visibility and linkage flags. ***/
435 /* Set when function is visible by other units. */
436 unsigned externally_visible : 1;
437 /* Don't reorder to other symbols having this set. */
438 unsigned no_reorder : 1;
439 /* The symbol will be assumed to be used in an invisible way (like
440 by an toplevel asm statement). */
441 unsigned force_output : 1;
442 /* Like FORCE_OUTPUT, but in the case it is ABI requiring the symbol to be
443 exported. Unlike FORCE_OUTPUT this flag gets cleared to symbols promoted
444 to static and it does not inhibit optimization. */
445 unsigned forced_by_abi : 1;
446 /* True when the name is known to be unique and thus it does not need mangling. */
447 unsigned unique_name : 1;
448 /* Specify whether the section was set by user or by
449 compiler via -ffunction-sections. */
450 unsigned implicit_section : 1;
451 /* True when body and other characteristics have been removed by
452 symtab_remove_unreachable_nodes. */
453 unsigned body_removed : 1;
455 /*** WHOPR Partitioning flags.
456 These flags are used at ltrans stage when only part of the callgraph is
457 available. ***/
459 /* Set when variable is used from other LTRANS partition. */
460 unsigned used_from_other_partition : 1;
461 /* Set when function is available in the other LTRANS partition.
462 During WPA output it is used to mark nodes that are present in
463 multiple partitions. */
464 unsigned in_other_partition : 1;
468 /*** other flags. ***/
470 /* Set when symbol has address taken. */
471 unsigned address_taken : 1;
472 /* Set when init priority is set. */
473 unsigned in_init_priority_hash : 1;
475 /* Set when symbol needs to be streamed into LTO bytecode for LTO, or in case
476 of offloading, for separate compilation for a different target. */
477 unsigned need_lto_streaming : 1;
479 /* Set when symbol can be streamed into bytecode for offloading. */
480 unsigned offloadable : 1;
483 /* Ordering of all symtab entries. */
484 int order;
486 /* Declaration representing the symbol. */
487 tree decl;
489 /* Linked list of symbol table entries starting with symtab_nodes. */
490 symtab_node *next;
491 symtab_node *previous;
493 /* Linked list of symbols with the same asm name. There may be multiple
494 entries for single symbol name during LTO, because symbols are renamed
495 only after partitioning.
497 Because inline clones are kept in the assembler name has, they also produce
498 duplicate entries.
500 There are also several long standing bugs where frontends and builtin
501 code produce duplicated decls. */
502 symtab_node *next_sharing_asm_name;
503 symtab_node *previous_sharing_asm_name;
505 /* Circular list of nodes in the same comdat group if non-NULL. */
506 symtab_node *same_comdat_group;
508 /* Vectors of referring and referenced entities. */
509 ipa_ref_list ref_list;
511 /* Alias target. May be either DECL pointer or ASSEMBLER_NAME pointer
512 depending to what was known to frontend on the creation time.
513 Once alias is resolved, this pointer become NULL. */
514 tree alias_target;
516 /* File stream where this node is being written to. */
517 struct lto_file_decl_data * lto_file_data;
519 PTR GTY ((skip)) aux;
521 /* Comdat group the symbol is in. Can be private if GGC allowed that. */
522 tree x_comdat_group;
524 /* Section name. Again can be private, if allowed. */
525 section_hash_entry *x_section;
527 protected:
528 /* Dump base fields of symtab nodes to F. Not to be used directly. */
529 void dump_base (FILE *);
531 /* Verify common part of symtab node. */
532 bool DEBUG_FUNCTION verify_base (void);
534 /* Remove node from symbol table. This function is not used directly, but via
535 cgraph/varpool node removal routines. */
536 void unregister (void);
538 /* Return the initialization and finalization priority information for
539 DECL. If there is no previous priority information, a freshly
540 allocated structure is returned. */
541 struct symbol_priority_map *priority_info (void);
543 /* Worker for call_for_symbol_and_aliases_1. */
544 bool call_for_symbol_and_aliases_1 (bool (*callback) (symtab_node *, void *),
545 void *data,
546 bool include_overwrite);
547 private:
548 /* Worker for set_section. */
549 static bool set_section (symtab_node *n, void *s);
551 /* Worker for symtab_resolve_alias. */
552 static bool set_implicit_section (symtab_node *n, void *);
554 /* Worker searching noninterposable alias. */
555 static bool noninterposable_alias (symtab_node *node, void *data);
557 /* Worker for ultimate_alias_target. */
558 symtab_node *ultimate_alias_target_1 (enum availability *avail = NULL);
561 /* Walk all aliases for NODE. */
562 #define FOR_EACH_ALIAS(node, alias) \
563 for (unsigned x_i = 0; node->iterate_direct_aliases (x_i, alias); x_i++)
565 /* This is the information that is put into the cgraph local structure
566 to recover a function. */
567 struct lto_file_decl_data;
569 extern const char * const cgraph_availability_names[];
570 extern const char * const ld_plugin_symbol_resolution_names[];
571 extern const char * const tls_model_names[];
573 /* Information about thunk, used only for same body aliases. */
575 struct GTY(()) cgraph_thunk_info {
576 /* Information about the thunk. */
577 HOST_WIDE_INT fixed_offset;
578 HOST_WIDE_INT virtual_value;
579 tree alias;
580 bool this_adjusting;
581 bool virtual_offset_p;
582 bool add_pointer_bounds_args;
583 /* Set to true when alias node is thunk. */
584 bool thunk_p;
587 /* Information about the function collected locally.
588 Available after function is analyzed. */
590 struct GTY(()) cgraph_local_info {
591 /* Set when function is visible in current compilation unit only and
592 its address is never taken. */
593 unsigned local : 1;
595 /* False when there is something makes versioning impossible. */
596 unsigned versionable : 1;
598 /* False when function calling convention and signature can not be changed.
599 This is the case when __builtin_apply_args is used. */
600 unsigned can_change_signature : 1;
602 /* True when the function has been originally extern inline, but it is
603 redefined now. */
604 unsigned redefined_extern_inline : 1;
606 /* True if the function may enter serial irrevocable mode. */
607 unsigned tm_may_enter_irr : 1;
610 /* Information about the function that needs to be computed globally
611 once compilation is finished. Available only with -funit-at-a-time. */
613 struct GTY(()) cgraph_global_info {
614 /* For inline clones this points to the function they will be
615 inlined into. */
616 cgraph_node *inlined_to;
619 /* Represent which DECL tree (or reference to such tree)
620 will be replaced by another tree while versioning. */
621 struct GTY(()) ipa_replace_map
623 /* The tree that will be replaced. */
624 tree old_tree;
625 /* The new (replacing) tree. */
626 tree new_tree;
627 /* Parameter number to replace, when old_tree is NULL. */
628 int parm_num;
629 /* True when a substitution should be done, false otherwise. */
630 bool replace_p;
631 /* True when we replace a reference to old_tree. */
632 bool ref_p;
635 struct GTY(()) cgraph_clone_info
637 vec<ipa_replace_map *, va_gc> *tree_map;
638 bitmap args_to_skip;
639 bitmap combined_args_to_skip;
642 enum cgraph_simd_clone_arg_type
644 SIMD_CLONE_ARG_TYPE_VECTOR,
645 SIMD_CLONE_ARG_TYPE_UNIFORM,
646 SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP,
647 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP,
648 SIMD_CLONE_ARG_TYPE_MASK
651 /* Function arguments in the original function of a SIMD clone.
652 Supplementary data for `struct simd_clone'. */
654 struct GTY(()) cgraph_simd_clone_arg {
655 /* Original function argument as it originally existed in
656 DECL_ARGUMENTS. */
657 tree orig_arg;
659 /* orig_arg's function (or for extern functions type from
660 TYPE_ARG_TYPES). */
661 tree orig_type;
663 /* If argument is a vector, this holds the vector version of
664 orig_arg that after adjusting the argument types will live in
665 DECL_ARGUMENTS. Otherwise, this is NULL.
667 This basically holds:
668 vector(simdlen) __typeof__(orig_arg) new_arg. */
669 tree vector_arg;
671 /* vector_arg's type (or for extern functions new vector type. */
672 tree vector_type;
674 /* If argument is a vector, this holds the array where the simd
675 argument is held while executing the simd clone function. This
676 is a local variable in the cloned function. Its content is
677 copied from vector_arg upon entry to the clone.
679 This basically holds:
680 __typeof__(orig_arg) simd_array[simdlen]. */
681 tree simd_array;
683 /* A SIMD clone's argument can be either linear (constant or
684 variable), uniform, or vector. */
685 enum cgraph_simd_clone_arg_type arg_type;
687 /* For arg_type SIMD_CLONE_ARG_TYPE_LINEAR_CONSTANT_STEP this is
688 the constant linear step, if arg_type is
689 SIMD_CLONE_ARG_TYPE_LINEAR_VARIABLE_STEP, this is index of
690 the uniform argument holding the step, otherwise 0. */
691 HOST_WIDE_INT linear_step;
693 /* Variable alignment if available, otherwise 0. */
694 unsigned int alignment;
697 /* Specific data for a SIMD function clone. */
699 struct GTY(()) cgraph_simd_clone {
700 /* Number of words in the SIMD lane associated with this clone. */
701 unsigned int simdlen;
703 /* Number of annotated function arguments in `args'. This is
704 usually the number of named arguments in FNDECL. */
705 unsigned int nargs;
707 /* Max hardware vector size in bits for integral vectors. */
708 unsigned int vecsize_int;
710 /* Max hardware vector size in bits for floating point vectors. */
711 unsigned int vecsize_float;
713 /* The mangling character for a given vector size. This is used
714 to determine the ISA mangling bit as specified in the Intel
715 Vector ABI. */
716 unsigned char vecsize_mangle;
718 /* True if this is the masked, in-branch version of the clone,
719 otherwise false. */
720 unsigned int inbranch : 1;
722 /* True if this is a Cilk Plus variant. */
723 unsigned int cilk_elemental : 1;
725 /* Doubly linked list of SIMD clones. */
726 cgraph_node *prev_clone, *next_clone;
728 /* Original cgraph node the SIMD clones were created for. */
729 cgraph_node *origin;
731 /* Annotated function arguments for the original function. */
732 cgraph_simd_clone_arg GTY((length ("%h.nargs"))) args[1];
735 /* Function Multiversioning info. */
736 struct GTY((for_user)) cgraph_function_version_info {
737 /* The cgraph_node for which the function version info is stored. */
738 cgraph_node *this_node;
739 /* Chains all the semantically identical function versions. The
740 first function in this chain is the version_info node of the
741 default function. */
742 cgraph_function_version_info *prev;
743 /* If this version node corresponds to a dispatcher for function
744 versions, this points to the version info node of the default
745 function, the first node in the chain. */
746 cgraph_function_version_info *next;
747 /* If this node corresponds to a function version, this points
748 to the dispatcher function decl, which is the function that must
749 be called to execute the right function version at run-time.
751 If this cgraph node is a dispatcher (if dispatcher_function is
752 true, in the cgraph_node struct) for function versions, this
753 points to resolver function, which holds the function body of the
754 dispatcher. The dispatcher decl is an alias to the resolver
755 function decl. */
756 tree dispatcher_resolver;
759 #define DEFCIFCODE(code, type, string) CIF_ ## code,
760 /* Reasons for inlining failures. */
762 enum cgraph_inline_failed_t {
763 #include "cif-code.def"
764 CIF_N_REASONS
767 enum cgraph_inline_failed_type_t
769 CIF_FINAL_NORMAL = 0,
770 CIF_FINAL_ERROR
773 struct cgraph_edge;
775 struct cgraph_edge_hasher : ggc_ptr_hash<cgraph_edge>
777 typedef gimple compare_type;
779 static hashval_t hash (cgraph_edge *);
780 static hashval_t hash (gimple);
781 static bool equal (cgraph_edge *, gimple);
784 /* The cgraph data structure.
785 Each function decl has assigned cgraph_node listing callees and callers. */
787 struct GTY((tag ("SYMTAB_FUNCTION"))) cgraph_node : public symtab_node {
788 public:
789 /* Remove the node from cgraph and all inline clones inlined into it.
790 Skip however removal of FORBIDDEN_NODE and return true if it needs to be
791 removed. This allows to call the function from outer loop walking clone
792 tree. */
793 bool remove_symbol_and_inline_clones (cgraph_node *forbidden_node = NULL);
795 /* Record all references from cgraph_node that are taken
796 in statement STMT. */
797 void record_stmt_references (gimple stmt);
799 /* Like cgraph_set_call_stmt but walk the clone tree and update all
800 clones sharing the same function body.
801 When WHOLE_SPECULATIVE_EDGES is true, all three components of
802 speculative edge gets updated. Otherwise we update only direct
803 call. */
804 void set_call_stmt_including_clones (gimple old_stmt, gcall *new_stmt,
805 bool update_speculative = true);
807 /* Walk the alias chain to return the function cgraph_node is alias of.
808 Walk through thunk, too.
809 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
810 cgraph_node *function_symbol (enum availability *avail = NULL);
812 /* Walk the alias chain to return the function cgraph_node is alias of.
813 Walk through non virtual thunks, too. Thus we return either a function
814 or a virtual thunk node.
815 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
816 cgraph_node *function_or_virtual_thunk_symbol
817 (enum availability *avail = NULL);
819 /* Create node representing clone of N executed COUNT times. Decrease
820 the execution counts from original node too.
821 The new clone will have decl set to DECL that may or may not be the same
822 as decl of N.
824 When UPDATE_ORIGINAL is true, the counts are subtracted from the original
825 function's profile to reflect the fact that part of execution is handled
826 by node.
827 When CALL_DUPLICATOIN_HOOK is true, the ipa passes are acknowledged about
828 the new clone. Otherwise the caller is responsible for doing so later.
830 If the new node is being inlined into another one, NEW_INLINED_TO should be
831 the outline function the new one is (even indirectly) inlined to.
832 All hooks will see this in node's global.inlined_to, when invoked.
833 Can be NULL if the node is not inlined. */
834 cgraph_node *create_clone (tree decl, gcov_type count, int freq,
835 bool update_original,
836 vec<cgraph_edge *> redirect_callers,
837 bool call_duplication_hook,
838 cgraph_node *new_inlined_to,
839 bitmap args_to_skip);
841 /* Create callgraph node clone with new declaration. The actual body will
842 be copied later at compilation stage. */
843 cgraph_node *create_virtual_clone (vec<cgraph_edge *> redirect_callers,
844 vec<ipa_replace_map *, va_gc> *tree_map,
845 bitmap args_to_skip, const char * suffix);
847 /* cgraph node being removed from symbol table; see if its entry can be
848 replaced by other inline clone. */
849 cgraph_node *find_replacement (void);
851 /* Create a new cgraph node which is the new version of
852 callgraph node. REDIRECT_CALLERS holds the callers
853 edges which should be redirected to point to
854 NEW_VERSION. ALL the callees edges of the node
855 are cloned to the new version node. Return the new
856 version node.
858 If non-NULL BLOCK_TO_COPY determine what basic blocks
859 was copied to prevent duplications of calls that are dead
860 in the clone. */
862 cgraph_node *create_version_clone (tree new_decl,
863 vec<cgraph_edge *> redirect_callers,
864 bitmap bbs_to_copy);
866 /* Perform function versioning.
867 Function versioning includes copying of the tree and
868 a callgraph update (creating a new cgraph node and updating
869 its callees and callers).
871 REDIRECT_CALLERS varray includes the edges to be redirected
872 to the new version.
874 TREE_MAP is a mapping of tree nodes we want to replace with
875 new ones (according to results of prior analysis).
877 If non-NULL ARGS_TO_SKIP determine function parameters to remove
878 from new version.
879 If SKIP_RETURN is true, the new version will return void.
880 If non-NULL BLOCK_TO_COPY determine what basic blocks to copy.
881 If non_NULL NEW_ENTRY determine new entry BB of the clone.
883 Return the new version's cgraph node. */
884 cgraph_node *create_version_clone_with_body
885 (vec<cgraph_edge *> redirect_callers,
886 vec<ipa_replace_map *, va_gc> *tree_map, bitmap args_to_skip,
887 bool skip_return, bitmap bbs_to_copy, basic_block new_entry_block,
888 const char *clone_name);
890 /* Insert a new cgraph_function_version_info node into cgraph_fnver_htab
891 corresponding to cgraph_node. */
892 cgraph_function_version_info *insert_new_function_version (void);
894 /* Get the cgraph_function_version_info node corresponding to node. */
895 cgraph_function_version_info *function_version (void);
897 /* Discover all functions and variables that are trivially needed, analyze
898 them as well as all functions and variables referred by them */
899 void analyze (void);
901 /* Add thunk alias into callgraph. The alias declaration is ALIAS and it
902 aliases DECL with an adjustments made into the first parameter.
903 See comments in thunk_adjust for detail on the parameters. */
904 cgraph_node * create_thunk (tree alias, tree, bool this_adjusting,
905 HOST_WIDE_INT fixed_offset,
906 HOST_WIDE_INT virtual_value,
907 tree virtual_offset,
908 tree real_alias);
911 /* Return node that alias is aliasing. */
912 inline cgraph_node *get_alias_target (void);
914 /* Given function symbol, walk the alias chain to return the function node
915 is alias of. Do not walk through thunks.
916 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
918 cgraph_node *ultimate_alias_target (availability *availability = NULL);
920 /* Expand thunk NODE to gimple if possible.
921 When FORCE_GIMPLE_THUNK is true, gimple thunk is created and
922 no assembler is produced.
923 When OUTPUT_ASM_THUNK is true, also produce assembler for
924 thunks that are not lowered. */
925 bool expand_thunk (bool output_asm_thunks, bool force_gimple_thunk);
927 /* Call expand_thunk on all callers that are thunks and analyze those
928 nodes that were expanded. */
929 void expand_all_artificial_thunks ();
931 /* Assemble thunks and aliases associated to node. */
932 void assemble_thunks_and_aliases (void);
934 /* Expand function specified by node. */
935 void expand (void);
937 /* As an GCC extension we allow redefinition of the function. The
938 semantics when both copies of bodies differ is not well defined.
939 We replace the old body with new body so in unit at a time mode
940 we always use new body, while in normal mode we may end up with
941 old body inlined into some functions and new body expanded and
942 inlined in others. */
943 void reset (void);
945 /* Creates a wrapper from cgraph_node to TARGET node. Thunk is used for this
946 kind of wrapper method. */
947 void create_wrapper (cgraph_node *target);
949 /* Verify cgraph nodes of the cgraph node. */
950 void DEBUG_FUNCTION verify_node (void);
952 /* Remove function from symbol table. */
953 void remove (void);
955 /* Dump call graph node to file F. */
956 void dump (FILE *f);
958 /* Dump call graph node to stderr. */
959 void DEBUG_FUNCTION debug (void);
961 /* When doing LTO, read cgraph_node's body from disk if it is not already
962 present. */
963 bool get_untransformed_body (void);
965 /* Prepare function body. When doing LTO, read cgraph_node's body from disk
966 if it is not already present. When some IPA transformations are scheduled,
967 apply them. */
968 bool get_body (void);
970 /* Release memory used to represent body of function.
971 Use this only for functions that are released before being translated to
972 target code (i.e. RTL). Functions that are compiled to RTL and beyond
973 are free'd in final.c via free_after_compilation(). */
974 void release_body (bool keep_arguments = false);
976 /* Return the DECL_STRUCT_FUNCTION of the function. */
977 struct function *get_fun (void);
979 /* cgraph_node is no longer nested function; update cgraph accordingly. */
980 void unnest (void);
982 /* Bring cgraph node local. */
983 void make_local (void);
985 /* Likewise indicate that a node is having address taken. */
986 void mark_address_taken (void);
988 /* Set fialization priority to PRIORITY. */
989 void set_fini_priority (priority_type priority);
991 /* Return the finalization priority. */
992 priority_type get_fini_priority (void);
994 /* Create edge from a given function to CALLEE in the cgraph. */
995 cgraph_edge *create_edge (cgraph_node *callee,
996 gcall *call_stmt, gcov_type count,
997 int freq);
999 /* Create an indirect edge with a yet-undetermined callee where the call
1000 statement destination is a formal parameter of the caller with index
1001 PARAM_INDEX. */
1002 cgraph_edge *create_indirect_edge (gcall *call_stmt, int ecf_flags,
1003 gcov_type count, int freq,
1004 bool compute_indirect_info = true);
1006 /* Like cgraph_create_edge walk the clone tree and update all clones sharing
1007 same function body. If clones already have edge for OLD_STMT; only
1008 update the edge same way as cgraph_set_call_stmt_including_clones does. */
1009 void create_edge_including_clones (cgraph_node *callee,
1010 gimple old_stmt, gcall *stmt,
1011 gcov_type count,
1012 int freq,
1013 cgraph_inline_failed_t reason);
1015 /* Return the callgraph edge representing the GIMPLE_CALL statement
1016 CALL_STMT. */
1017 cgraph_edge *get_edge (gimple call_stmt);
1019 /* Collect all callers of cgraph_node and its aliases that are known to lead
1020 to NODE (i.e. are not overwritable). */
1021 vec<cgraph_edge *> collect_callers (void);
1023 /* Remove all callers from the node. */
1024 void remove_callers (void);
1026 /* Remove all callees from the node. */
1027 void remove_callees (void);
1029 /* Return function availability. See cgraph.h for description of individual
1030 return values. */
1031 enum availability get_availability (void);
1033 /* Set TREE_NOTHROW on cgraph_node's decl and on aliases of the node
1034 if any to NOTHROW. */
1035 void set_nothrow_flag (bool nothrow);
1037 /* Set TREE_READONLY on cgraph_node's decl and on aliases of the node
1038 if any to READONLY. */
1039 void set_const_flag (bool readonly, bool looping);
1041 /* Set DECL_PURE_P on cgraph_node's decl and on aliases of the node
1042 if any to PURE. */
1043 void set_pure_flag (bool pure, bool looping);
1045 /* Call callback on function and aliases associated to the function.
1046 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1047 skipped. */
1049 bool call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
1050 void *),
1051 void *data, bool include_overwritable);
1053 /* Call callback on cgraph_node, thunks and aliases associated to NODE.
1054 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1055 skipped. When EXCLUDE_VIRTUAL_THUNKS is true, virtual thunks are
1056 skipped. */
1057 bool call_for_symbol_thunks_and_aliases (bool (*callback) (cgraph_node *node,
1058 void *data),
1059 void *data,
1060 bool include_overwritable,
1061 bool exclude_virtual_thunks = false);
1063 /* Likewise indicate that a node is needed, i.e. reachable via some
1064 external means. */
1065 inline void mark_force_output (void);
1067 /* Return true when function can be marked local. */
1068 bool local_p (void);
1070 /* Return true if cgraph_node can be made local for API change.
1071 Extern inline functions and C++ COMDAT functions can be made local
1072 at the expense of possible code size growth if function is used in multiple
1073 compilation units. */
1074 bool can_be_local_p (void);
1076 /* Return true when cgraph_node can not return or throw and thus
1077 it is safe to ignore its side effects for IPA analysis. */
1078 bool cannot_return_p (void);
1080 /* Return true when function cgraph_node and all its aliases are only called
1081 directly.
1082 i.e. it is not externally visible, address was not taken and
1083 it is not used in any other non-standard way. */
1084 bool only_called_directly_p (void);
1086 /* Return true when function is only called directly or it has alias.
1087 i.e. it is not externally visible, address was not taken and
1088 it is not used in any other non-standard way. */
1089 inline bool only_called_directly_or_aliased_p (void);
1091 /* Return true when function cgraph_node can be expected to be removed
1092 from program when direct calls in this compilation unit are removed.
1094 As a special case COMDAT functions are
1095 cgraph_can_remove_if_no_direct_calls_p while the are not
1096 cgraph_only_called_directly_p (it is possible they are called from other
1097 unit)
1099 This function behaves as cgraph_only_called_directly_p because eliminating
1100 all uses of COMDAT function does not make it necessarily disappear from
1101 the program unless we are compiling whole program or we do LTO. In this
1102 case we know we win since dynamic linking will not really discard the
1103 linkonce section.
1105 If WILL_INLINE is true, assume that function will be inlined into all the
1106 direct calls. */
1107 bool will_be_removed_from_program_if_no_direct_calls_p
1108 (bool will_inline = false);
1110 /* Return true when function can be removed from callgraph
1111 if all direct calls and references are eliminated. The function does
1112 not take into account comdat groups. */
1113 bool can_remove_if_no_direct_calls_and_refs_p (void);
1115 /* Return true when function cgraph_node and its aliases can be removed from
1116 callgraph if all direct calls are eliminated.
1117 If WILL_INLINE is true, assume that function will be inlined into all the
1118 direct calls. */
1119 bool can_remove_if_no_direct_calls_p (bool will_inline = false);
1121 /* Return true when callgraph node is a function with Gimple body defined
1122 in current unit. Functions can also be define externally or they
1123 can be thunks with no Gimple representation.
1125 Note that at WPA stage, the function body may not be present in memory. */
1126 inline bool has_gimple_body_p (void);
1128 /* Return true if function should be optimized for size. */
1129 bool optimize_for_size_p (void);
1131 /* Dump the callgraph to file F. */
1132 static void dump_cgraph (FILE *f);
1134 /* Dump the call graph to stderr. */
1135 static inline
1136 void debug_cgraph (void)
1138 dump_cgraph (stderr);
1141 /* Record that DECL1 and DECL2 are semantically identical function
1142 versions. */
1143 static void record_function_versions (tree decl1, tree decl2);
1145 /* Remove the cgraph_function_version_info and cgraph_node for DECL. This
1146 DECL is a duplicate declaration. */
1147 static void delete_function_version (tree decl);
1149 /* Add the function FNDECL to the call graph.
1150 Unlike finalize_function, this function is intended to be used
1151 by middle end and allows insertion of new function at arbitrary point
1152 of compilation. The function can be either in high, low or SSA form
1153 GIMPLE.
1155 The function is assumed to be reachable and have address taken (so no
1156 API breaking optimizations are performed on it).
1158 Main work done by this function is to enqueue the function for later
1159 processing to avoid need the passes to be re-entrant. */
1160 static void add_new_function (tree fndecl, bool lowered);
1162 /* Return callgraph node for given symbol and check it is a function. */
1163 static inline cgraph_node *get (const_tree decl)
1165 gcc_checking_assert (TREE_CODE (decl) == FUNCTION_DECL);
1166 return dyn_cast <cgraph_node *> (symtab_node::get (decl));
1169 /* DECL has been parsed. Take it, queue it, compile it at the whim of the
1170 logic in effect. If NO_COLLECT is true, then our caller cannot stand to
1171 have the garbage collector run at the moment. We would need to either
1172 create a new GC context, or just not compile right now. */
1173 static void finalize_function (tree, bool);
1175 /* Return cgraph node assigned to DECL. Create new one when needed. */
1176 static cgraph_node * create (tree decl);
1178 /* Try to find a call graph node for declaration DECL and if it does not
1179 exist or if it corresponds to an inline clone, create a new one. */
1180 static cgraph_node * get_create (tree);
1182 /* Return local info for the compiled function. */
1183 static cgraph_local_info *local_info (tree decl);
1185 /* Return local info for the compiled function. */
1186 static struct cgraph_rtl_info *rtl_info (tree);
1188 /* Return the cgraph node that has ASMNAME for its DECL_ASSEMBLER_NAME.
1189 Return NULL if there's no such node. */
1190 static cgraph_node *get_for_asmname (tree asmname);
1192 /* Attempt to mark ALIAS as an alias to DECL. Return alias node if
1193 successful and NULL otherwise.
1194 Same body aliases are output whenever the body of DECL is output,
1195 and cgraph_node::get (ALIAS) transparently
1196 returns cgraph_node::get (DECL). */
1197 static cgraph_node * create_same_body_alias (tree alias, tree decl);
1199 /* Verify whole cgraph structure. */
1200 static void DEBUG_FUNCTION verify_cgraph_nodes (void);
1202 /* Worker to bring NODE local. */
1203 static bool make_local (cgraph_node *node, void *);
1205 /* Mark ALIAS as an alias to DECL. DECL_NODE is cgraph node representing
1206 the function body is associated
1207 with (not necessarily cgraph_node (DECL). */
1208 static cgraph_node *create_alias (tree alias, tree target);
1210 /* Return true if NODE has thunk. */
1211 static bool has_thunk_p (cgraph_node *node, void *);
1213 cgraph_edge *callees;
1214 cgraph_edge *callers;
1215 /* List of edges representing indirect calls with a yet undetermined
1216 callee. */
1217 cgraph_edge *indirect_calls;
1218 /* For nested functions points to function the node is nested in. */
1219 cgraph_node *origin;
1220 /* Points to first nested function, if any. */
1221 cgraph_node *nested;
1222 /* Pointer to the next function with same origin, if any. */
1223 cgraph_node *next_nested;
1224 /* Pointer to the next clone. */
1225 cgraph_node *next_sibling_clone;
1226 cgraph_node *prev_sibling_clone;
1227 cgraph_node *clones;
1228 cgraph_node *clone_of;
1229 /* If instrumentation_clone is 1 then instrumented_version points
1230 to the original function used to make instrumented version.
1231 Otherwise points to instrumented version of the function. */
1232 cgraph_node *instrumented_version;
1233 /* If instrumentation_clone is 1 then orig_decl is the original
1234 function declaration. */
1235 tree orig_decl;
1236 /* For functions with many calls sites it holds map from call expression
1237 to the edge to speed up cgraph_edge function. */
1238 hash_table<cgraph_edge_hasher> *GTY(()) call_site_hash;
1239 /* Declaration node used to be clone of. */
1240 tree former_clone_of;
1242 /* If this is a SIMD clone, this points to the SIMD specific
1243 information for it. */
1244 cgraph_simd_clone *simdclone;
1245 /* If this function has SIMD clones, this points to the first clone. */
1246 cgraph_node *simd_clones;
1248 /* Interprocedural passes scheduled to have their transform functions
1249 applied next time we execute local pass on them. We maintain it
1250 per-function in order to allow IPA passes to introduce new functions. */
1251 vec<ipa_opt_pass> GTY((skip)) ipa_transforms_to_apply;
1253 cgraph_local_info local;
1254 cgraph_global_info global;
1255 struct cgraph_rtl_info *rtl;
1256 cgraph_clone_info clone;
1257 cgraph_thunk_info thunk;
1259 /* Expected number of executions: calculated in profile.c. */
1260 gcov_type count;
1261 /* How to scale counts at materialization time; used to merge
1262 LTO units with different number of profile runs. */
1263 int count_materialization_scale;
1264 /* Unique id of the node. */
1265 int uid;
1266 /* Summary unique id of the node. */
1267 int summary_uid;
1268 /* ID assigned by the profiling. */
1269 unsigned int profile_id;
1270 /* Time profiler: first run of function. */
1271 int tp_first_run;
1273 /* Set when decl is an abstract function pointed to by the
1274 ABSTRACT_DECL_ORIGIN of a reachable function. */
1275 unsigned used_as_abstract_origin : 1;
1276 /* Set once the function is lowered (i.e. its CFG is built). */
1277 unsigned lowered : 1;
1278 /* Set once the function has been instantiated and its callee
1279 lists created. */
1280 unsigned process : 1;
1281 /* How commonly executed the node is. Initialized during branch
1282 probabilities pass. */
1283 ENUM_BITFIELD (node_frequency) frequency : 2;
1284 /* True when function can only be called at startup (from static ctor). */
1285 unsigned only_called_at_startup : 1;
1286 /* True when function can only be called at startup (from static dtor). */
1287 unsigned only_called_at_exit : 1;
1288 /* True when function is the transactional clone of a function which
1289 is called only from inside transactions. */
1290 /* ?? We should be able to remove this. We have enough bits in
1291 cgraph to calculate it. */
1292 unsigned tm_clone : 1;
1293 /* True if this decl is a dispatcher for function versions. */
1294 unsigned dispatcher_function : 1;
1295 /* True if this decl calls a COMDAT-local function. This is set up in
1296 compute_inline_parameters and inline_call. */
1297 unsigned calls_comdat_local : 1;
1298 /* True if node has been created by merge operation in IPA-ICF. */
1299 unsigned icf_merged: 1;
1300 /* True when function is clone created for Pointer Bounds Checker
1301 instrumentation. */
1302 unsigned instrumentation_clone : 1;
1303 /* True if call to node can't result in a call to free, munmap or
1304 other operation that could make previously non-trapping memory
1305 accesses trapping. */
1306 unsigned nonfreeing_fn : 1;
1307 /* True if there was multiple COMDAT bodies merged by lto-symtab. */
1308 unsigned merged : 1;
1309 /* True if function was created to be executed in parallel. */
1310 unsigned parallelized_function : 1;
1311 /* True if function is part split out by ipa-split. */
1312 unsigned split_part : 1;
1314 private:
1315 /* Worker for call_for_symbol_and_aliases. */
1316 bool call_for_symbol_and_aliases_1 (bool (*callback) (cgraph_node *,
1317 void *),
1318 void *data, bool include_overwritable);
1321 /* A cgraph node set is a collection of cgraph nodes. A cgraph node
1322 can appear in multiple sets. */
1323 struct cgraph_node_set_def
1325 hash_map<cgraph_node *, size_t> *map;
1326 vec<cgraph_node *> nodes;
1329 typedef cgraph_node_set_def *cgraph_node_set;
1330 typedef struct varpool_node_set_def *varpool_node_set;
1332 class varpool_node;
1334 /* A varpool node set is a collection of varpool nodes. A varpool node
1335 can appear in multiple sets. */
1336 struct varpool_node_set_def
1338 hash_map<varpool_node *, size_t> * map;
1339 vec<varpool_node *> nodes;
1342 /* Iterator structure for cgraph node sets. */
1343 struct cgraph_node_set_iterator
1345 cgraph_node_set set;
1346 unsigned index;
1349 /* Iterator structure for varpool node sets. */
1350 struct varpool_node_set_iterator
1352 varpool_node_set set;
1353 unsigned index;
1356 /* Context of polymorphic call. It represent information about the type of
1357 instance that may reach the call. This is used by ipa-devirt walkers of the
1358 type inheritance graph. */
1360 class GTY(()) ipa_polymorphic_call_context {
1361 public:
1362 /* The called object appears in an object of type OUTER_TYPE
1363 at offset OFFSET. When information is not 100% reliable, we
1364 use SPECULATIVE_OUTER_TYPE and SPECULATIVE_OFFSET. */
1365 HOST_WIDE_INT offset;
1366 HOST_WIDE_INT speculative_offset;
1367 tree outer_type;
1368 tree speculative_outer_type;
1369 /* True if outer object may be in construction or destruction. */
1370 unsigned maybe_in_construction : 1;
1371 /* True if outer object may be of derived type. */
1372 unsigned maybe_derived_type : 1;
1373 /* True if speculative outer object may be of derived type. We always
1374 speculate that construction does not happen. */
1375 unsigned speculative_maybe_derived_type : 1;
1376 /* True if the context is invalid and all calls should be redirected
1377 to BUILTIN_UNREACHABLE. */
1378 unsigned invalid : 1;
1379 /* True if the outer type is dynamic. */
1380 unsigned dynamic : 1;
1382 /* Build empty "I know nothing" context. */
1383 ipa_polymorphic_call_context ();
1384 /* Build polymorphic call context for indirect call E. */
1385 ipa_polymorphic_call_context (cgraph_edge *e);
1386 /* Build polymorphic call context for IP invariant CST.
1387 If specified, OTR_TYPE specify the type of polymorphic call
1388 that takes CST+OFFSET as a prameter. */
1389 ipa_polymorphic_call_context (tree cst, tree otr_type = NULL,
1390 HOST_WIDE_INT offset = 0);
1391 /* Build context for pointer REF contained in FNDECL at statement STMT.
1392 if INSTANCE is non-NULL, return pointer to the object described by
1393 the context. */
1394 ipa_polymorphic_call_context (tree fndecl, tree ref, gimple stmt,
1395 tree *instance = NULL);
1397 /* Look for vtable stores or constructor calls to work out dynamic type
1398 of memory location. */
1399 bool get_dynamic_type (tree, tree, tree, gimple);
1401 /* Make context non-speculative. */
1402 void clear_speculation ();
1404 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
1405 NULL, the context is set to dummy "I know nothing" setting. */
1406 void clear_outer_type (tree otr_type = NULL);
1408 /* Walk container types and modify context to point to actual class
1409 containing OTR_TYPE (if non-NULL) as base class.
1410 Return true if resulting context is valid.
1412 When CONSIDER_PLACEMENT_NEW is false, reject contexts that may be made
1413 valid only via alocation of new polymorphic type inside by means
1414 of placement new.
1416 When CONSIDER_BASES is false, only look for actual fields, not base types
1417 of TYPE. */
1418 bool restrict_to_inner_class (tree otr_type,
1419 bool consider_placement_new = true,
1420 bool consider_bases = true);
1422 /* Adjust all offsets in contexts by given number of bits. */
1423 void offset_by (HOST_WIDE_INT);
1424 /* Use when we can not track dynamic type change. This speculatively assume
1425 type change is not happening. */
1426 void possible_dynamic_type_change (bool, tree otr_type = NULL);
1427 /* Assume that both THIS and a given context is valid and strenghten THIS
1428 if possible. Return true if any strenghtening was made.
1429 If actual type the context is being used in is known, OTR_TYPE should be
1430 set accordingly. This improves quality of combined result. */
1431 bool combine_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1432 bool meet_with (ipa_polymorphic_call_context, tree otr_type = NULL);
1434 /* Return TRUE if context is fully useless. */
1435 bool useless_p () const;
1436 /* Return TRUE if this context conveys the same information as X. */
1437 bool equal_to (const ipa_polymorphic_call_context &x) const;
1439 /* Dump human readable context to F. If NEWLINE is true, it will be
1440 terminated by a newline. */
1441 void dump (FILE *f, bool newline = true) const;
1442 void DEBUG_FUNCTION debug () const;
1444 /* LTO streaming. */
1445 void stream_out (struct output_block *) const;
1446 void stream_in (struct lto_input_block *, struct data_in *data_in);
1448 private:
1449 bool combine_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1450 bool meet_speculation_with (tree, HOST_WIDE_INT, bool, tree);
1451 void set_by_decl (tree, HOST_WIDE_INT);
1452 bool set_by_invariant (tree, tree, HOST_WIDE_INT);
1453 bool speculation_consistent_p (tree, HOST_WIDE_INT, bool, tree) const;
1454 void make_speculative (tree otr_type = NULL);
1457 /* Structure containing additional information about an indirect call. */
1459 struct GTY(()) cgraph_indirect_call_info
1461 /* When agg_content is set, an offset where the call pointer is located
1462 within the aggregate. */
1463 HOST_WIDE_INT offset;
1464 /* Context of the polymorphic call; use only when POLYMORPHIC flag is set. */
1465 ipa_polymorphic_call_context context;
1466 /* OBJ_TYPE_REF_TOKEN of a polymorphic call (if polymorphic is set). */
1467 HOST_WIDE_INT otr_token;
1468 /* Type of the object from OBJ_TYPE_REF_OBJECT. */
1469 tree otr_type;
1470 /* Index of the parameter that is called. */
1471 int param_index;
1472 /* ECF flags determined from the caller. */
1473 int ecf_flags;
1474 /* Profile_id of common target obtrained from profile. */
1475 int common_target_id;
1476 /* Probability that call will land in function with COMMON_TARGET_ID. */
1477 int common_target_probability;
1479 /* Set when the call is a virtual call with the parameter being the
1480 associated object pointer rather than a simple direct call. */
1481 unsigned polymorphic : 1;
1482 /* Set when the call is a call of a pointer loaded from contents of an
1483 aggregate at offset. */
1484 unsigned agg_contents : 1;
1485 /* Set when this is a call through a member pointer. */
1486 unsigned member_ptr : 1;
1487 /* When the previous bit is set, this one determines whether the destination
1488 is loaded from a parameter passed by reference. */
1489 unsigned by_ref : 1;
1490 /* For polymorphic calls this specify whether the virtual table pointer
1491 may have changed in between function entry and the call. */
1492 unsigned vptr_changed : 1;
1495 struct GTY((chain_next ("%h.next_caller"), chain_prev ("%h.prev_caller"),
1496 for_user)) cgraph_edge {
1497 friend class cgraph_node;
1499 /* Remove the edge in the cgraph. */
1500 void remove (void);
1502 /* Change field call_stmt of edge to NEW_STMT.
1503 If UPDATE_SPECULATIVE and E is any component of speculative
1504 edge, then update all components. */
1505 void set_call_stmt (gcall *new_stmt, bool update_speculative = true);
1507 /* Redirect callee of the edge to N. The function does not update underlying
1508 call expression. */
1509 void redirect_callee (cgraph_node *n);
1511 /* If the edge does not lead to a thunk, simply redirect it to N. Otherwise
1512 create one or more equivalent thunks for N and redirect E to the first in
1513 the chain. Note that it is then necessary to call
1514 n->expand_all_artificial_thunks once all callers are redirected. */
1515 void redirect_callee_duplicating_thunks (cgraph_node *n);
1517 /* Make an indirect edge with an unknown callee an ordinary edge leading to
1518 CALLEE. DELTA is an integer constant that is to be added to the this
1519 pointer (first parameter) to compensate for skipping
1520 a thunk adjustment. */
1521 cgraph_edge *make_direct (cgraph_node *callee);
1523 /* Turn edge into speculative call calling N2. Update
1524 the profile so the direct call is taken COUNT times
1525 with FREQUENCY. */
1526 cgraph_edge *make_speculative (cgraph_node *n2, gcov_type direct_count,
1527 int direct_frequency);
1529 /* Given speculative call edge, return all three components. */
1530 void speculative_call_info (cgraph_edge *&direct, cgraph_edge *&indirect,
1531 ipa_ref *&reference);
1533 /* Speculative call edge turned out to be direct call to CALLE_DECL.
1534 Remove the speculative call sequence and return edge representing the call.
1535 It is up to caller to redirect the call as appropriate. */
1536 cgraph_edge *resolve_speculation (tree callee_decl = NULL);
1538 /* If necessary, change the function declaration in the call statement
1539 associated with the edge so that it corresponds to the edge callee. */
1540 gimple redirect_call_stmt_to_callee (void);
1542 /* Create clone of edge in the node N represented
1543 by CALL_EXPR the callgraph. */
1544 cgraph_edge * clone (cgraph_node *n, gcall *call_stmt, unsigned stmt_uid,
1545 gcov_type count_scale, int freq_scale, bool update_original);
1547 /* Verify edge count and frequency. */
1548 bool verify_count_and_frequency ();
1550 /* Return true when call of edge can not lead to return from caller
1551 and thus it is safe to ignore its side effects for IPA analysis
1552 when computing side effects of the caller. */
1553 bool cannot_lead_to_return_p (void);
1555 /* Return true when the edge represents a direct recursion. */
1556 bool recursive_p (void);
1558 /* Return true if the call can be hot. */
1559 bool maybe_hot_p (void);
1561 /* Rebuild cgraph edges for current function node. This needs to be run after
1562 passes that don't update the cgraph. */
1563 static unsigned int rebuild_edges (void);
1565 /* Rebuild cgraph references for current function node. This needs to be run
1566 after passes that don't update the cgraph. */
1567 static void rebuild_references (void);
1569 /* Expected number of executions: calculated in profile.c. */
1570 gcov_type count;
1571 cgraph_node *caller;
1572 cgraph_node *callee;
1573 cgraph_edge *prev_caller;
1574 cgraph_edge *next_caller;
1575 cgraph_edge *prev_callee;
1576 cgraph_edge *next_callee;
1577 gcall *call_stmt;
1578 /* Additional information about an indirect call. Not cleared when an edge
1579 becomes direct. */
1580 cgraph_indirect_call_info *indirect_info;
1581 PTR GTY ((skip (""))) aux;
1582 /* When equal to CIF_OK, inline this call. Otherwise, points to the
1583 explanation why function was not inlined. */
1584 enum cgraph_inline_failed_t inline_failed;
1585 /* The stmt_uid of call_stmt. This is used by LTO to recover the call_stmt
1586 when the function is serialized in. */
1587 unsigned int lto_stmt_uid;
1588 /* Expected frequency of executions within the function.
1589 When set to CGRAPH_FREQ_BASE, the edge is expected to be called once
1590 per function call. The range is 0 to CGRAPH_FREQ_MAX. */
1591 int frequency;
1592 /* Unique id of the edge. */
1593 int uid;
1594 /* Whether this edge was made direct by indirect inlining. */
1595 unsigned int indirect_inlining_edge : 1;
1596 /* Whether this edge describes an indirect call with an undetermined
1597 callee. */
1598 unsigned int indirect_unknown_callee : 1;
1599 /* Whether this edge is still a dangling */
1600 /* True if the corresponding CALL stmt cannot be inlined. */
1601 unsigned int call_stmt_cannot_inline_p : 1;
1602 /* Can this call throw externally? */
1603 unsigned int can_throw_external : 1;
1604 /* Edges with SPECULATIVE flag represents indirect calls that was
1605 speculatively turned into direct (i.e. by profile feedback).
1606 The final code sequence will have form:
1608 if (call_target == expected_fn)
1609 expected_fn ();
1610 else
1611 call_target ();
1613 Every speculative call is represented by three components attached
1614 to a same call statement:
1615 1) a direct call (to expected_fn)
1616 2) an indirect call (to call_target)
1617 3) a IPA_REF_ADDR refrence to expected_fn.
1619 Optimizers may later redirect direct call to clone, so 1) and 3)
1620 do not need to necesarily agree with destination. */
1621 unsigned int speculative : 1;
1622 /* Set to true when caller is a constructor or destructor of polymorphic
1623 type. */
1624 unsigned in_polymorphic_cdtor : 1;
1626 private:
1627 /* Remove the edge from the list of the callers of the callee. */
1628 void remove_caller (void);
1630 /* Remove the edge from the list of the callees of the caller. */
1631 void remove_callee (void);
1633 /* Set callee N of call graph edge and add it to the corresponding set of
1634 callers. */
1635 void set_callee (cgraph_node *n);
1637 /* Output flags of edge to a file F. */
1638 void dump_edge_flags (FILE *f);
1640 /* Verify that call graph edge corresponds to DECL from the associated
1641 statement. Return true if the verification should fail. */
1642 bool verify_corresponds_to_fndecl (tree decl);
1645 #define CGRAPH_FREQ_BASE 1000
1646 #define CGRAPH_FREQ_MAX 100000
1648 /* The varpool data structure.
1649 Each static variable decl has assigned varpool_node. */
1651 class GTY((tag ("SYMTAB_VARIABLE"))) varpool_node : public symtab_node {
1652 public:
1653 /* Dump given varpool node to F. */
1654 void dump (FILE *f);
1656 /* Dump given varpool node to stderr. */
1657 void DEBUG_FUNCTION debug (void);
1659 /* Remove variable from symbol table. */
1660 void remove (void);
1662 /* Remove node initializer when it is no longer needed. */
1663 void remove_initializer (void);
1665 void analyze (void);
1667 /* Return variable availability. */
1668 availability get_availability (void);
1670 /* When doing LTO, read variable's constructor from disk if
1671 it is not already present. */
1672 tree get_constructor (void);
1674 /* Return true if variable has constructor that can be used for folding. */
1675 bool ctor_useable_for_folding_p (void);
1677 /* For given variable pool node, walk the alias chain to return the function
1678 the variable is alias of. Do not walk through thunks.
1679 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
1680 inline varpool_node *ultimate_alias_target
1681 (availability *availability = NULL);
1683 /* Return node that alias is aliasing. */
1684 inline varpool_node *get_alias_target (void);
1686 /* Output one variable, if necessary. Return whether we output it. */
1687 bool assemble_decl (void);
1689 /* For variables in named sections make sure get_variable_section
1690 is called before we switch to those sections. Then section
1691 conflicts between read-only and read-only requiring relocations
1692 sections can be resolved. */
1693 void finalize_named_section_flags (void);
1695 /* Call calback on varpool symbol and aliases associated to varpool symbol.
1696 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
1697 skipped. */
1698 bool call_for_symbol_and_aliases (bool (*callback) (varpool_node *, void *),
1699 void *data,
1700 bool include_overwritable);
1702 /* Return true when variable should be considered externally visible. */
1703 bool externally_visible_p (void);
1705 /* Return true when all references to variable must be visible
1706 in ipa_ref_list.
1707 i.e. if the variable is not externally visible or not used in some magic
1708 way (asm statement or such).
1709 The magic uses are all summarized in force_output flag. */
1710 inline bool all_refs_explicit_p ();
1712 /* Return true when variable can be removed from variable pool
1713 if all direct calls are eliminated. */
1714 inline bool can_remove_if_no_refs_p (void);
1716 /* Add the variable DECL to the varpool.
1717 Unlike finalize_decl function is intended to be used
1718 by middle end and allows insertion of new variable at arbitrary point
1719 of compilation. */
1720 static void add (tree decl);
1722 /* Return varpool node for given symbol and check it is a function. */
1723 static inline varpool_node *get (const_tree decl);
1725 /* Mark DECL as finalized. By finalizing the declaration, frontend instruct
1726 the middle end to output the variable to asm file, if needed or externally
1727 visible. */
1728 static void finalize_decl (tree decl);
1730 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1731 Extra name aliases are output whenever DECL is output. */
1732 static varpool_node * create_extra_name_alias (tree alias, tree decl);
1734 /* Attempt to mark ALIAS as an alias to DECL. Return TRUE if successful.
1735 Extra name aliases are output whenever DECL is output. */
1736 static varpool_node * create_alias (tree, tree);
1738 /* Dump the variable pool to F. */
1739 static void dump_varpool (FILE *f);
1741 /* Dump the variable pool to stderr. */
1742 static void DEBUG_FUNCTION debug_varpool (void);
1744 /* Allocate new callgraph node and insert it into basic data structures. */
1745 static varpool_node *create_empty (void);
1747 /* Return varpool node assigned to DECL. Create new one when needed. */
1748 static varpool_node *get_create (tree decl);
1750 /* Given an assembler name, lookup node. */
1751 static varpool_node *get_for_asmname (tree asmname);
1753 /* Set when variable is scheduled to be assembled. */
1754 unsigned output : 1;
1756 /* Set when variable has statically initialized pointer
1757 or is a static bounds variable and needs initalization. */
1758 unsigned need_bounds_init : 1;
1760 /* Set if the variable is dynamically initialized, except for
1761 function local statics. */
1762 unsigned dynamically_initialized : 1;
1764 ENUM_BITFIELD(tls_model) tls_model : 3;
1766 /* Set if the variable is known to be used by single function only.
1767 This is computed by ipa_signle_use pass and used by late optimizations
1768 in places where optimization would be valid for local static variable
1769 if we did not do any inter-procedural code movement. */
1770 unsigned used_by_single_function : 1;
1772 private:
1773 /* Assemble thunks and aliases associated to varpool node. */
1774 void assemble_aliases (void);
1776 /* Worker for call_for_node_and_aliases. */
1777 bool call_for_symbol_and_aliases_1 (bool (*callback) (varpool_node *, void *),
1778 void *data,
1779 bool include_overwritable);
1782 /* Every top level asm statement is put into a asm_node. */
1784 struct GTY(()) asm_node {
1787 /* Next asm node. */
1788 asm_node *next;
1789 /* String for this asm node. */
1790 tree asm_str;
1791 /* Ordering of all cgraph nodes. */
1792 int order;
1795 /* Report whether or not THIS symtab node is a function, aka cgraph_node. */
1797 template <>
1798 template <>
1799 inline bool
1800 is_a_helper <cgraph_node *>::test (symtab_node *p)
1802 return p && p->type == SYMTAB_FUNCTION;
1805 /* Report whether or not THIS symtab node is a vriable, aka varpool_node. */
1807 template <>
1808 template <>
1809 inline bool
1810 is_a_helper <varpool_node *>::test (symtab_node *p)
1812 return p && p->type == SYMTAB_VARIABLE;
1815 /* Macros to access the next item in the list of free cgraph nodes and
1816 edges. */
1817 #define NEXT_FREE_NODE(NODE) dyn_cast<cgraph_node *> ((NODE)->next)
1818 #define SET_NEXT_FREE_NODE(NODE,NODE2) ((NODE))->next = NODE2
1819 #define NEXT_FREE_EDGE(EDGE) (EDGE)->prev_caller
1821 typedef void (*cgraph_edge_hook)(cgraph_edge *, void *);
1822 typedef void (*cgraph_node_hook)(cgraph_node *, void *);
1823 typedef void (*varpool_node_hook)(varpool_node *, void *);
1824 typedef void (*cgraph_2edge_hook)(cgraph_edge *, cgraph_edge *, void *);
1825 typedef void (*cgraph_2node_hook)(cgraph_node *, cgraph_node *, void *);
1827 struct cgraph_edge_hook_list;
1828 struct cgraph_node_hook_list;
1829 struct varpool_node_hook_list;
1830 struct cgraph_2edge_hook_list;
1831 struct cgraph_2node_hook_list;
1833 /* Map from a symbol to initialization/finalization priorities. */
1834 struct GTY(()) symbol_priority_map {
1835 priority_type init;
1836 priority_type fini;
1839 enum symtab_state
1841 /* Frontend is parsing and finalizing functions. */
1842 PARSING,
1843 /* Callgraph is being constructed. It is safe to add new functions. */
1844 CONSTRUCTION,
1845 /* Callgraph is being streamed-in at LTO time. */
1846 LTO_STREAMING,
1847 /* Callgraph is built and early IPA passes are being run. */
1848 IPA,
1849 /* Callgraph is built and all functions are transformed to SSA form. */
1850 IPA_SSA,
1851 /* All inline decisions are done; it is now possible to remove extern inline
1852 functions and virtual call targets. */
1853 IPA_SSA_AFTER_INLINING,
1854 /* Functions are now ordered and being passed to RTL expanders. */
1855 EXPANSION,
1856 /* All cgraph expansion is done. */
1857 FINISHED
1860 struct asmname_hasher : ggc_ptr_hash <symtab_node>
1862 typedef const_tree compare_type;
1864 static hashval_t hash (symtab_node *n);
1865 static bool equal (symtab_node *n, const_tree t);
1868 class GTY((tag ("SYMTAB"))) symbol_table
1870 public:
1871 friend class symtab_node;
1872 friend class cgraph_node;
1873 friend class cgraph_edge;
1875 symbol_table (): cgraph_max_summary_uid (1)
1879 /* Initialize callgraph dump file. */
1880 void initialize (void);
1882 /* Register a top-level asm statement ASM_STR. */
1883 inline asm_node *finalize_toplevel_asm (tree asm_str);
1885 /* Analyze the whole compilation unit once it is parsed completely. */
1886 void finalize_compilation_unit (void);
1888 /* C++ frontend produce same body aliases all over the place, even before PCH
1889 gets streamed out. It relies on us linking the aliases with their function
1890 in order to do the fixups, but ipa-ref is not PCH safe. Consequentely we
1891 first produce aliases without links, but once C++ FE is sure he won't sream
1892 PCH we build the links via this function. */
1893 void process_same_body_aliases (void);
1895 /* Perform simple optimizations based on callgraph. */
1896 void compile (void);
1898 /* Process CGRAPH_NEW_FUNCTIONS and perform actions necessary to add these
1899 functions into callgraph in a way so they look like ordinary reachable
1900 functions inserted into callgraph already at construction time. */
1901 void process_new_functions (void);
1903 /* Once all functions from compilation unit are in memory, produce all clones
1904 and update all calls. We might also do this on demand if we don't want to
1905 bring all functions to memory prior compilation, but current WHOPR
1906 implementation does that and it is bit easier to keep everything right
1907 in this order. */
1908 void materialize_all_clones (void);
1910 /* Register a symbol NODE. */
1911 inline void register_symbol (symtab_node *node);
1913 inline void
1914 clear_asm_symbols (void)
1916 asmnodes = NULL;
1917 asm_last_node = NULL;
1920 /* Perform reachability analysis and reclaim all unreachable nodes. */
1921 bool remove_unreachable_nodes (FILE *file);
1923 /* Optimization of function bodies might've rendered some variables as
1924 unnecessary so we want to avoid these from being compiled. Re-do
1925 reachability starting from variables that are either externally visible
1926 or was referred from the asm output routines. */
1927 void remove_unreferenced_decls (void);
1929 /* Unregister a symbol NODE. */
1930 inline void unregister (symtab_node *node);
1932 /* Allocate new callgraph node and insert it into basic data structures. */
1933 cgraph_node *create_empty (void);
1935 /* Release a callgraph NODE with UID and put in to the list
1936 of free nodes. */
1937 void release_symbol (cgraph_node *node, int uid);
1939 /* Output all variables enqueued to be assembled. */
1940 bool output_variables (void);
1942 /* Weakrefs may be associated to external decls and thus not output
1943 at expansion time. Emit all necessary aliases. */
1944 void output_weakrefs (void);
1946 /* Return first static symbol with definition. */
1947 inline symtab_node *first_symbol (void);
1949 /* Return first assembler symbol. */
1950 inline asm_node *
1951 first_asm_symbol (void)
1953 return asmnodes;
1956 /* Return first static symbol with definition. */
1957 inline symtab_node *first_defined_symbol (void);
1959 /* Return first variable. */
1960 inline varpool_node *first_variable (void);
1962 /* Return next variable after NODE. */
1963 inline varpool_node *next_variable (varpool_node *node);
1965 /* Return first static variable with initializer. */
1966 inline varpool_node *first_static_initializer (void);
1968 /* Return next static variable with initializer after NODE. */
1969 inline varpool_node *next_static_initializer (varpool_node *node);
1971 /* Return first static variable with definition. */
1972 inline varpool_node *first_defined_variable (void);
1974 /* Return next static variable with definition after NODE. */
1975 inline varpool_node *next_defined_variable (varpool_node *node);
1977 /* Return first function with body defined. */
1978 inline cgraph_node *first_defined_function (void);
1980 /* Return next function with body defined after NODE. */
1981 inline cgraph_node *next_defined_function (cgraph_node *node);
1983 /* Return first function. */
1984 inline cgraph_node *first_function (void);
1986 /* Return next function. */
1987 inline cgraph_node *next_function (cgraph_node *node);
1989 /* Return first function with body defined. */
1990 cgraph_node *first_function_with_gimple_body (void);
1992 /* Return next reachable static variable with initializer after NODE. */
1993 inline cgraph_node *next_function_with_gimple_body (cgraph_node *node);
1995 /* Register HOOK to be called with DATA on each removed edge. */
1996 cgraph_edge_hook_list *add_edge_removal_hook (cgraph_edge_hook hook,
1997 void *data);
1999 /* Remove ENTRY from the list of hooks called on removing edges. */
2000 void remove_edge_removal_hook (cgraph_edge_hook_list *entry);
2002 /* Register HOOK to be called with DATA on each removed node. */
2003 cgraph_node_hook_list *add_cgraph_removal_hook (cgraph_node_hook hook,
2004 void *data);
2006 /* Remove ENTRY from the list of hooks called on removing nodes. */
2007 void remove_cgraph_removal_hook (cgraph_node_hook_list *entry);
2009 /* Register HOOK to be called with DATA on each removed node. */
2010 varpool_node_hook_list *add_varpool_removal_hook (varpool_node_hook hook,
2011 void *data);
2013 /* Remove ENTRY from the list of hooks called on removing nodes. */
2014 void remove_varpool_removal_hook (varpool_node_hook_list *entry);
2016 /* Register HOOK to be called with DATA on each inserted node. */
2017 cgraph_node_hook_list *add_cgraph_insertion_hook (cgraph_node_hook hook,
2018 void *data);
2020 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2021 void remove_cgraph_insertion_hook (cgraph_node_hook_list *entry);
2023 /* Register HOOK to be called with DATA on each inserted node. */
2024 varpool_node_hook_list *add_varpool_insertion_hook (varpool_node_hook hook,
2025 void *data);
2027 /* Remove ENTRY from the list of hooks called on inserted nodes. */
2028 void remove_varpool_insertion_hook (varpool_node_hook_list *entry);
2030 /* Register HOOK to be called with DATA on each duplicated edge. */
2031 cgraph_2edge_hook_list *add_edge_duplication_hook (cgraph_2edge_hook hook,
2032 void *data);
2033 /* Remove ENTRY from the list of hooks called on duplicating edges. */
2034 void remove_edge_duplication_hook (cgraph_2edge_hook_list *entry);
2036 /* Register HOOK to be called with DATA on each duplicated node. */
2037 cgraph_2node_hook_list *add_cgraph_duplication_hook (cgraph_2node_hook hook,
2038 void *data);
2040 /* Remove ENTRY from the list of hooks called on duplicating nodes. */
2041 void remove_cgraph_duplication_hook (cgraph_2node_hook_list *entry);
2043 /* Call all edge removal hooks. */
2044 void call_edge_removal_hooks (cgraph_edge *e);
2046 /* Call all node insertion hooks. */
2047 void call_cgraph_insertion_hooks (cgraph_node *node);
2049 /* Call all node removal hooks. */
2050 void call_cgraph_removal_hooks (cgraph_node *node);
2052 /* Call all node duplication hooks. */
2053 void call_cgraph_duplication_hooks (cgraph_node *node, cgraph_node *node2);
2055 /* Call all edge duplication hooks. */
2056 void call_edge_duplication_hooks (cgraph_edge *cs1, cgraph_edge *cs2);
2058 /* Call all node removal hooks. */
2059 void call_varpool_removal_hooks (varpool_node *node);
2061 /* Call all node insertion hooks. */
2062 void call_varpool_insertion_hooks (varpool_node *node);
2064 /* Arrange node to be first in its entry of assembler_name_hash. */
2065 void symtab_prevail_in_asm_name_hash (symtab_node *node);
2067 /* Initalize asm name hash unless. */
2068 void symtab_initialize_asm_name_hash (void);
2070 /* Set the DECL_ASSEMBLER_NAME and update symtab hashtables. */
2071 void change_decl_assembler_name (tree decl, tree name);
2073 int cgraph_count;
2074 int cgraph_max_uid;
2075 int cgraph_max_summary_uid;
2077 int edges_count;
2078 int edges_max_uid;
2080 symtab_node* GTY(()) nodes;
2081 asm_node* GTY(()) asmnodes;
2082 asm_node* GTY(()) asm_last_node;
2083 cgraph_node* GTY(()) free_nodes;
2085 /* Head of a linked list of unused (freed) call graph edges.
2086 Do not GTY((delete)) this list so UIDs gets reliably recycled. */
2087 cgraph_edge * GTY(()) free_edges;
2089 /* The order index of the next symtab node to be created. This is
2090 used so that we can sort the cgraph nodes in order by when we saw
2091 them, to support -fno-toplevel-reorder. */
2092 int order;
2094 /* Set when whole unit has been analyzed so we can access global info. */
2095 bool global_info_ready;
2096 /* What state callgraph is in right now. */
2097 enum symtab_state state;
2098 /* Set when the cgraph is fully build and the basic flags are computed. */
2099 bool function_flags_ready;
2101 bool cpp_implicit_aliases_done;
2103 /* Hash table used to hold sectoons. */
2104 hash_table<section_name_hasher> *GTY(()) section_hash;
2106 /* Hash table used to convert assembler names into nodes. */
2107 hash_table<asmname_hasher> *assembler_name_hash;
2109 /* Hash table used to hold init priorities. */
2110 hash_map<symtab_node *, symbol_priority_map> *init_priority_hash;
2112 FILE* GTY ((skip)) dump_file;
2114 private:
2115 /* Allocate new callgraph node. */
2116 inline cgraph_node * allocate_cgraph_symbol (void);
2118 /* Allocate a cgraph_edge structure and fill it with data according to the
2119 parameters of which only CALLEE can be NULL (when creating an indirect call
2120 edge). */
2121 cgraph_edge *create_edge (cgraph_node *caller, cgraph_node *callee,
2122 gcall *call_stmt, gcov_type count, int freq,
2123 bool indir_unknown_callee);
2125 /* Put the edge onto the free list. */
2126 void free_edge (cgraph_edge *e);
2128 /* Insert NODE to assembler name hash. */
2129 void insert_to_assembler_name_hash (symtab_node *node, bool with_clones);
2131 /* Remove NODE from assembler name hash. */
2132 void unlink_from_assembler_name_hash (symtab_node *node, bool with_clones);
2134 /* Hash asmnames ignoring the user specified marks. */
2135 static hashval_t decl_assembler_name_hash (const_tree asmname);
2137 /* Compare ASMNAME with the DECL_ASSEMBLER_NAME of DECL. */
2138 static bool decl_assembler_name_equal (tree decl, const_tree asmname);
2140 friend struct asmname_hasher;
2142 /* List of hooks triggered when an edge is removed. */
2143 cgraph_edge_hook_list * GTY((skip)) m_first_edge_removal_hook;
2144 /* List of hooks triggem_red when a cgraph node is removed. */
2145 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_removal_hook;
2146 /* List of hooks triggered when an edge is duplicated. */
2147 cgraph_2edge_hook_list * GTY((skip)) m_first_edge_duplicated_hook;
2148 /* List of hooks triggered when a node is duplicated. */
2149 cgraph_2node_hook_list * GTY((skip)) m_first_cgraph_duplicated_hook;
2150 /* List of hooks triggered when an function is inserted. */
2151 cgraph_node_hook_list * GTY((skip)) m_first_cgraph_insertion_hook;
2152 /* List of hooks triggered when an variable is inserted. */
2153 varpool_node_hook_list * GTY((skip)) m_first_varpool_insertion_hook;
2154 /* List of hooks triggered when a node is removed. */
2155 varpool_node_hook_list * GTY((skip)) m_first_varpool_removal_hook;
2158 extern GTY(()) symbol_table *symtab;
2160 extern vec<cgraph_node *> cgraph_new_nodes;
2162 inline hashval_t
2163 asmname_hasher::hash (symtab_node *n)
2165 return symbol_table::decl_assembler_name_hash
2166 (DECL_ASSEMBLER_NAME (n->decl));
2169 inline bool
2170 asmname_hasher::equal (symtab_node *n, const_tree t)
2172 return symbol_table::decl_assembler_name_equal (n->decl, t);
2175 /* In cgraph.c */
2176 void cgraph_c_finalize (void);
2177 void release_function_body (tree);
2178 cgraph_indirect_call_info *cgraph_allocate_init_indirect_info (void);
2180 void cgraph_update_edges_for_call_stmt (gimple, tree, gimple);
2181 bool cgraph_function_possibly_inlined_p (tree);
2183 const char* cgraph_inline_failed_string (cgraph_inline_failed_t);
2184 cgraph_inline_failed_type_t cgraph_inline_failed_type (cgraph_inline_failed_t);
2186 extern bool gimple_check_call_matching_types (gimple, tree, bool);
2188 /* In cgraphunit.c */
2189 void cgraphunit_c_finalize (void);
2191 /* Initialize datastructures so DECL is a function in lowered gimple form.
2192 IN_SSA is true if the gimple is in SSA. */
2193 basic_block init_lowered_empty_function (tree, bool, gcov_type);
2195 /* In cgraphclones.c */
2197 tree clone_function_name_1 (const char *, const char *);
2198 tree clone_function_name (tree decl, const char *);
2200 void tree_function_versioning (tree, tree, vec<ipa_replace_map *, va_gc> *,
2201 bool, bitmap, bool, bitmap, basic_block);
2203 /* In cgraphbuild.c */
2204 int compute_call_stmt_bb_frequency (tree, basic_block bb);
2205 void record_references_in_initializer (tree, bool);
2207 /* In ipa.c */
2208 void cgraph_build_static_cdtor (char which, tree body, int priority);
2209 bool ipa_discover_readonly_nonaddressable_vars (void);
2211 /* In varpool.c */
2212 tree ctor_for_folding (tree);
2214 /* In tree-chkp.c */
2215 extern bool chkp_function_instrumented_p (tree fndecl);
2217 /* Return true when the symbol is real symbol, i.e. it is not inline clone
2218 or abstract function kept for debug info purposes only. */
2219 inline bool
2220 symtab_node::real_symbol_p (void)
2222 cgraph_node *cnode;
2224 if (DECL_ABSTRACT_P (decl))
2225 return false;
2226 if (!is_a <cgraph_node *> (this))
2227 return true;
2228 cnode = dyn_cast <cgraph_node *> (this);
2229 if (cnode->global.inlined_to)
2230 return false;
2231 return true;
2234 /* Return true if DECL should have entry in symbol table if used.
2235 Those are functions and static & external veriables*/
2237 static inline bool
2238 decl_in_symtab_p (const_tree decl)
2240 return (TREE_CODE (decl) == FUNCTION_DECL
2241 || (TREE_CODE (decl) == VAR_DECL
2242 && (TREE_STATIC (decl) || DECL_EXTERNAL (decl))));
2245 inline bool
2246 symtab_node::in_same_comdat_group_p (symtab_node *target)
2248 symtab_node *source = this;
2250 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2252 if (cn->global.inlined_to)
2253 source = cn->global.inlined_to;
2255 if (cgraph_node *cn = dyn_cast <cgraph_node *> (target))
2257 if (cn->global.inlined_to)
2258 target = cn->global.inlined_to;
2261 return source->get_comdat_group () == target->get_comdat_group ();
2264 /* Return node that alias is aliasing. */
2266 inline symtab_node *
2267 symtab_node::get_alias_target (void)
2269 ipa_ref *ref = NULL;
2270 iterate_reference (0, ref);
2271 if (ref->use == IPA_REF_CHKP)
2272 iterate_reference (1, ref);
2273 gcc_checking_assert (ref->use == IPA_REF_ALIAS);
2274 return ref->referred;
2277 /* Return next reachable static symbol with initializer after the node. */
2279 inline symtab_node *
2280 symtab_node::next_defined_symbol (void)
2282 symtab_node *node1 = next;
2284 for (; node1; node1 = node1->next)
2285 if (node1->definition)
2286 return node1;
2288 return NULL;
2291 /* Iterates I-th reference in the list, REF is also set. */
2293 inline ipa_ref *
2294 symtab_node::iterate_reference (unsigned i, ipa_ref *&ref)
2296 vec_safe_iterate (ref_list.references, i, &ref);
2298 return ref;
2301 /* Iterates I-th referring item in the list, REF is also set. */
2303 inline ipa_ref *
2304 symtab_node::iterate_referring (unsigned i, ipa_ref *&ref)
2306 ref_list.referring.iterate (i, &ref);
2308 return ref;
2311 /* Iterates I-th referring alias item in the list, REF is also set. */
2313 inline ipa_ref *
2314 symtab_node::iterate_direct_aliases (unsigned i, ipa_ref *&ref)
2316 ref_list.referring.iterate (i, &ref);
2318 if (ref && ref->use != IPA_REF_ALIAS)
2319 return NULL;
2321 return ref;
2324 /* Return true if list contains an alias. */
2326 inline bool
2327 symtab_node::has_aliases_p (void)
2329 ipa_ref *ref = NULL;
2331 return (iterate_direct_aliases (0, ref) != NULL);
2334 /* Return true when RESOLUTION indicate that linker will use
2335 the symbol from non-LTO object files. */
2337 inline bool
2338 resolution_used_from_other_file_p (enum ld_plugin_symbol_resolution resolution)
2340 return (resolution == LDPR_PREVAILING_DEF
2341 || resolution == LDPR_PREEMPTED_REG
2342 || resolution == LDPR_RESOLVED_EXEC
2343 || resolution == LDPR_RESOLVED_DYN);
2346 /* Return true when symtab_node is known to be used from other (non-LTO)
2347 object file. Known only when doing LTO via linker plugin. */
2349 inline bool
2350 symtab_node::used_from_object_file_p (void)
2352 if (!TREE_PUBLIC (decl) || DECL_EXTERNAL (decl))
2353 return false;
2354 if (resolution_used_from_other_file_p (resolution))
2355 return true;
2356 return false;
2359 /* Return varpool node for given symbol and check it is a function. */
2361 inline varpool_node *
2362 varpool_node::get (const_tree decl)
2364 gcc_checking_assert (TREE_CODE (decl) == VAR_DECL);
2365 return dyn_cast<varpool_node *> (symtab_node::get (decl));
2368 /* Register a symbol NODE. */
2370 inline void
2371 symbol_table::register_symbol (symtab_node *node)
2373 node->next = nodes;
2374 node->previous = NULL;
2376 if (nodes)
2377 nodes->previous = node;
2378 nodes = node;
2380 node->order = order++;
2383 /* Register a top-level asm statement ASM_STR. */
2385 asm_node *
2386 symbol_table::finalize_toplevel_asm (tree asm_str)
2388 asm_node *node;
2390 node = ggc_cleared_alloc<asm_node> ();
2391 node->asm_str = asm_str;
2392 node->order = order++;
2393 node->next = NULL;
2395 if (asmnodes == NULL)
2396 asmnodes = node;
2397 else
2398 asm_last_node->next = node;
2400 asm_last_node = node;
2401 return node;
2404 /* Unregister a symbol NODE. */
2405 inline void
2406 symbol_table::unregister (symtab_node *node)
2408 if (node->previous)
2409 node->previous->next = node->next;
2410 else
2411 nodes = node->next;
2413 if (node->next)
2414 node->next->previous = node->previous;
2416 node->next = NULL;
2417 node->previous = NULL;
2420 /* Release a callgraph NODE with UID and put in to the list of free nodes. */
2422 inline void
2423 symbol_table::release_symbol (cgraph_node *node, int uid)
2425 cgraph_count--;
2427 /* Clear out the node to NULL all pointers and add the node to the free
2428 list. */
2429 memset (node, 0, sizeof (*node));
2430 node->type = SYMTAB_FUNCTION;
2431 node->uid = uid;
2432 SET_NEXT_FREE_NODE (node, free_nodes);
2433 free_nodes = node;
2436 /* Allocate new callgraph node. */
2438 inline cgraph_node *
2439 symbol_table::allocate_cgraph_symbol (void)
2441 cgraph_node *node;
2443 if (free_nodes)
2445 node = free_nodes;
2446 free_nodes = NEXT_FREE_NODE (node);
2448 else
2450 node = ggc_cleared_alloc<cgraph_node> ();
2451 node->uid = cgraph_max_uid++;
2454 node->summary_uid = cgraph_max_summary_uid++;
2455 return node;
2459 /* Return first static symbol with definition. */
2460 inline symtab_node *
2461 symbol_table::first_symbol (void)
2463 return nodes;
2466 /* Walk all symbols. */
2467 #define FOR_EACH_SYMBOL(node) \
2468 for ((node) = symtab->first_symbol (); (node); (node) = (node)->next)
2470 /* Return first static symbol with definition. */
2471 inline symtab_node *
2472 symbol_table::first_defined_symbol (void)
2474 symtab_node *node;
2476 for (node = nodes; node; node = node->next)
2477 if (node->definition)
2478 return node;
2480 return NULL;
2483 /* Walk all symbols with definitions in current unit. */
2484 #define FOR_EACH_DEFINED_SYMBOL(node) \
2485 for ((node) = symtab->first_defined_symbol (); (node); \
2486 (node) = node->next_defined_symbol ())
2488 /* Return first variable. */
2489 inline varpool_node *
2490 symbol_table::first_variable (void)
2492 symtab_node *node;
2493 for (node = nodes; node; node = node->next)
2494 if (varpool_node *vnode = dyn_cast <varpool_node *> (node))
2495 return vnode;
2496 return NULL;
2499 /* Return next variable after NODE. */
2500 inline varpool_node *
2501 symbol_table::next_variable (varpool_node *node)
2503 symtab_node *node1 = node->next;
2504 for (; node1; node1 = node1->next)
2505 if (varpool_node *vnode1 = dyn_cast <varpool_node *> (node1))
2506 return vnode1;
2507 return NULL;
2509 /* Walk all variables. */
2510 #define FOR_EACH_VARIABLE(node) \
2511 for ((node) = symtab->first_variable (); \
2512 (node); \
2513 (node) = symtab->next_variable ((node)))
2515 /* Return first static variable with initializer. */
2516 inline varpool_node *
2517 symbol_table::first_static_initializer (void)
2519 symtab_node *node;
2520 for (node = nodes; node; node = node->next)
2522 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2523 if (vnode && DECL_INITIAL (node->decl))
2524 return vnode;
2526 return NULL;
2529 /* Return next static variable with initializer after NODE. */
2530 inline varpool_node *
2531 symbol_table::next_static_initializer (varpool_node *node)
2533 symtab_node *node1 = node->next;
2534 for (; node1; node1 = node1->next)
2536 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2537 if (vnode1 && DECL_INITIAL (node1->decl))
2538 return vnode1;
2540 return NULL;
2543 /* Walk all static variables with initializer set. */
2544 #define FOR_EACH_STATIC_INITIALIZER(node) \
2545 for ((node) = symtab->first_static_initializer (); (node); \
2546 (node) = symtab->next_static_initializer (node))
2548 /* Return first static variable with definition. */
2549 inline varpool_node *
2550 symbol_table::first_defined_variable (void)
2552 symtab_node *node;
2553 for (node = nodes; node; node = node->next)
2555 varpool_node *vnode = dyn_cast <varpool_node *> (node);
2556 if (vnode && vnode->definition)
2557 return vnode;
2559 return NULL;
2562 /* Return next static variable with definition after NODE. */
2563 inline varpool_node *
2564 symbol_table::next_defined_variable (varpool_node *node)
2566 symtab_node *node1 = node->next;
2567 for (; node1; node1 = node1->next)
2569 varpool_node *vnode1 = dyn_cast <varpool_node *> (node1);
2570 if (vnode1 && vnode1->definition)
2571 return vnode1;
2573 return NULL;
2575 /* Walk all variables with definitions in current unit. */
2576 #define FOR_EACH_DEFINED_VARIABLE(node) \
2577 for ((node) = symtab->first_defined_variable (); (node); \
2578 (node) = symtab->next_defined_variable (node))
2580 /* Return first function with body defined. */
2581 inline cgraph_node *
2582 symbol_table::first_defined_function (void)
2584 symtab_node *node;
2585 for (node = nodes; node; node = node->next)
2587 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2588 if (cn && cn->definition)
2589 return cn;
2591 return NULL;
2594 /* Return next function with body defined after NODE. */
2595 inline cgraph_node *
2596 symbol_table::next_defined_function (cgraph_node *node)
2598 symtab_node *node1 = node->next;
2599 for (; node1; node1 = node1->next)
2601 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2602 if (cn1 && cn1->definition)
2603 return cn1;
2605 return NULL;
2608 /* Walk all functions with body defined. */
2609 #define FOR_EACH_DEFINED_FUNCTION(node) \
2610 for ((node) = symtab->first_defined_function (); (node); \
2611 (node) = symtab->next_defined_function ((node)))
2613 /* Return first function. */
2614 inline cgraph_node *
2615 symbol_table::first_function (void)
2617 symtab_node *node;
2618 for (node = nodes; node; node = node->next)
2619 if (cgraph_node *cn = dyn_cast <cgraph_node *> (node))
2620 return cn;
2621 return NULL;
2624 /* Return next function. */
2625 inline cgraph_node *
2626 symbol_table::next_function (cgraph_node *node)
2628 symtab_node *node1 = node->next;
2629 for (; node1; node1 = node1->next)
2630 if (cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1))
2631 return cn1;
2632 return NULL;
2635 /* Return first function with body defined. */
2636 inline cgraph_node *
2637 symbol_table::first_function_with_gimple_body (void)
2639 symtab_node *node;
2640 for (node = nodes; node; node = node->next)
2642 cgraph_node *cn = dyn_cast <cgraph_node *> (node);
2643 if (cn && cn->has_gimple_body_p ())
2644 return cn;
2646 return NULL;
2649 /* Return next reachable static variable with initializer after NODE. */
2650 inline cgraph_node *
2651 symbol_table::next_function_with_gimple_body (cgraph_node *node)
2653 symtab_node *node1 = node->next;
2654 for (; node1; node1 = node1->next)
2656 cgraph_node *cn1 = dyn_cast <cgraph_node *> (node1);
2657 if (cn1 && cn1->has_gimple_body_p ())
2658 return cn1;
2660 return NULL;
2663 /* Walk all functions. */
2664 #define FOR_EACH_FUNCTION(node) \
2665 for ((node) = symtab->first_function (); (node); \
2666 (node) = symtab->next_function ((node)))
2668 /* Return true when callgraph node is a function with Gimple body defined
2669 in current unit. Functions can also be define externally or they
2670 can be thunks with no Gimple representation.
2672 Note that at WPA stage, the function body may not be present in memory. */
2674 inline bool
2675 cgraph_node::has_gimple_body_p (void)
2677 return definition && !thunk.thunk_p && !alias;
2680 /* Walk all functions with body defined. */
2681 #define FOR_EACH_FUNCTION_WITH_GIMPLE_BODY(node) \
2682 for ((node) = symtab->first_function_with_gimple_body (); (node); \
2683 (node) = symtab->next_function_with_gimple_body (node))
2685 /* Uniquize all constants that appear in memory.
2686 Each constant in memory thus far output is recorded
2687 in `const_desc_table'. */
2689 struct GTY((for_user)) constant_descriptor_tree {
2690 /* A MEM for the constant. */
2691 rtx rtl;
2693 /* The value of the constant. */
2694 tree value;
2696 /* Hash of value. Computing the hash from value each time
2697 hashfn is called can't work properly, as that means recursive
2698 use of the hash table during hash table expansion. */
2699 hashval_t hash;
2702 /* Return true when function is only called directly or it has alias.
2703 i.e. it is not externally visible, address was not taken and
2704 it is not used in any other non-standard way. */
2706 inline bool
2707 cgraph_node::only_called_directly_or_aliased_p (void)
2709 gcc_assert (!global.inlined_to);
2710 return (!force_output && !address_taken
2711 && !used_from_other_partition
2712 && !DECL_VIRTUAL_P (decl)
2713 && !DECL_STATIC_CONSTRUCTOR (decl)
2714 && !DECL_STATIC_DESTRUCTOR (decl)
2715 && !used_from_object_file_p ()
2716 && !externally_visible);
2719 /* Return true when function can be removed from callgraph
2720 if all direct calls are eliminated. */
2722 inline bool
2723 cgraph_node::can_remove_if_no_direct_calls_and_refs_p (void)
2725 gcc_checking_assert (!global.inlined_to);
2726 /* Instrumentation clones should not be removed before
2727 instrumentation happens. New callers may appear after
2728 instrumentation. */
2729 if (instrumentation_clone
2730 && !chkp_function_instrumented_p (decl))
2731 return false;
2732 /* Extern inlines can always go, we will use the external definition. */
2733 if (DECL_EXTERNAL (decl))
2734 return true;
2735 /* When function is needed, we can not remove it. */
2736 if (force_output || used_from_other_partition)
2737 return false;
2738 if (DECL_STATIC_CONSTRUCTOR (decl)
2739 || DECL_STATIC_DESTRUCTOR (decl))
2740 return false;
2741 /* Only COMDAT functions can be removed if externally visible. */
2742 if (externally_visible
2743 && (!DECL_COMDAT (decl)
2744 || forced_by_abi
2745 || used_from_object_file_p ()))
2746 return false;
2747 return true;
2750 /* Return true when variable can be removed from variable pool
2751 if all direct calls are eliminated. */
2753 inline bool
2754 varpool_node::can_remove_if_no_refs_p (void)
2756 if (DECL_EXTERNAL (decl))
2757 return true;
2758 return (!force_output && !used_from_other_partition
2759 && ((DECL_COMDAT (decl)
2760 && !forced_by_abi
2761 && !used_from_object_file_p ())
2762 || !externally_visible
2763 || DECL_HAS_VALUE_EXPR_P (decl)));
2766 /* Return true when all references to variable must be visible in ipa_ref_list.
2767 i.e. if the variable is not externally visible or not used in some magic
2768 way (asm statement or such).
2769 The magic uses are all summarized in force_output flag. */
2771 inline bool
2772 varpool_node::all_refs_explicit_p ()
2774 return (definition
2775 && !externally_visible
2776 && !used_from_other_partition
2777 && !force_output);
2780 struct tree_descriptor_hasher : ggc_ptr_hash<constant_descriptor_tree>
2782 static hashval_t hash (constant_descriptor_tree *);
2783 static bool equal (constant_descriptor_tree *, constant_descriptor_tree *);
2786 /* Constant pool accessor function. */
2787 hash_table<tree_descriptor_hasher> *constant_pool_htab (void);
2789 /* Return node that alias is aliasing. */
2791 inline cgraph_node *
2792 cgraph_node::get_alias_target (void)
2794 return dyn_cast <cgraph_node *> (symtab_node::get_alias_target ());
2797 /* Return node that alias is aliasing. */
2799 inline varpool_node *
2800 varpool_node::get_alias_target (void)
2802 return dyn_cast <varpool_node *> (symtab_node::get_alias_target ());
2805 /* Walk the alias chain to return the symbol NODE is alias of.
2806 If NODE is not an alias, return NODE.
2807 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2809 inline symtab_node *
2810 symtab_node::ultimate_alias_target (enum availability *availability)
2812 if (!alias)
2814 if (availability)
2815 *availability = get_availability ();
2816 return this;
2819 return ultimate_alias_target_1 (availability);
2822 /* Given function symbol, walk the alias chain to return the function node
2823 is alias of. Do not walk through thunks.
2824 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2826 inline cgraph_node *
2827 cgraph_node::ultimate_alias_target (enum availability *availability)
2829 cgraph_node *n = dyn_cast <cgraph_node *>
2830 (symtab_node::ultimate_alias_target (availability));
2831 if (!n && availability)
2832 *availability = AVAIL_NOT_AVAILABLE;
2833 return n;
2836 /* For given variable pool node, walk the alias chain to return the function
2837 the variable is alias of. Do not walk through thunks.
2838 When AVAILABILITY is non-NULL, get minimal availability in the chain. */
2840 inline varpool_node *
2841 varpool_node::ultimate_alias_target (availability *availability)
2843 varpool_node *n = dyn_cast <varpool_node *>
2844 (symtab_node::ultimate_alias_target (availability));
2846 if (!n && availability)
2847 *availability = AVAIL_NOT_AVAILABLE;
2848 return n;
2851 /* Set callee N of call graph edge and add it to the corresponding set of
2852 callers. */
2854 inline void
2855 cgraph_edge::set_callee (cgraph_node *n)
2857 prev_caller = NULL;
2858 if (n->callers)
2859 n->callers->prev_caller = this;
2860 next_caller = n->callers;
2861 n->callers = this;
2862 callee = n;
2865 /* Redirect callee of the edge to N. The function does not update underlying
2866 call expression. */
2868 inline void
2869 cgraph_edge::redirect_callee (cgraph_node *n)
2871 /* Remove from callers list of the current callee. */
2872 remove_callee ();
2874 /* Insert to callers list of the new callee. */
2875 set_callee (n);
2878 /* Return true when the edge represents a direct recursion. */
2880 inline bool
2881 cgraph_edge::recursive_p (void)
2883 cgraph_node *c = callee->ultimate_alias_target ();
2884 if (caller->global.inlined_to)
2885 return caller->global.inlined_to->decl == c->decl;
2886 else
2887 return caller->decl == c->decl;
2890 /* Remove the edge from the list of the callers of the callee. */
2892 inline void
2893 cgraph_edge::remove_callee (void)
2895 gcc_assert (!indirect_unknown_callee);
2896 if (prev_caller)
2897 prev_caller->next_caller = next_caller;
2898 if (next_caller)
2899 next_caller->prev_caller = prev_caller;
2900 if (!prev_caller)
2901 callee->callers = next_caller;
2904 /* Return true if the TM_CLONE bit is set for a given FNDECL. */
2905 static inline bool
2906 decl_is_tm_clone (const_tree fndecl)
2908 cgraph_node *n = cgraph_node::get (fndecl);
2909 if (n)
2910 return n->tm_clone;
2911 return false;
2914 /* Likewise indicate that a node is needed, i.e. reachable via some
2915 external means. */
2917 inline void
2918 cgraph_node::mark_force_output (void)
2920 force_output = 1;
2921 gcc_checking_assert (!global.inlined_to);
2924 /* Return true if function should be optimized for size. */
2926 inline bool
2927 cgraph_node::optimize_for_size_p (void)
2929 if (opt_for_fn (decl, optimize_size))
2930 return true;
2931 if (frequency == NODE_FREQUENCY_UNLIKELY_EXECUTED)
2932 return true;
2933 else
2934 return false;
2937 /* Return symtab_node for NODE or create one if it is not present
2938 in symtab. */
2940 inline symtab_node *
2941 symtab_node::get_create (tree node)
2943 if (TREE_CODE (node) == VAR_DECL)
2944 return varpool_node::get_create (node);
2945 else
2946 return cgraph_node::get_create (node);
2949 /* Return availability of NODE. */
2951 inline enum availability
2952 symtab_node::get_availability (void)
2954 if (is_a <cgraph_node *> (this))
2955 return dyn_cast <cgraph_node *> (this)->get_availability ();
2956 else
2957 return dyn_cast <varpool_node *> (this)->get_availability ();
2960 /* Call calback on symtab node and aliases associated to this node.
2961 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
2962 skipped. */
2964 inline bool
2965 symtab_node::call_for_symbol_and_aliases (bool (*callback) (symtab_node *,
2966 void *),
2967 void *data,
2968 bool include_overwritable)
2970 if (callback (this, data))
2971 return true;
2972 if (has_aliases_p ())
2973 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
2974 return false;
2977 /* Call callback on function and aliases associated to the function.
2978 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
2979 skipped. */
2981 inline bool
2982 cgraph_node::call_for_symbol_and_aliases (bool (*callback) (cgraph_node *,
2983 void *),
2984 void *data,
2985 bool include_overwritable)
2987 if (callback (this, data))
2988 return true;
2989 if (has_aliases_p ())
2990 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
2991 return false;
2994 /* Call calback on varpool symbol and aliases associated to varpool symbol.
2995 When INCLUDE_OVERWRITABLE is false, overwritable aliases and thunks are
2996 skipped. */
2998 inline bool
2999 varpool_node::call_for_symbol_and_aliases (bool (*callback) (varpool_node *,
3000 void *),
3001 void *data,
3002 bool include_overwritable)
3004 if (callback (this, data))
3005 return true;
3006 if (has_aliases_p ())
3007 return call_for_symbol_and_aliases_1 (callback, data, include_overwritable);
3008 return false;
3011 /* Return true if refernece may be used in address compare. */
3013 inline bool
3014 ipa_ref::address_matters_p ()
3016 if (use != IPA_REF_ADDR)
3017 return false;
3018 /* Addresses taken from virtual tables are never compared. */
3019 if (is_a <varpool_node *> (referring)
3020 && DECL_VIRTUAL_P (referring->decl))
3021 return false;
3022 return referred->address_can_be_compared_p ();
3025 /* Build polymorphic call context for indirect call E. */
3027 inline
3028 ipa_polymorphic_call_context::ipa_polymorphic_call_context (cgraph_edge *e)
3030 gcc_checking_assert (e->indirect_info->polymorphic);
3031 *this = e->indirect_info->context;
3034 /* Build empty "I know nothing" context. */
3036 inline
3037 ipa_polymorphic_call_context::ipa_polymorphic_call_context ()
3039 clear_speculation ();
3040 clear_outer_type ();
3041 invalid = false;
3044 /* Make context non-speculative. */
3046 inline void
3047 ipa_polymorphic_call_context::clear_speculation ()
3049 speculative_outer_type = NULL;
3050 speculative_offset = 0;
3051 speculative_maybe_derived_type = false;
3054 /* Produce context specifying all derrived types of OTR_TYPE. If OTR_TYPE is
3055 NULL, the context is set to dummy "I know nothing" setting. */
3057 inline void
3058 ipa_polymorphic_call_context::clear_outer_type (tree otr_type)
3060 outer_type = otr_type ? TYPE_MAIN_VARIANT (otr_type) : NULL;
3061 offset = 0;
3062 maybe_derived_type = true;
3063 maybe_in_construction = true;
3064 dynamic = true;
3067 /* Adjust all offsets in contexts by OFF bits. */
3069 inline void
3070 ipa_polymorphic_call_context::offset_by (HOST_WIDE_INT off)
3072 if (outer_type)
3073 offset += off;
3074 if (speculative_outer_type)
3075 speculative_offset += off;
3078 /* Return TRUE if context is fully useless. */
3080 inline bool
3081 ipa_polymorphic_call_context::useless_p () const
3083 return (!outer_type && !speculative_outer_type);
3086 /* Return true if NODE is local. Instrumentation clones are counted as local
3087 only when original function is local. */
3089 static inline bool
3090 cgraph_local_p (cgraph_node *node)
3092 if (!node->instrumentation_clone || !node->instrumented_version)
3093 return node->local.local;
3095 return node->local.local && node->instrumented_version->local.local;
3098 /* When using fprintf (or similar), problems can arise with
3099 transient generated strings. Many string-generation APIs
3100 only support one result being alive at once (e.g. by
3101 returning a pointer to a statically-allocated buffer).
3103 If there is more than one generated string within one
3104 fprintf call: the first string gets evicted or overwritten
3105 by the second, before fprintf is fully evaluated.
3106 See e.g. PR/53136.
3108 This function provides a workaround for this, by providing
3109 a simple way to create copies of these transient strings,
3110 without the need to have explicit cleanup:
3112 fprintf (dumpfile, "string 1: %s string 2:%s\n",
3113 xstrdup_for_dump (EXPR_1),
3114 xstrdup_for_dump (EXPR_2));
3116 This is actually a simple wrapper around ggc_strdup, but
3117 the name documents the intent. We require that no GC can occur
3118 within the fprintf call. */
3120 static inline const char *
3121 xstrdup_for_dump (const char *transient_str)
3123 return ggc_strdup (transient_str);
3126 #endif /* GCC_CGRAPH_H */